class NullRouteMatch implements RouteMatchInterface (View source)

Stub implementation of RouteMatchInterface for when there's no matched route.

Methods

string|null
getRouteName()

Returns the route name.

Route|null
getRouteObject()

Returns the route object.

mixed|null
getParameter(string $parameter_name)

Returns the processed value of a named route parameter.

ParameterBag
getParameters()

Returns the bag of all processed route parameters.

string|null
getRawParameter(string $parameter_name)

Returns the raw value of a named route parameter.

ParameterBag
getRawParameters()

Returns the bag of all raw route parameters.

Details

string|null getRouteName()

Returns the route name.

Return Value

string|null

The route name. NULL if no route is matched.

Route|null getRouteObject()

Returns the route object.

Return Value

Route|null

The route object. NULL if no route is matched.

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.

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.

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.

ParameterBag getRawParameters()

Returns the bag of all raw route parameters.

Return Value

ParameterBag

The parameter bag.