Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Controller;
Chris@0: 
Chris@0: use Symfony\Component\Routing\Route;
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a class which knows how to generate the title from a given route.
Chris@0:  */
Chris@0: interface TitleResolverInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a static or dynamic title for the route.
Chris@0:    *
Chris@0:    * If the returned title can contain HTML that should not be escaped it should
Chris@0:    * return a render array, for example:
Chris@0:    * @code
Chris@0:    * ['#markup' => 'title', '#allowed_tags' => ['em']]
Chris@0:    * @endcode
Chris@0:    * If the method returns a string and it is not marked safe then it will be
Chris@0:    * auto-escaped.
Chris@0:    *
Chris@0:    * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0:    *   The request object passed to the title callback.
Chris@0:    * @param \Symfony\Component\Routing\Route $route
Chris@0:    *   The route information of the route to fetch the title.
Chris@0:    *
Chris@0:    * @return array|string|null
Chris@0:    *   The title for the route.
Chris@0:    */
Chris@0:   public function getTitle(Request $request, Route $route);
Chris@0: 
Chris@0: }