Mercurial > hg > isophonics-drupal-site
annotate core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 129ea1e6d783 |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\Core\Routing; |
Chris@0 | 4 |
Chris@0 | 5 use Symfony\Component\HttpFoundation\Request; |
Chris@0 | 6 |
Chris@0 | 7 /** |
Chris@0 | 8 * Defines an interface for a stack of route matches. |
Chris@0 | 9 * |
Chris@0 | 10 * This could be for example used on exception pages. |
Chris@0 | 11 */ |
Chris@0 | 12 interface StackedRouteMatchInterface extends RouteMatchInterface { |
Chris@0 | 13 |
Chris@0 | 14 /** |
Chris@0 | 15 * Gets the current route match. |
Chris@0 | 16 * |
Chris@0 | 17 * @return \Drupal\Core\Routing\RouteMatchInterface |
Chris@0 | 18 */ |
Chris@0 | 19 public function getCurrentRouteMatch(); |
Chris@0 | 20 |
Chris@0 | 21 /** |
Chris@0 | 22 * Gets the master route match.. |
Chris@0 | 23 * |
Chris@0 | 24 * @return \Drupal\Core\Routing\RouteMatchInterface |
Chris@0 | 25 */ |
Chris@0 | 26 public function getMasterRouteMatch(); |
Chris@0 | 27 |
Chris@0 | 28 /** |
Chris@0 | 29 * Returns the parent route match of the current. |
Chris@0 | 30 * |
Chris@0 | 31 * @return \Drupal\Core\Routing\RouteMatchInterface|null |
Chris@0 | 32 * The parent route match or NULL, if it the master route match. |
Chris@0 | 33 */ |
Chris@0 | 34 public function getParentRouteMatch(); |
Chris@0 | 35 |
Chris@0 | 36 /** |
Chris@0 | 37 * Returns a route match from a given request, if possible. |
Chris@0 | 38 * |
Chris@0 | 39 * @param \Symfony\Component\HttpFoundation\Request $request |
Chris@0 | 40 * The request. |
Chris@0 | 41 * |
Chris@0 | 42 * @return \Drupal\Core\Routing\RouteMatchInterface|null |
Chris@17 | 43 * The matching route match, or NULL if there is no matching one. |
Chris@0 | 44 */ |
Chris@0 | 45 public function getRouteMatchFromRequest(Request $request); |
Chris@0 | 46 |
Chris@0 | 47 } |