class PathProcessorFront
Same name in other branches
- 9 core/lib/Drupal/Core/PathProcessor/PathProcessorFront.php \Drupal\Core\PathProcessor\PathProcessorFront
- 8.9.x core/lib/Drupal/Core/PathProcessor/PathProcessorFront.php \Drupal\Core\PathProcessor\PathProcessorFront
- 10 core/lib/Drupal/Core/PathProcessor/PathProcessorFront.php \Drupal\Core\PathProcessor\PathProcessorFront
Processes the inbound path by resolving it to the front page if empty.
Hierarchy
- class \Drupal\Core\PathProcessor\PathProcessorFront implements \Drupal\Core\PathProcessor\InboundPathProcessorInterface
Expanded class hierarchy of PathProcessorFront
2 files declare their use of PathProcessorFront
- PathProcessorFrontTest.php in core/
tests/ Drupal/ Tests/ Core/ PathProcessor/ PathProcessorFrontTest.php - PathProcessorTest.php in core/
tests/ Drupal/ Tests/ Core/ PathProcessor/ PathProcessorTest.php
File
-
core/
lib/ Drupal/ Core/ PathProcessor/ PathProcessorFront.php, line 12
Namespace
Drupal\Core\PathProcessorView source
class PathProcessorFront implements InboundPathProcessorInterface {
/**
* A config factory for retrieving required config settings.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $config;
/**
* Constructs a PathProcessorFront object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config
* A config factory for retrieving the site front page configuration.
*/
public function __construct(ConfigFactoryInterface $config) {
$this->config = $config;
}
/**
* {@inheritdoc}
*/
public function processInbound($path, Request $request) {
if ($path === '/') {
$path = $this->config
->get('system.site')
->get('page.front');
if (empty($path)) {
// We have to return a valid path but / does not have a route and config
// might be broken so stop execution.
throw new NotFoundHttpException();
}
$components = parse_url($path);
// Remove query string and fragment.
$path = $components['path'];
// Merge query parameters from front page configuration value
// with URL query, so that actual URL takes precedence.
if (!empty($components['query'])) {
parse_str($components['query'], $parameters);
array_replace($parameters, $request->query
->all());
$request->query
->replace($parameters);
}
}
return $path;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
PathProcessorFront::$config | protected | property | A config factory for retrieving required config settings. | |
PathProcessorFront::processInbound | public | function | Processes the inbound path. | Overrides InboundPathProcessorInterface::processInbound |
PathProcessorFront::__construct | public | function | Constructs a PathProcessorFront object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.