CurrentRouteMatch
class CurrentRouteMatch implements ResettableStackedRouteMatchInterface (View source)
Default object for current_route_match service.
Properties
| protected RequestStack | $requestStack | The related request stack. |
|
| protected SplObjectStorage | $routeMatches | Internal cache of RouteMatch objects. |
Methods
Constructs a CurrentRouteMatch object.
Returns the route name.
Returns the route object.
Returns the processed value of a named route parameter.
Returns the bag of all processed route parameters.
Returns the raw value of a named route parameter.
Returns the bag of all raw route parameters.
Returns the route match for the current request.
Returns the route match for a passed in request.
Resets the route match static cache.
Gets the master route match.
Returns the parent route match of the current.
Returns a route match from a given request, if possible.
Details
__construct(RequestStack $request_stack)
Constructs a CurrentRouteMatch object.
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.
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.
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.
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.
RouteMatchInterface
getCurrentRouteMatch()
Returns the route match for the current request.
protected RouteMatchInterface
getRouteMatch(Request $request)
Returns the route match for a passed in request.
resetRouteMatch()
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.
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.