123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpKernel\Controller;
- use Psr\Log\LoggerInterface;
- use Symfony\Component\HttpFoundation\Request;
- /**
- * ControllerResolver.
- *
- * This implementation uses the '_controller' request attribute to determine
- * the controller to execute and uses the request attributes to determine
- * the controller method arguments.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class ControllerResolver implements ControllerResolverInterface
- {
- private $logger;
- /**
- * If the ...$arg functionality is available.
- *
- * Requires at least PHP 5.6.0 or HHVM 3.9.1
- *
- * @var bool
- */
- private $supportsVariadic;
- /**
- * If scalar types exists.
- *
- * @var bool
- */
- private $supportsScalarTypes;
- /**
- * Constructor.
- *
- * @param LoggerInterface $logger A LoggerInterface instance
- */
- public function __construct(LoggerInterface $logger = null)
- {
- $this->logger = $logger;
- $this->supportsVariadic = method_exists('ReflectionParameter', 'isVariadic');
- $this->supportsScalarTypes = method_exists('ReflectionParameter', 'getType');
- }
- /**
- * {@inheritdoc}
- *
- * This method looks for a '_controller' request attribute that represents
- * the controller name (a string like ClassName::MethodName).
- */
- public function getController(Request $request)
- {
- if (!$controller = $request->attributes->get('_controller')) {
- if (null !== $this->logger) {
- $this->logger->warning('Unable to look for the controller as the "_controller" parameter is missing.');
- }
- return false;
- }
- if (is_array($controller)) {
- return $controller;
- }
- if (is_object($controller)) {
- if (method_exists($controller, '__invoke')) {
- return $controller;
- }
- throw new \InvalidArgumentException(sprintf('Controller "%s" for URI "%s" is not callable.', get_class($controller), $request->getPathInfo()));
- }
- if (false === strpos($controller, ':')) {
- if (method_exists($controller, '__invoke')) {
- return $this->instantiateController($controller);
- } elseif (function_exists($controller)) {
- return $controller;
- }
- }
- $callable = $this->createController($controller);
- if (!is_callable($callable)) {
- throw new \InvalidArgumentException(sprintf('Controller "%s" for URI "%s" is not callable.', $controller, $request->getPathInfo()));
- }
- return $callable;
- }
- /**
- * {@inheritdoc}
- */
- public function getArguments(Request $request, $controller)
- {
- if (is_array($controller)) {
- $r = new \ReflectionMethod($controller[0], $controller[1]);
- } elseif (is_object($controller) && !$controller instanceof \Closure) {
- $r = new \ReflectionObject($controller);
- $r = $r->getMethod('__invoke');
- } else {
- $r = new \ReflectionFunction($controller);
- }
- return $this->doGetArguments($request, $controller, $r->getParameters());
- }
- /**
- * @param Request $request
- * @param callable $controller
- * @param \ReflectionParameter[] $parameters
- *
- * @return array The arguments to use when calling the action
- */
- protected function doGetArguments(Request $request, $controller, array $parameters)
- {
- $attributes = $request->attributes->all();
- $arguments = array();
- foreach ($parameters as $param) {
- if (array_key_exists($param->name, $attributes)) {
- if ($this->supportsVariadic && $param->isVariadic() && is_array($attributes[$param->name])) {
- $arguments = array_merge($arguments, array_values($attributes[$param->name]));
- } else {
- $arguments[] = $attributes[$param->name];
- }
- } elseif ($param->getClass() && $param->getClass()->isInstance($request)) {
- $arguments[] = $request;
- } elseif ($param->isDefaultValueAvailable()) {
- $arguments[] = $param->getDefaultValue();
- } elseif ($this->supportsScalarTypes && $param->hasType() && $param->allowsNull()) {
- $arguments[] = null;
- } else {
- if (is_array($controller)) {
- $repr = sprintf('%s::%s()', get_class($controller[0]), $controller[1]);
- } elseif (is_object($controller)) {
- $repr = get_class($controller);
- } else {
- $repr = $controller;
- }
- 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));
- }
- }
- return $arguments;
- }
- /**
- * Returns a callable for the given controller.
- *
- * @param string $controller A Controller string
- *
- * @return callable A PHP callable
- *
- * @throws \InvalidArgumentException
- */
- protected function createController($controller)
- {
- if (false === strpos($controller, '::')) {
- throw new \InvalidArgumentException(sprintf('Unable to find controller "%s".', $controller));
- }
- list($class, $method) = explode('::', $controller, 2);
- if (!class_exists($class)) {
- throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
- }
- return array($this->instantiateController($class), $method);
- }
- /**
- * Returns an instantiated controller.
- *
- * @param string $class A class name
- *
- * @return object
- */
- protected function instantiateController($class)
- {
- return new $class();
- }
- }
|