Mercurial > hg > isophonics-drupal-site
annotate core/lib/Drupal/Core/Controller/TitleResolverInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\Core\Controller; |
Chris@0 | 4 |
Chris@0 | 5 use Symfony\Component\Routing\Route; |
Chris@0 | 6 use Symfony\Component\HttpFoundation\Request; |
Chris@0 | 7 |
Chris@0 | 8 /** |
Chris@0 | 9 * Defines a class which knows how to generate the title from a given route. |
Chris@0 | 10 */ |
Chris@0 | 11 interface TitleResolverInterface { |
Chris@0 | 12 |
Chris@0 | 13 /** |
Chris@0 | 14 * Returns a static or dynamic title for the route. |
Chris@0 | 15 * |
Chris@0 | 16 * If the returned title can contain HTML that should not be escaped it should |
Chris@0 | 17 * return a render array, for example: |
Chris@0 | 18 * @code |
Chris@0 | 19 * ['#markup' => 'title', '#allowed_tags' => ['em']] |
Chris@0 | 20 * @endcode |
Chris@0 | 21 * If the method returns a string and it is not marked safe then it will be |
Chris@0 | 22 * auto-escaped. |
Chris@0 | 23 * |
Chris@0 | 24 * @param \Symfony\Component\HttpFoundation\Request $request |
Chris@0 | 25 * The request object passed to the title callback. |
Chris@0 | 26 * @param \Symfony\Component\Routing\Route $route |
Chris@0 | 27 * The route information of the route to fetch the title. |
Chris@0 | 28 * |
Chris@0 | 29 * @return array|string|null |
Chris@0 | 30 * The title for the route. |
Chris@0 | 31 */ |
Chris@0 | 32 public function getTitle(Request $request, Route $route); |
Chris@0 | 33 |
Chris@0 | 34 } |