yiisoft /
yii2
Complex classes like Container often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Container, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 100 | class Container extends Component |
||
| 101 | { |
||
| 102 | /** |
||
| 103 | * @var array singleton objects indexed by their types |
||
| 104 | */ |
||
| 105 | private $_singletons = []; |
||
| 106 | /** |
||
| 107 | * @var array object definitions indexed by their types |
||
| 108 | */ |
||
| 109 | private $_definitions = []; |
||
| 110 | /** |
||
| 111 | * @var array constructor parameters indexed by object types |
||
| 112 | */ |
||
| 113 | private $_params = []; |
||
| 114 | /** |
||
| 115 | * @var array cached ReflectionClass objects indexed by class/interface names |
||
| 116 | */ |
||
| 117 | private $_reflections = []; |
||
| 118 | /** |
||
| 119 | * @var array cached dependencies indexed by class/interface names. Each class name |
||
| 120 | * is associated with a list of constructor parameter types or default values. |
||
| 121 | */ |
||
| 122 | private $_dependencies = []; |
||
| 123 | |||
| 124 | |||
| 125 | /** |
||
| 126 | * Returns an instance of the requested class. |
||
| 127 | * |
||
| 128 | * You may provide constructor parameters (`$params`) and object configurations (`$config`) |
||
| 129 | * that will be used during the creation of the instance. |
||
| 130 | * |
||
| 131 | * If the class implements [[\yii\base\Configurable]], the `$config` parameter will be passed as the last |
||
| 132 | * parameter to the class constructor; Otherwise, the configuration will be applied *after* the object is |
||
| 133 | * instantiated. |
||
| 134 | * |
||
| 135 | * Note that if the class is declared to be singleton by calling [[setSingleton()]], |
||
| 136 | * the same instance of the class will be returned each time this method is called. |
||
| 137 | * In this case, the constructor parameters and object configurations will be used |
||
| 138 | * only if the class is instantiated the first time. |
||
| 139 | * |
||
| 140 | * @param string $class the class name or an alias name (e.g. `foo`) that was previously registered via [[set()]] |
||
| 141 | * or [[setSingleton()]]. |
||
| 142 | * @param array $params a list of constructor parameter values. The parameters should be provided in the order |
||
| 143 | * they appear in the constructor declaration. If you want to skip some parameters, you should index the remaining |
||
| 144 | * ones with the integers that represent their positions in the constructor parameter list. |
||
| 145 | * @param array $config a list of name-value pairs that will be used to initialize the object properties. |
||
| 146 | * @return object an instance of the requested class. |
||
| 147 | * @throws InvalidConfigException if the class cannot be recognized or correspond to an invalid definition |
||
| 148 | * @throws NotInstantiableException If resolved to an abstract class or an interface (since 2.0.9) |
||
| 149 | */ |
||
| 150 | 3125 | public function get($class, $params = [], $config = []) |
|
| 151 | { |
||
| 152 | 3125 | if (isset($this->_singletons[$class])) { |
|
| 153 | // singleton |
||
| 154 | 1 | return $this->_singletons[$class]; |
|
| 155 | 3125 | } elseif (!isset($this->_definitions[$class])) { |
|
| 156 | 3125 | return $this->build($class, $params, $config); |
|
| 157 | } |
||
| 158 | |||
| 159 | 22 | $definition = $this->_definitions[$class]; |
|
| 160 | |||
| 161 | 22 | if (is_callable($definition, true)) { |
|
| 162 | 3 | $params = $this->resolveDependencies($this->mergeParams($class, $params)); |
|
| 163 | 3 | $object = call_user_func($definition, $this, $params, $config); |
|
| 164 | 22 | } elseif (is_array($definition)) { |
|
| 165 | 22 | $concrete = $definition['class']; |
|
| 166 | 22 | unset($definition['class']); |
|
| 167 | |||
| 168 | 22 | $config = array_merge($definition, $config); |
|
| 169 | 22 | $params = $this->mergeParams($class, $params); |
|
| 170 | |||
| 171 | 22 | if ($concrete === $class) { |
|
| 172 | 1 | $object = $this->build($class, $params, $config); |
|
| 173 | } else { |
||
| 174 | 22 | $object = $this->get($concrete, $params, $config); |
|
| 175 | } |
||
| 176 | } elseif (is_object($definition)) { |
||
| 177 | return $this->_singletons[$class] = $definition; |
||
| 178 | } else { |
||
| 179 | throw new InvalidConfigException('Unexpected object definition type: ' . gettype($definition)); |
||
| 180 | } |
||
| 181 | |||
| 182 | 22 | if (array_key_exists($class, $this->_singletons)) { |
|
| 183 | // singleton |
||
| 184 | 1 | $this->_singletons[$class] = $object; |
|
| 185 | } |
||
| 186 | |||
| 187 | 22 | return $object; |
|
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Registers a class definition with this container. |
||
| 192 | * |
||
| 193 | * For example, |
||
| 194 | * |
||
| 195 | * ```php |
||
| 196 | * // register a class name as is. This can be skipped. |
||
| 197 | * $container->set('yii\db\Connection'); |
||
| 198 | * |
||
| 199 | * // register an interface |
||
| 200 | * // When a class depends on the interface, the corresponding class |
||
| 201 | * // will be instantiated as the dependent object |
||
| 202 | * $container->set('yii\mail\MailInterface', 'yii\swiftmailer\Mailer'); |
||
| 203 | * |
||
| 204 | * // register an alias name. You can use $container->get('foo') |
||
| 205 | * // to create an instance of Connection |
||
| 206 | * $container->set('foo', 'yii\db\Connection'); |
||
| 207 | * |
||
| 208 | * // register a class with configuration. The configuration |
||
| 209 | * // will be applied when the class is instantiated by get() |
||
| 210 | * $container->set('yii\db\Connection', [ |
||
| 211 | * 'dsn' => 'mysql:host=127.0.0.1;dbname=demo', |
||
| 212 | * 'username' => 'root', |
||
| 213 | * 'password' => '', |
||
| 214 | * 'charset' => 'utf8', |
||
| 215 | * ]); |
||
| 216 | * |
||
| 217 | * // register an alias name with class configuration |
||
| 218 | * // In this case, a "class" element is required to specify the class |
||
| 219 | * $container->set('db', [ |
||
| 220 | * 'class' => 'yii\db\Connection', |
||
| 221 | * 'dsn' => 'mysql:host=127.0.0.1;dbname=demo', |
||
| 222 | * 'username' => 'root', |
||
| 223 | * 'password' => '', |
||
| 224 | * 'charset' => 'utf8', |
||
| 225 | * ]); |
||
| 226 | * |
||
| 227 | * // register a PHP callable |
||
| 228 | * // The callable will be executed when $container->get('db') is called |
||
| 229 | * $container->set('db', function ($container, $params, $config) { |
||
| 230 | * return new \yii\db\Connection($config); |
||
| 231 | * }); |
||
| 232 | * ``` |
||
| 233 | * |
||
| 234 | * If a class definition with the same name already exists, it will be overwritten with the new one. |
||
| 235 | * You may use [[has()]] to check if a class definition already exists. |
||
| 236 | * |
||
| 237 | * @param string $class class name, interface name or alias name |
||
| 238 | * @param mixed $definition the definition associated with `$class`. It can be one of the following: |
||
| 239 | * |
||
| 240 | * - a PHP callable: The callable will be executed when [[get()]] is invoked. The signature of the callable |
||
| 241 | * should be `function ($container, $params, $config)`, where `$params` stands for the list of constructor |
||
| 242 | * parameters, `$config` the object configuration, and `$container` the container object. The return value |
||
| 243 | * of the callable will be returned by [[get()]] as the object instance requested. |
||
| 244 | * - a configuration array: the array contains name-value pairs that will be used to initialize the property |
||
| 245 | * values of the newly created object when [[get()]] is called. The `class` element stands for the |
||
| 246 | * the class of the object to be created. If `class` is not specified, `$class` will be used as the class name. |
||
| 247 | * - a string: a class name, an interface name or an alias name. |
||
| 248 | * @param array $params the list of constructor parameters. The parameters will be passed to the class |
||
| 249 | * constructor when [[get()]] is called. |
||
| 250 | * @return $this the container itself |
||
| 251 | */ |
||
| 252 | 533 | public function set($class, $definition = [], array $params = []) |
|
| 259 | |||
| 260 | /** |
||
| 261 | * Registers a class definition with this container and marks the class as a singleton class. |
||
| 262 | * |
||
| 263 | * This method is similar to [[set()]] except that classes registered via this method will only have one |
||
| 264 | * instance. Each time [[get()]] is called, the same instance of the specified class will be returned. |
||
| 265 | * |
||
| 266 | * @param string $class class name, interface name or alias name |
||
| 267 | * @param mixed $definition the definition associated with `$class`. See [[set()]] for more details. |
||
| 268 | * @param array $params the list of constructor parameters. The parameters will be passed to the class |
||
| 269 | * constructor when [[get()]] is called. |
||
| 270 | * @return $this the container itself |
||
| 271 | * @see set() |
||
| 272 | */ |
||
| 273 | 1 | public function setSingleton($class, $definition = [], array $params = []) |
|
| 280 | |||
| 281 | /** |
||
| 282 | * Returns a value indicating whether the container has the definition of the specified name. |
||
| 283 | * @param string $class class name, interface name or alias name |
||
| 284 | * @return bool whether the container has the definition of the specified name.. |
||
| 285 | * @see set() |
||
| 286 | */ |
||
| 287 | public function has($class) |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Returns a value indicating whether the given name corresponds to a registered singleton. |
||
| 294 | * @param string $class class name, interface name or alias name |
||
| 295 | * @param bool $checkInstance whether to check if the singleton has been instantiated. |
||
| 296 | * @return bool whether the given name corresponds to a registered singleton. If `$checkInstance` is true, |
||
| 297 | * the method should return a value indicating whether the singleton has been instantiated. |
||
| 298 | */ |
||
| 299 | public function hasSingleton($class, $checkInstance = false) |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Removes the definition for the specified name. |
||
| 306 | * @param string $class class name, interface name or alias name |
||
| 307 | */ |
||
| 308 | public function clear($class) |
||
| 312 | |||
| 313 | /** |
||
| 314 | * Normalizes the class definition. |
||
| 315 | * @param string $class class name |
||
| 316 | * @param string|array|callable $definition the class definition |
||
| 317 | * @return array the normalized class definition |
||
| 318 | * @throws InvalidConfigException if the definition is invalid. |
||
| 319 | */ |
||
| 320 | 534 | protected function normalizeDefinition($class, $definition) |
|
| 342 | |||
| 343 | /** |
||
| 344 | * Returns the list of the object definitions or the loaded shared objects. |
||
| 345 | * @return array the list of the object definitions or the loaded shared objects (type or ID => definition or instance). |
||
| 346 | */ |
||
| 347 | public function getDefinitions() |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Creates an instance of the specified class. |
||
| 354 | * This method will resolve dependencies of the specified class, instantiate them, and inject |
||
| 355 | * them into the new instance of the specified class. |
||
| 356 | * @param string $class the class name |
||
| 357 | * @param array $params constructor parameters |
||
| 358 | * @param array $config configurations to be applied to the new instance |
||
| 359 | * @return object the newly created instance of the specified class |
||
| 360 | * @throws NotInstantiableException If resolved to an abstract class or an interface (since 2.0.9) |
||
| 361 | */ |
||
| 362 | 3125 | protected function build($class, $params, $config) |
|
| 394 | |||
| 395 | /** |
||
| 396 | * Merges the user-specified constructor parameters with the ones registered via [[set()]]. |
||
| 397 | * @param string $class class name, interface name or alias name |
||
| 398 | * @param array $params the constructor parameters |
||
| 399 | * @return array the merged parameters |
||
| 400 | */ |
||
| 401 | 22 | protected function mergeParams($class, $params) |
|
| 416 | |||
| 417 | /** |
||
| 418 | * Returns the dependencies of the specified class. |
||
| 419 | * @param string $class class name, interface name or alias name |
||
| 420 | * @return array the dependencies of the specified class. |
||
| 421 | * @throws InvalidConfigException if a dependency cannot be resolved or if a dependency cannot be fulfilled. |
||
| 422 | */ |
||
| 423 | 3125 | protected function getDependencies($class) |
|
| 455 | |||
| 456 | /** |
||
| 457 | * Resolves dependencies by replacing them with the actual object instances. |
||
| 458 | * @param array $dependencies the dependencies |
||
| 459 | * @param ReflectionClass $reflection the class reflection associated with the dependencies |
||
| 460 | * @return array the resolved dependencies |
||
| 461 | * @throws InvalidConfigException if a dependency cannot be resolved or if a dependency cannot be fulfilled. |
||
| 462 | */ |
||
| 463 | 3122 | protected function resolveDependencies($dependencies, $reflection = null) |
|
| 479 | |||
| 480 | /** |
||
| 481 | * Invoke a callback with resolving dependencies in parameters. |
||
| 482 | * |
||
| 483 | * This methods allows invoking a callback and let type hinted parameter names to be |
||
| 484 | * resolved as objects of the Container. It additionally allow calling function using named parameters. |
||
| 485 | * |
||
| 486 | * For example, the following callback may be invoked using the Container to resolve the formatter dependency: |
||
| 487 | * |
||
| 488 | * ```php |
||
| 489 | * $formatString = function($string, \yii\i18n\Formatter $formatter) { |
||
| 490 | * // ... |
||
| 491 | * } |
||
| 492 | * Yii::$container->invoke($formatString, ['string' => 'Hello World!']); |
||
| 493 | * ``` |
||
| 494 | * |
||
| 495 | * This will pass the string `'Hello World!'` as the first param, and a formatter instance created |
||
| 496 | * by the DI container as the second param to the callable. |
||
| 497 | * |
||
| 498 | * @param callable $callback callable to be invoked. |
||
| 499 | * @param array $params The array of parameters for the function. |
||
| 500 | * This can be either a list of parameters, or an associative array representing named function parameters. |
||
| 501 | * @return mixed the callback return value. |
||
| 502 | * @throws InvalidConfigException if a dependency cannot be resolved or if a dependency cannot be fulfilled. |
||
| 503 | * @throws NotInstantiableException If resolved to an abstract class or an interface (since 2.0.9) |
||
| 504 | * @since 2.0.7 |
||
| 505 | */ |
||
| 506 | 10 | public function invoke(callable $callback, $params = []) |
|
| 514 | |||
| 515 | /** |
||
| 516 | * Resolve dependencies for a function. |
||
| 517 | * |
||
| 518 | * This method can be used to implement similar functionality as provided by [[invoke()]] in other |
||
| 519 | * components. |
||
| 520 | * |
||
| 521 | * @param callable $callback callable to be invoked. |
||
| 522 | * @param array $params The array of parameters for the function, can be either numeric or associative. |
||
| 523 | * @return array The resolved dependencies. |
||
| 524 | * @throws InvalidConfigException if a dependency cannot be resolved or if a dependency cannot be fulfilled. |
||
| 525 | * @throws NotInstantiableException If resolved to an abstract class or an interface (since 2.0.9) |
||
| 526 | * @since 2.0.7 |
||
| 527 | */ |
||
| 528 | 11 | public function resolveCallableDependencies(callable $callback, $params = []) |
|
| 529 | { |
||
| 530 | 11 | if (is_array($callback)) { |
|
| 531 | 2 | $reflection = new \ReflectionMethod($callback[0], $callback[1]); |
|
| 532 | 11 | } elseif (is_object($callback) && !$callback instanceof \Closure) { |
|
| 533 | 1 | $reflection = new \ReflectionMethod($callback, '__invoke'); |
|
| 534 | } else { |
||
| 535 | 11 | $reflection = new \ReflectionFunction($callback); |
|
| 536 | } |
||
| 537 | |||
| 538 | 11 | $args = []; |
|
| 539 | |||
| 540 | 11 | $associative = ArrayHelper::isAssociative($params); |
|
| 541 | |||
| 542 | 11 | foreach ($reflection->getParameters() as $param) { |
|
| 543 | 6 | $name = $param->getName(); |
|
| 544 | 6 | if (($class = $param->getClass()) !== null) { |
|
| 545 | 4 | $className = $class->getName(); |
|
| 546 | 4 | if (version_compare(PHP_VERSION, '5.6.0', '>=') && $param->isVariadic()) { |
|
| 547 | 1 | $args = array_merge($args, array_values($params)); |
|
| 548 | 1 | break; |
|
| 549 | 3 | } elseif ($associative && isset($params[$name]) && $params[$name] instanceof $className) { |
|
| 550 | $args[] = $params[$name]; |
||
| 551 | unset($params[$name]); |
||
| 552 | 3 | } elseif (!$associative && isset($params[0]) && $params[0] instanceof $className) { |
|
| 553 | 1 | $args[] = array_shift($params); |
|
| 554 | 3 | } elseif (isset(Yii::$app) && Yii::$app->has($name) && ($obj = Yii::$app->get($name)) instanceof $className) { |
|
| 555 | 1 | $args[] = $obj; |
|
| 556 | } else { |
||
| 557 | // If the argument is optional we catch not instantiable exceptions |
||
| 558 | try { |
||
| 559 | 3 | $args[] = $this->get($className); |
|
| 560 | 1 | } catch (NotInstantiableException $e) { |
|
| 561 | 1 | if ($param->isDefaultValueAvailable()) { |
|
| 562 | 1 | $args[] = $param->getDefaultValue(); |
|
| 563 | } else { |
||
| 564 | 3 | throw $e; |
|
| 565 | } |
||
| 566 | } |
||
| 567 | } |
||
| 568 | 4 | } elseif ($associative && isset($params[$name])) { |
|
| 569 | 2 | $args[] = $params[$name]; |
|
| 570 | 2 | unset($params[$name]); |
|
| 571 | 4 | } elseif (!$associative && count($params)) { |
|
| 572 | 3 | $args[] = array_shift($params); |
|
| 573 | 3 | } elseif ($param->isDefaultValueAvailable()) { |
|
| 574 | 3 | $args[] = $param->getDefaultValue(); |
|
| 575 | 1 | } elseif (!$param->isOptional()) { |
|
| 576 | $funcName = $reflection->getName(); |
||
| 577 | 5 | throw new InvalidConfigException("Missing required parameter \"$name\" when calling \"$funcName\"."); |
|
| 578 | } |
||
| 579 | } |
||
| 580 | |||
| 581 | 11 | foreach ($params as $value) { |
|
| 582 | $args[] = $value; |
||
| 583 | } |
||
| 584 | |||
| 585 | 11 | return $args; |
|
| 586 | } |
||
| 587 | |||
| 588 | /** |
||
| 589 | * Registers class definitions within this container. |
||
| 590 | * |
||
| 591 | * @param array $definitions array of definitions. There are two allowed formats of array. |
||
| 592 | * The first format: |
||
| 593 | * - key: class name, interface name or alias name. The key will be passed to the [[set()]] method |
||
| 594 | * as a first argument `$class`. |
||
| 595 | * - value: the definition associated with `$class`. Possible values are described in |
||
| 596 | * [[set()]] documentation for the `$definition` parameter. Will be passed to the [[set()]] method |
||
| 597 | * as the second argument `$definition`. |
||
| 598 | * |
||
| 599 | * Example: |
||
| 600 | * ```php |
||
| 601 | * $container->setDefinitions([ |
||
| 602 | * 'yii\web\Request' => 'app\components\Request', |
||
| 603 | * 'yii\web\Response' => [ |
||
| 604 | * 'class' => 'app\components\Response', |
||
| 605 | * 'format' => 'json' |
||
| 606 | * ], |
||
| 607 | * 'foo\Bar' => function () { |
||
| 608 | * $qux = new Qux; |
||
| 609 | * $foo = new Foo($qux); |
||
| 610 | * return new Bar($foo); |
||
| 611 | * } |
||
| 612 | * ]); |
||
| 613 | * ``` |
||
| 614 | * |
||
| 615 | * The second format: |
||
| 616 | * - key: class name, interface name or alias name. The key will be passed to the [[set()]] method |
||
| 617 | * as a first argument `$class`. |
||
| 618 | * - value: array of two elements. The first element will be passed the [[set()]] method as the |
||
| 619 | * second argument `$definition`, the second one — as `$params`. |
||
| 620 | * |
||
| 621 | * Example: |
||
| 622 | * ```php |
||
| 623 | * $container->setDefinitions([ |
||
| 624 | * 'foo\Bar' => [ |
||
| 625 | * ['class' => 'app\Bar'], |
||
| 626 | * [Instance::of('baz')] |
||
| 627 | * ] |
||
| 628 | * ]); |
||
| 629 | * ``` |
||
| 630 | * |
||
| 631 | * @see set() to know more about possible values of definitions |
||
| 632 | * @since 2.0.11 |
||
| 633 | */ |
||
| 634 | 2 | public function setDefinitions(array $definitions) |
|
| 645 | |||
| 646 | /** |
||
| 647 | * Registers class definitions as singletons within this container by calling [[setSingleton()]]. |
||
| 648 | * |
||
| 649 | * @param array $singletons array of singleton definitions. See [[setDefinitions()]] |
||
| 650 | * for allowed formats of array. |
||
| 651 | * |
||
| 652 | * @see setDefinitions() for allowed formats of $singletons parameter |
||
| 653 | * @see setSingleton() to know more about possible values of definitions |
||
| 654 | * @since 2.0.11 |
||
| 655 | */ |
||
| 656 | 1 | public function setSingletons(array $singletons) |
|
| 667 | } |
||
| 668 |
Loading history...
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: