|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * @link http://github.com/zendframework/zend-mvc for the canonical source repository |
| 4 | + * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com) |
| 5 | + * @license http://framework.zend.com/license/new-bsd New BSD License |
| 6 | + */ |
| 7 | + |
| 8 | +namespace Zend\Mvc\Controller; |
| 9 | + |
| 10 | +use Interop\Container\ContainerInterface; |
| 11 | +use ReflectionClass; |
| 12 | +use ReflectionParameter; |
| 13 | +use Zend\Console\Adapter\AdapterInterface as ConsoleAdapterInterface; |
| 14 | +use Zend\Filter\FilterPluginManager; |
| 15 | +use Zend\Hydrator\HydratorPluginManager; |
| 16 | +use Zend\InputFilter\InputFilterPluginManager; |
| 17 | +use Zend\Log\FilterPluginManager as LogFilterManager; |
| 18 | +use Zend\Log\FormatterPluginManager as LogFormatterManager; |
| 19 | +use Zend\Log\ProcessorPluginManager as LogProcessorManager; |
| 20 | +use Zend\Log\WriterPluginManager as LogWriterManager; |
| 21 | +use Zend\Serializer\AdapterPluginManager as SerializerAdapterManager; |
| 22 | +use Zend\ServiceManager\Exception\ServiceNotFoundException; |
| 23 | +use Zend\ServiceManager\Factory\AbstractFactoryInterface; |
| 24 | +use Zend\Stdlib\DispatchableInterface; |
| 25 | +use Zend\Validator\ValidatorPluginManager; |
| 26 | + |
| 27 | +/** |
| 28 | + * Reflection-based factory for controllers. |
| 29 | + * |
| 30 | + * To ease development, this factory may be used for controllers with |
| 31 | + * type-hinted arguments that resolve to services in the application |
| 32 | + * container; this allows omitting the step of writing a factory for |
| 33 | + * each controller. |
| 34 | + * |
| 35 | + * You may use it as either an abstract factory: |
| 36 | + * |
| 37 | + * <code> |
| 38 | + * 'controllers' => [ |
| 39 | + * 'abstract_factories' => [ |
| 40 | + * LazyControllerAbstractFactory::class, |
| 41 | + * ], |
| 42 | + * ], |
| 43 | + * </code> |
| 44 | + * |
| 45 | + * Or as a factory, mapping a controller class name to it: |
| 46 | + * |
| 47 | + * <code> |
| 48 | + * 'controllers' => [ |
| 49 | + * 'factories' => [ |
| 50 | + * MyControllerWithDependencies::class => LazyControllerAbstractFactory::class, |
| 51 | + * ], |
| 52 | + * ], |
| 53 | + * </code> |
| 54 | + * |
| 55 | + * The latter approach is more explicit, and also more performant. |
| 56 | + * |
| 57 | + * The factory has the following constraints/features: |
| 58 | + * |
| 59 | + * - A parameter named `$config` typehinted as an array will receive the |
| 60 | + * application "config" service (i.e., the merged configuration). |
| 61 | + * - Parameters type-hinted against array, but not named `$config` will |
| 62 | + * be injected with an empty array. |
| 63 | + * - Scalar parameters will be resolved as null values. |
| 64 | + * - If a service cannot be found for a given typehint, the factory will |
| 65 | + * raise an exception detailing this. |
| 66 | + * - Some services provided by Zend Framework components do not have |
| 67 | + * entries based on their class name (for historical reasons); the |
| 68 | + * factory contains a map of these class/interface names to the |
| 69 | + * corresponding service name to allow them to resolve. |
| 70 | + * |
| 71 | + * `$options` passed to the factory are ignored in all cases, as we cannot |
| 72 | + * make assumptions about which argument(s) they might replace. |
| 73 | + */ |
| 74 | +class LazyControllerAbstractFactory implements AbstractFactoryInterface |
| 75 | +{ |
| 76 | + /** |
| 77 | + * Maps known classes/interfaces to the service that provides them; only |
| 78 | + * required for those services with no entry based on the class/interface |
| 79 | + * name. |
| 80 | + * |
| 81 | + * Extend the class if you wish to add to the list. |
| 82 | + * |
| 83 | + * @var string[] |
| 84 | + */ |
| 85 | + protected $aliases = [ |
| 86 | + ConsoleAdapterInterface::class => 'ConsoleAdapter', |
| 87 | + FilterPluginManager::class => 'FilterManager', |
| 88 | + HydratorPluginManager::class => 'HydratorManager', |
| 89 | + InputFilterPluginManager::class => 'InputFilterManager', |
| 90 | + LogFilterManager::class => 'LogFilterManager', |
| 91 | + LogFormatterManager::class => 'LogFormatterManager', |
| 92 | + LogProcessorManager::class => 'LogProcessorManager', |
| 93 | + LogWriterManager::class => 'LogWriterManager', |
| 94 | + SerializerAdapterManager::class => 'SerializerAdapterManager', |
| 95 | + ValidatorPluginManager::class => 'ValidatorManager', |
| 96 | + ]; |
| 97 | + |
| 98 | + /** |
| 99 | + * {@inheritDoc} |
| 100 | + * |
| 101 | + * @return DispatchableInterface |
| 102 | + */ |
| 103 | + public function __invoke(ContainerInterface $container, $requestedName, array $options = null) |
| 104 | + { |
| 105 | + $reflectionClass = new ReflectionClass($requestedName); |
| 106 | + |
| 107 | + if (null === ($constructor = $reflectionClass->getConstructor())) { |
| 108 | + return new $requestedName(); |
| 109 | + } |
| 110 | + |
| 111 | + $reflectionParameters = $constructor->getParameters(); |
| 112 | + |
| 113 | + if (empty($reflectionParameters)) { |
| 114 | + return new $requestedName(); |
| 115 | + } |
| 116 | + |
| 117 | + $parameters = array_map( |
| 118 | + $this->resolveParameter($container, $requestedName), |
| 119 | + $reflectionParameters |
| 120 | + ); |
| 121 | + |
| 122 | + return new $requestedName(...$parameters); |
| 123 | + } |
| 124 | + |
| 125 | + /** |
| 126 | + * {@inheritDoc} |
| 127 | + */ |
| 128 | + public function canCreate(ContainerInterface $container, $requestedName) |
| 129 | + { |
| 130 | + if (! class_exists($requestedName)) { |
| 131 | + return false; |
| 132 | + } |
| 133 | + |
| 134 | + return in_array(DispatchableInterface::class, class_implements($requestedName), true); |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * Resolve a parameter to a value. |
| 139 | + * |
| 140 | + * Returns a callback for resolving a parameter to a value. |
| 141 | + * |
| 142 | + * @param ContainerInterface $container |
| 143 | + * @param string $requestedName |
| 144 | + * @return callable |
| 145 | + */ |
| 146 | + private function resolveParameter(ContainerInterface $container, $requestedName) |
| 147 | + { |
| 148 | + /** |
| 149 | + * @param ReflectionClass $parameter |
| 150 | + * @return mixed |
| 151 | + * @throws ServiceNotFoundException If type-hinted parameter cannot be |
| 152 | + * resolved to a service in the container. |
| 153 | + */ |
| 154 | + return function (ReflectionParameter $parameter) use ($container, $requestedName) { |
| 155 | + if ($parameter->isArray() |
| 156 | + && $parameter->getName() === 'config' |
| 157 | + && $container->has('config') |
| 158 | + ) { |
| 159 | + return $container->get('config'); |
| 160 | + } |
| 161 | + |
| 162 | + if ($parameter->isArray()) { |
| 163 | + return []; |
| 164 | + } |
| 165 | + |
| 166 | + if (! $parameter->getClass()) { |
| 167 | + return; |
| 168 | + } |
| 169 | + |
| 170 | + $type = $parameter->getClass()->getName(); |
| 171 | + $type = isset($this->aliases[$type]) ? $this->aliases[$type] : $type; |
| 172 | + |
| 173 | + if (! $container->has($type)) { |
| 174 | + throw new ServiceNotFoundException(sprintf( |
| 175 | + 'Unable to create controller "%s"; unable to resolve parameter "%s" using type hint "%s"', |
| 176 | + $requestedName, |
| 177 | + $parameter->getName(), |
| 178 | + $type |
| 179 | + )); |
| 180 | + } |
| 181 | + |
| 182 | + return $container->get($type); |
| 183 | + }; |
| 184 | + } |
| 185 | +} |
0 commit comments