class RouteMatch
Same name in other branches
- 9 core/lib/Drupal/Core/Routing/RouteMatch.php \Drupal\Core\Routing\RouteMatch
- 8.9.x core/lib/Drupal/Core/Routing/RouteMatch.php \Drupal\Core\Routing\RouteMatch
- 10 core/lib/Drupal/Core/Routing/RouteMatch.php \Drupal\Core\Routing\RouteMatch
Default object representing the results of routing.
Hierarchy
- class \Drupal\Core\Routing\RouteMatch implements \Drupal\Core\Routing\RouteMatchInterface
Expanded class hierarchy of RouteMatch
29 files declare their use of RouteMatch
- AccessDeniedSubscriber.php in core/
modules/ user/ src/ EventSubscriber/ AccessDeniedSubscriber.php - AccessManager.php in core/
lib/ Drupal/ Core/ Access/ AccessManager.php - AccessManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Access/ AccessManagerTest.php - AdminNegotiatorTest.php in core/
modules/ user/ tests/ src/ Unit/ Theme/ AdminNegotiatorTest.php - AjaxBasePageNegotiatorTest.php in core/
tests/ Drupal/ Tests/ Core/ Theme/ AjaxBasePageNegotiatorTest.php
File
-
core/
lib/ Drupal/ Core/ Routing/ RouteMatch.php, line 13
Namespace
Drupal\Core\RoutingView source
class RouteMatch implements RouteMatchInterface {
/**
* The route name.
*
* @var string
*/
protected $routeName;
/**
* The route.
*
* @var \Symfony\Component\Routing\Route
*/
protected $route;
/**
* A key|value store of parameters.
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*/
protected $parameters;
/**
* A key|value store of raw parameters.
*
* @var \Symfony\Component\HttpFoundation\InputBag
*/
protected $rawParameters;
/**
* Constructs a RouteMatch object.
*
* @param string $route_name
* The name of the route.
* @param \Symfony\Component\Routing\Route $route
* The route.
* @param array $parameters
* The parameters array.
* @param array $raw_parameters
* The raw $parameters array.
*/
public function __construct($route_name, Route $route, array $parameters = [], array $raw_parameters = []) {
$this->routeName = $route_name;
$this->route = $route;
// Pre-filter parameters.
$route_params = $this->getParameterNames();
$parameters = array_intersect_key($parameters, $route_params);
$raw_parameters = array_intersect_key($raw_parameters, $route_params);
$this->parameters = new ParameterBag($parameters);
$this->rawParameters = new InputBag($raw_parameters);
}
/**
* Creates a RouteMatch from a request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* A request object.
*
* @return \Drupal\Core\Routing\RouteMatchInterface
* A new RouteMatch object if there's a matched route for the request.
* A new NullRouteMatch object otherwise (e.g., on a 404 page or when
* invoked prior to routing).
*/
public static function createFromRequest(Request $request) {
if ($request->attributes
->get(RouteObjectInterface::ROUTE_OBJECT)) {
$raw_variables = [];
if ($raw = $request->attributes
->get('_raw_variables')) {
$raw_variables = $raw->all();
}
return new static($request->attributes
->get(RouteObjectInterface::ROUTE_NAME), $request->attributes
->get(RouteObjectInterface::ROUTE_OBJECT), $request->attributes
->all(), $raw_variables);
}
else {
return new NullRouteMatch();
}
}
/**
* {@inheritdoc}
*/
public function getRouteName() {
return $this->routeName;
}
/**
* {@inheritdoc}
*/
public function getRouteObject() {
return $this->route;
}
/**
* {@inheritdoc}
*/
public function getParameter($parameter_name) {
return $this->parameters
->get($parameter_name);
}
/**
* {@inheritdoc}
*/
public function getParameters() {
return $this->parameters;
}
/**
* {@inheritdoc}
*/
public function getRawParameter($parameter_name) {
return $this->rawParameters
->get($parameter_name);
}
/**
* {@inheritdoc}
*/
public function getRawParameters() {
return $this->rawParameters;
}
/**
* Returns the names of all parameters for the currently matched route.
*
* @return array
* Route parameter names as both the keys and values.
*/
protected function getParameterNames() {
$names = [];
if ($route = $this->getRouteObject()) {
// Variables defined in path and host patterns are route parameters.
$variables = $route->compile()
->getVariables();
$names = array_combine($variables, $variables);
// Route defaults that do not start with a leading "_" are also
// parameters, even if they are not included in path or host patterns.
foreach ($route->getDefaults() as $name => $value) {
if (!isset($names[$name]) && !str_starts_with($name, '_')) {
$names[$name] = $name;
}
}
}
return $names;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
RouteMatch::$parameters | protected | property | A key|value store of parameters. | |
RouteMatch::$rawParameters | protected | property | A key|value store of raw parameters. | |
RouteMatch::$route | protected | property | The route. | |
RouteMatch::$routeName | protected | property | The route name. | |
RouteMatch::createFromRequest | public static | function | Creates a RouteMatch from a request. | |
RouteMatch::getParameter | public | function | Returns the processed value of a named route parameter. | Overrides RouteMatchInterface::getParameter |
RouteMatch::getParameterNames | protected | function | Returns the names of all parameters for the currently matched route. | |
RouteMatch::getParameters | public | function | Returns the bag of all processed route parameters. | Overrides RouteMatchInterface::getParameters |
RouteMatch::getRawParameter | public | function | Returns the raw value of a named route parameter. | Overrides RouteMatchInterface::getRawParameter |
RouteMatch::getRawParameters | public | function | Returns the bag of all raw route parameters. | Overrides RouteMatchInterface::getRawParameters |
RouteMatch::getRouteName | public | function | Returns the route name. | Overrides RouteMatchInterface::getRouteName |
RouteMatch::getRouteObject | public | function | Returns the route object. | Overrides RouteMatchInterface::getRouteObject |
RouteMatch::__construct | public | function | Constructs a RouteMatch object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.