Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children | 129ea1e6d783 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,47 @@ +<?php + +namespace Drupal\Core\Routing; + +use Symfony\Component\HttpFoundation\Request; + +/** + * Defines an interface for a stack of route matches. + * + * This could be for example used on exception pages. + */ +interface StackedRouteMatchInterface extends RouteMatchInterface { + + /** + * Gets the current route match. + * + * @return \Drupal\Core\Routing\RouteMatchInterface + */ + public function getCurrentRouteMatch(); + + /** + * Gets the master route match.. + * + * @return \Drupal\Core\Routing\RouteMatchInterface + */ + public function getMasterRouteMatch(); + + /** + * Returns the parent route match of the current. + * + * @return \Drupal\Core\Routing\RouteMatchInterface|null + * The parent route match or NULL, if it the master route match. + */ + public function getParentRouteMatch(); + + /** + * Returns a route match from a given request, if possible. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request. + * + * @return \Drupal\Core\Routing\RouteMatchInterface|null + * THe matching route match, or NULL if there is no matching one. + */ + public function getRouteMatchFromRequest(Request $request); + +}