interface ResettableStackedRouteMatchInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/ResettableStackedRouteMatchInterface.php \Drupal\Core\Routing\ResettableStackedRouteMatchInterface
  2. 10 core/lib/Drupal/Core/Routing/ResettableStackedRouteMatchInterface.php \Drupal\Core\Routing\ResettableStackedRouteMatchInterface
  3. 11.x core/lib/Drupal/Core/Routing/ResettableStackedRouteMatchInterface.php \Drupal\Core\Routing\ResettableStackedRouteMatchInterface

Defines an interface for a resettable stack of route matches.

@todo Move this method to \Drupal\Core\Routing\StackedRouteMatchInterface in https://www.drupal.org/node/2659952.

Hierarchy

Expanded class hierarchy of ResettableStackedRouteMatchInterface

All classes that implement ResettableStackedRouteMatchInterface

File

core/lib/Drupal/Core/Routing/ResettableStackedRouteMatchInterface.php, line 11

Namespace

Drupal\Core\Routing
View source 
interface ResettableStackedRouteMatchInterface extends StackedRouteMatchInterface {
    
    /**
     * Resets the route match static cache.
     *
     * The route match should only be statically cached once routing is finished.
     * Any code that uses a route match during routing may be incorrectly assumed
     * to be acting after routing has completed. This method gives that code the
     * ability to fix the static cache.
     */
    public function resetRouteMatch();

}

Members

Title Modifiers Object type Summary Overrides
ResettableStackedRouteMatchInterface::resetRouteMatch public function Resets the route match static cache. 1
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.