interface StackedRouteMatchInterface in Drupal 9

Defines an interface for a stack of route matches.

This could be for example used on exception pages.

Hierarchy

• interface \Drupal\Core\Routing\RouteMatchInterface
  • interface \Drupal\Core\Routing\StackedRouteMatchInterface

3 files declare their use of StackedRouteMatchInterface

LanguageNegotiationUserAdmin.php in core/modules/user/src/Plugin/LanguageNegotiation/LanguageNegotiationUserAdmin.php

system.module in core/modules/system/system.module

Configuration system that lets administrators modify the workings of the site.

ThemeManager.php in core/lib/Drupal/Core/Theme/ThemeManager.php

File

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

Namespace

Drupal\Core\Routing

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

Name	Modifiers	Type	Description	Overrides
RouteMatchInterface::getParameter	public	function	Returns the processed value of a named route parameter.	3
RouteMatchInterface::getParameters	public	function	Returns the bag of all processed route parameters.	3
RouteMatchInterface::getRawParameter	public	function	Returns the raw value of a named route parameter.	3
RouteMatchInterface::getRawParameters	public	function	Returns the bag of all raw route parameters.	3
RouteMatchInterface::getRouteName	public	function	Returns the route name.	3
RouteMatchInterface::getRouteObject	public	function	Returns the route object.	3
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