class ControllerResolver
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Controller/ControllerResolver.php \Drupal\Core\Controller\ControllerResolver
- 10 core/lib/Drupal/Core/Controller/ControllerResolver.php \Drupal\Core\Controller\ControllerResolver
- 11.x core/lib/Drupal/Core/Controller/ControllerResolver.php \Drupal\Core\Controller\ControllerResolver
ControllerResolver to enhance controllers beyond Symfony's basic handling.
It adds two behaviors:
- When creating a new object-based controller that implements ContainerAwareInterface, inject the container into it. While not always necessary, that allows a controller to vary the services it needs at runtime.
- By default, a controller name follows the class::method notation. This class adds the possibility to use a service from the container as a controller by using a service:method notation (Symfony uses the same convention).
Hierarchy
- class \Drupal\Core\Controller\ControllerResolver extends \Symfony\Component\HttpKernel\Controller\ControllerResolver implements \Drupal\Core\Controller\ControllerResolverInterface
Expanded class hierarchy of ControllerResolver
2 files declare their use of ControllerResolver
- ControllerResolverTest.php in core/
tests/ Drupal/ Tests/ Core/ Controller/ ControllerResolverTest.php - Contains \Drupal\Tests\Core\Controller\ControllerResolverTest.
- CustomAccessCheckTest.php in core/
tests/ Drupal/ Tests/ Core/ Access/ CustomAccessCheckTest.php - Contains \Drupal\Tests\Core\Access\CustomAccessCheckTest.
1 string reference to 'ControllerResolver'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses ControllerResolver
File
-
core/
lib/ Drupal/ Core/ Controller/ ControllerResolver.php, line 25
Namespace
Drupal\Core\ControllerView source
class ControllerResolver extends BaseControllerResolver implements ControllerResolverInterface {
/**
* The class resolver.
*
* @var \Drupal\Core\DependencyInjection\ClassResolverInterface
*/
protected $classResolver;
/**
* The PSR-7 converter.
*
* @var \Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface
*/
protected $httpMessageFactory;
/**
* Constructs a new ControllerResolver.
*
* @param \Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface $http_message_factory
* The PSR-7 converter.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
* The class resolver.
*/
public function __construct(HttpMessageFactoryInterface $http_message_factory, ClassResolverInterface $class_resolver) {
$this->httpMessageFactory = $http_message_factory;
$this->classResolver = $class_resolver;
}
/**
* {@inheritdoc}
*/
public function getControllerFromDefinition($controller, $path = '') {
if (is_array($controller) || is_object($controller) && method_exists($controller, '__invoke')) {
return $controller;
}
if (strpos($controller, ':') === FALSE) {
if (function_exists($controller)) {
return $controller;
}
return $this->classResolver
->getInstanceFromDefinition($controller);
}
$callable = $this->createController($controller);
if (!is_callable($callable)) {
throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable.', $path));
}
return $callable;
}
/**
* {@inheritdoc}
*/
public function getController(Request $request) {
if (!($controller = $request->attributes
->get('_controller'))) {
return FALSE;
}
return $this->getControllerFromDefinition($controller, $request->getPathInfo());
}
/**
* Returns a callable for the given controller.
*
* @param string $controller
* A Controller string.
*
* @return mixed
* A PHP callable.
*
* @throws \LogicException
* If the controller cannot be parsed.
*
* @throws \InvalidArgumentException
* If the controller class does not exist.
*/
protected function createController($controller) {
// Controller in the service:method notation.
$count = substr_count($controller, ':');
if ($count == 1) {
[
$class_or_service,
$method,
] = explode(':', $controller, 2);
}
elseif (strpos($controller, '::') !== FALSE) {
[
$class_or_service,
$method,
] = explode('::', $controller, 2);
}
else {
throw new \LogicException(sprintf('Unable to parse the controller name "%s".', $controller));
}
$controller = $this->classResolver
->getInstanceFromDefinition($class_or_service);
return [
$controller,
$method,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ControllerResolver::$classResolver | protected | property | The class resolver. | |
ControllerResolver::$httpMessageFactory | protected | property | The PSR-7 converter. | |
ControllerResolver::createController | protected | function | Returns a callable for the given controller. | |
ControllerResolver::getController | public | function | ||
ControllerResolver::getControllerFromDefinition | public | function | Returns the Controller instance with a given controller route definition. | Overrides ControllerResolverInterface::getControllerFromDefinition |
ControllerResolver::__construct | public | function | Constructs a new ControllerResolver. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.