1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. StackedRouteMatchInterface

StackedRouteMatchInterface

interface StackedRouteMatchInterface implements RouteMatchInterface (View source)

Defines an interface for a stack of route matches.

This could be for example used on exception pages.

Methods

string|null
getRouteName()

Returns the route name.

from  RouteMatchInterface
Route|null
getRouteObject()

Returns the route object.

from  RouteMatchInterface
mixed|null
getParameter(string $parameter_name)

Returns the processed value of a named route parameter.

from  RouteMatchInterface
ParameterBag
getParameters()

Returns the bag of all processed route parameters.

from  RouteMatchInterface
string|null
getRawParameter(string $parameter_name)

Returns the raw value of a named route parameter.

from  RouteMatchInterface
ParameterBag
getRawParameters()

Returns the bag of all raw route parameters.

from  RouteMatchInterface
RouteMatchInterface
getCurrentRouteMatch()

Gets the current route match.

RouteMatchInterface
getMasterRouteMatch()

Gets the master route match.

RouteMatchInterface|null
getParentRouteMatch()

Returns the parent route match of the current.

RouteMatchInterface|null
getRouteMatchFromRequest(Request $request)

Returns a route match from a given request, if possible.

Details

in RouteMatchInterface at line 28
string|null getRouteName()

Returns the route name.

Return Value

string|null

The route name. NULL if no route is matched.

in RouteMatchInterface at line 36
Route|null getRouteObject()

Returns the route object.

Return Value

Route|null

The route object. NULL if no route is matched.

in RouteMatchInterface at line 56
mixed|null getParameter(string $parameter_name)

Returns the processed value of a named route parameter.

Raw URL parameters are processed by the parameter conversion system, which does operations such as converting entity ID parameters to fully-loaded entities. For example, the path node/12345 would have a raw node ID parameter value of 12345, while the processed parameter value would be the corresponding loaded node object.

Parameters

string $parameter_name

The parameter name.

Return Value

mixed|null

The parameter value. NULL if the route doesn't define the parameter or if the parameter value can't be determined from the request.

See also

RouteMatchInterface::getRawParameter

in RouteMatchInterface at line 72
ParameterBag getParameters()

Returns the bag of all processed route parameters.

Raw URL parameters are processed by the parameter conversion system, which does operations such as converting entity ID parameters to fully-loaded entities. For example, the path node/12345 would have a raw node ID parameter value of 12345, while the processed parameter value would be the corresponding loaded node object.

Return Value

ParameterBag

The parameter bag.

See also

RouteMatchInterface::getRawParameters

in RouteMatchInterface at line 87
string|null getRawParameter(string $parameter_name)

Returns the raw value of a named route parameter.

Parameters

string $parameter_name

The parameter name.

Return Value

string|null

The raw (non-upcast) parameter value. NULL if the route doesn't define the parameter or if the raw parameter value can't be determined from the request.

See also

RouteMatchInterface::getParameter

in RouteMatchInterface at line 97
ParameterBag getRawParameters()

Returns the bag of all raw route parameters.

Return Value

ParameterBag

The parameter bag.

See also

RouteMatchInterface::getParameters

at line 19
RouteMatchInterface getCurrentRouteMatch()

Gets the current route match.

Return Value

RouteMatchInterface

at line 26
RouteMatchInterface getMasterRouteMatch()

Gets the master route match.

.

Return Value

RouteMatchInterface

at line 34
RouteMatchInterface|null getParentRouteMatch()

Returns the parent route match of the current.

Return Value

RouteMatchInterface|null

The parent route match or NULL, if it the master route match.

at line 45
RouteMatchInterface|null getRouteMatchFromRequest(Request $request)

Returns a route match from a given request, if possible.

Parameters

Request $request

The request.

Return Value

RouteMatchInterface|null

The matching route match, or NULL if there is no matching one.