Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php \Drupal\Core\Routing\StackedRouteMatchInterface
  2. 9 core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php \Drupal\Core\Routing\StackedRouteMatchInterface

Defines an interface for a stack of route matches.

This could be for example used on exception pages.

Hierarchy

Expanded class hierarchy of StackedRouteMatchInterface

All classes that implement StackedRouteMatchInterface

1 file declares its use of StackedRouteMatchInterface
ThemeManager.php in core/lib/Drupal/Core/Theme/ThemeManager.php

File

core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php, line 12

Namespace

Drupal\Core\Routing
View source 
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);

}

Members

Namesort descending Modifiers Type Description Overrides
StackedRouteMatchInterface::getCurrentRouteMatch public function Gets the current route match. 1
StackedRouteMatchInterface::getMasterRouteMatch public function Gets the master route match.. 1
StackedRouteMatchInterface::getParentRouteMatch public function Returns the parent route match of the current. 1
StackedRouteMatchInterface::getRouteMatchFromRequest public function Returns a route match from a given request, if possible. 1