Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Controller/ControllerResolver.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	80.00% covered (warning)	80.00%	4 / 5	CRAP	83.33% covered (warning)	83.33%	40 / 48
ControllerResolver	0.00% covered (danger)	0.00%	0 / 1	80.00% covered (warning)	80.00%	4 / 5	32.89	83.33% covered (warning)	83.33%	40 / 48
__construct				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	3 / 3
getControllerFromDefinition				100.00% covered (success)	100.00%	1 / 1	8	100.00% covered (success)	100.00%	11 / 11
getController				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	3 / 3
createController				100.00% covered (success)	100.00%	1 / 1	3	100.00% covered (success)	100.00%	8 / 8
doGetArguments				0.00% covered (danger)	0.00%	0 / 1	24.47	65.22% covered (warning)	65.22%	15 / 23

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Controller\ControllerResolver.
6	*/
7
8	namespace Drupal\Core\Controller;
9
10	use Drupal\Core\DependencyInjection\ClassResolverInterface;
11	use Drupal\Core\Routing\RouteMatch;
12	use Drupal\Core\Routing\RouteMatchInterface;
13	use Psr\Http\Message\ServerRequestInterface;
14	use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
15	use Symfony\Component\HttpFoundation\Request;
16	use Symfony\Component\HttpKernel\Controller\ControllerResolver as BaseControllerResolver;
17
18	/**
19	* ControllerResolver to enhance controllers beyond Symfony's basic handling.
20	*
21	* It adds two behaviors:
22	*
23	* - When creating a new object-based controller that implements
24	* ContainerAwareInterface, inject the container into it. While not always
25	* necessary, that allows a controller to vary the services it needs at
26	* runtime.
27	*
28	* - By default, a controller name follows the class::method notation. This
29	* class adds the possibility to use a service from the container as a
30	* controller by using a service:method notation (Symfony uses the same
31	* convention).
32	*/
33	class ControllerResolver extends BaseControllerResolver implements ControllerResolverInterface {
34
35	/**
36	* The class resolver.
37	*
38	* @var \Drupal\Core\DependencyInjection\ClassResolverInterface
39	*/
40	protected $classResolver;
41
42	/**
43	* The PSR-7 converter.
44	*
45	* @var \Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface
46	*/
47	protected $httpMessageFactory;
48
49	/**
50	* Constructs a new ControllerResolver.
51	*
52	* @param \Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface $http_message_factory
53	* The PSR-7 converter.
54	*
55	* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
56	* The class resolver.
57	*/
58	public function __construct(HttpMessageFactoryInterface $http_message_factory, ClassResolverInterface $class_resolver) {
59	$this->httpMessageFactory = $http_message_factory;
60	$this->classResolver = $class_resolver;
61	}
62
63	/**
64	* {@inheritdoc}
65	*/
66	public function getControllerFromDefinition($controller, $path = '') {
67	if (is_array($controller) \|\| (is_object($controller) && method_exists($controller, '__invoke'))) {
68	return $controller;
69	}
70
71	if (strpos($controller, ':') === FALSE) {
72	if (function_exists($controller)) {
73	return $controller;
74	}
75	elseif (method_exists($controller, '__invoke')) {
76	return new $controller;
77	}
78	}
79
80	$callable = $this->createController($controller);
81
82	if (!is_callable($callable)) {
83	throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable.', $path));
84	}
85
86	return $callable;
87	}
88
89
90	/**
91	* {@inheritdoc}
92	*/
93	public function getController(Request $request) {
94	if (!$controller = $request->attributes->get('_controller')) {
95	return FALSE;
96	}
97	return $this->getControllerFromDefinition($controller, $request->getPathInfo());
98	}
99
100	/**
101	* Returns a callable for the given controller.
102	*
103	* @param string $controller
104	* A Controller string.
105	*
106	* @return mixed
107	* A PHP callable.
108	*
109	* @throws \LogicException
110	* If the controller cannot be parsed.
111	*
112	* @throws \InvalidArgumentException
113	* If the controller class does not exist.
114	*/
115	protected function createController($controller) {
116	// Controller in the service:method notation.
117	$count = substr_count($controller, ':');
118	if ($count == 1) {
119	list($class_or_service, $method) = explode(':', $controller, 2);
120	}
121	// Controller in the class::method notation.
122	elseif (strpos($controller, '::') !== FALSE) {
123	list($class_or_service, $method) = explode('::', $controller, 2);
124	}
125	else {
126	throw new \LogicException(sprintf('Unable to parse the controller name "%s".', $controller));
127	}
128
129	$controller = $this->classResolver->getInstanceFromDefinition($class_or_service);
130
131	return array($controller, $method);
132	}
133
134	/**
135	* {@inheritdoc}
136	*/
137	protected function doGetArguments(Request $request, $controller, array $parameters) {
138	$attributes = $request->attributes->all();
139	$raw_parameters = $request->attributes->has('_raw_variables') ? $request->attributes->get('_raw_variables') : [];
140	$arguments = array();
141	foreach ($parameters as $param) {
142	if (array_key_exists($param->name, $attributes)) {
143	$arguments[] = $attributes[$param->name];
144	}
145	elseif (array_key_exists($param->name, $raw_parameters)) {
146	$arguments[] = $attributes[$param->name];
147	}
148	elseif ($param->getClass() && $param->getClass()->isInstance($request)) {
149	$arguments[] = $request;
150	}
151	elseif ($param->getClass() && $param->getClass()->name === ServerRequestInterface::class) {
152	$arguments[] = $this->httpMessageFactory->createRequest($request);
153	}
154	elseif ($param->getClass() && ($param->getClass()->name == RouteMatchInterface::class \|\| is_subclass_of($param->getClass()->name, RouteMatchInterface::class))) {
155	$arguments[] = RouteMatch::createFromRequest($request);
156	}
157	elseif ($param->isDefaultValueAvailable()) {
158	$arguments[] = $param->getDefaultValue();
159	}
160	else {
161	if (is_array($controller)) {
162	$repr = sprintf('%s::%s()', get_class($controller[0]), $controller[1]);
163	}
164	elseif (is_object($controller)) {
165	$repr = get_class($controller);
166	}
167	else {
168	$repr = $controller;
169	}
170
171	throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument (because there is no default value or because there is a non optional argument after this one).', $repr, $param->name));
172	}
173	}
174	return $arguments;
175	}
176
177	}