Instance::get() - Code Metrics - Inspection of "Additional updated to phpunit6" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — php7-remove-phpunit-compat ( b957db...533a50 )

by Alexander

created 2017-07-21 17:20 UTC

Instance::get() A

↳ Parent: Instance

Complexity

Conditions	4
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	6
nc	3
nop	1
crap	4

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\di;

use Yii;
use yii\base\InvalidConfigException;

/**
 * Instance represents a reference to a named object in a dependency injection (DI) container or a service locator.
 *
 * You may use [[get()]] to obtain the actual object referenced by [[id]].
 *
 * Instance is mainly used in two places:
 *
 * - When configuring a dependency injection container, you use Instance to reference a class name, interface name
 *   or alias name. The reference can later be resolved into the actual object by the container.
 * - In classes which use service locator to obtain dependent objects.
 *
 * The following example shows how to configure a DI container with Instance:
 *
 * ```php
 * $container = new \yii\di\Container;
 * $container->set('cache', [
 *     'class' => \yii\caching\DbCache::class,
 *     'db' => Instance::of('db')
 * ]);
 * $container->set('db', [
 *     'class' => \yii\db\Connection::class,
 *     'dsn' => 'sqlite:path/to/file.db',
 * ]);
 * ```
 *
 * And the following example shows how a class retrieves a component from a service locator:
 *
 * ```php
 * class DbCache extends Cache
 * {
 *     public $db = 'db';
 *
 *     public function init()
 *     {
 *         parent::init();
 *         $this->db = Instance::ensure($this->db, \yii\db\Connection::class);
 *     }
 * }
 * ```
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class Instance
{
    /**
     * @var string the component ID, class name, interface name or alias name
     */
    public $id;


    /**
     * Constructor.
     * @param string $id the component ID
     */
    protected function __construct($id)
    {
        $this->id = $id;
    }

    /**
     * Creates a new Instance object.
     * @param string $id the component ID
     * @return Instance the new Instance object.
     */
    public static function of($id)
    {
        return new static($id);
    }

    /**
     * Resolves the specified reference into the actual object and makes sure it is of the specified type.
     *
     * The reference may be specified as a string or an Instance object. If the former,
     * it will be treated as a component ID, a class/interface name or an alias, depending on the container type.
     *
     * If you do not specify a container, the method will first try `Yii::$app` followed by `Yii::$container`.
     *
     * For example,
     *
     * ```php
     * use yii\db\Connection;
     *
     * // returns Yii::$app->db
     * $db = Instance::ensure('db', Connection::class);
     * // returns an instance of Connection using the given configuration
     * $db = Instance::ensure(['dsn' => 'sqlite:path/to/my.db'], Connection::class);
     * ```
     *
     * @param object|string|array|static $reference an object or a reference to the desired object.
     * You may specify a reference in terms of a component ID or an Instance object.
     * Starting from version 2.0.2, you may also pass in a configuration array for creating the object.
     * If the "class" value is not specified in the configuration array, it will use the value of `$type`.
     * @param string $type the class/interface name to be checked. If null, type check will not be performed.
     * @param ServiceLocator|Container $container the container. This will be passed to [[get()]].
     * @return object the object referenced by the Instance, or `$reference` itself if it is an object.
     * @throws InvalidConfigException if the reference is invalid
     */
    public static function ensure($reference, $type = null, $container = null)
    {
        if (is_array($reference)) {
            $class = isset($reference['class']) ? $reference['class'] : $type;
            if (!$container instanceof Container) {
                $container = Yii::$container;
            }
            unset($reference['class']);
            $component = $container->get($class, [], $reference);
            if ($type === null || $component instanceof $type) {
                return $component;
            }

            throw new InvalidConfigException('Invalid data type: ' . $class . '. ' . $type . ' is expected.');
        } elseif (empty($reference)) {
            throw new InvalidConfigException('The required component is not specified.');
        }

        if (is_string($reference)) {
            $reference = new static($reference);
        } elseif ($type === null || $reference instanceof $type) {
            return $reference;
        }

        if ($reference instanceof self) {
            try {
                $component = $reference->get($container);
            } catch (\ReflectionException $e) {
                throw new InvalidConfigException('Failed to instantiate component or class "' . $reference->id . '".', 0, $e);
            }
            if ($type === null || $component instanceof $type) {
                return $component;
            }

            throw new InvalidConfigException('"' . $reference->id . '" refers to a ' . get_class($component) . " component. $type is expected.");
        }

        $valueType = is_object($reference) ? get_class($reference) : gettype($reference);
        throw new InvalidConfigException("Invalid data type: $valueType. $type is expected.");
    }

    /**
     * Returns the actual object referenced by this Instance object.
     * @param ServiceLocator|Container $container the container used to locate the referenced object.
     * If null, the method will first try `Yii::$app` then `Yii::$container`.
     * @return object the actual object referenced by this Instance object.
     */
    public function get($container = null)
    {
        if ($container) {
            return $container->get($this->id);
        }
        if (Yii::$app && Yii::$app->has($this->id)) {
            return Yii::$app->get($this->id);
        }

        return Yii::$container->get($this->id);
    }

    /**
     * Restores class state after using `var_export()`
     *
     * @param array $state
     * @return Instance
     * @throws InvalidConfigException when $state property does not contain `id` parameter
     * @see var_export()
     * @since 2.0.12
     */
    public static function __set_state($state)
    {
        if (!isset($state['id'])) {
            throw new InvalidConfigException('Failed to instantiate class "Instance". Required parameter "id" is missing');
        }

        return new self($state['id']);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\di;
9
10		use Yii;
11		use yii\base\InvalidConfigException;
12
13		/**
14		* Instance represents a reference to a named object in a dependency injection (DI) container or a service locator.
15		*
16		* You may use [[get()]] to obtain the actual object referenced by [[id]].
17		*
18		* Instance is mainly used in two places:
19		*
20		* - When configuring a dependency injection container, you use Instance to reference a class name, interface name
21		* or alias name. The reference can later be resolved into the actual object by the container.
22		* - In classes which use service locator to obtain dependent objects.
23		*
24		* The following example shows how to configure a DI container with Instance:
25		*
26		* ```php
27		* $container = new \yii\di\Container;
28		* $container->set('cache', [
29		* 'class' => \yii\caching\DbCache::class,
30		* 'db' => Instance::of('db')
31		* ]);
32		* $container->set('db', [
33		* 'class' => \yii\db\Connection::class,
34		* 'dsn' => 'sqlite:path/to/file.db',
35		* ]);
36		* ```
37		*
38		* And the following example shows how a class retrieves a component from a service locator:
39		*
40		* ```php
41		* class DbCache extends Cache
42		* {
43		* public $db = 'db';
44		*
45		* public function init()
46		* {
47		* parent::init();
48		* $this->db = Instance::ensure($this->db, \yii\db\Connection::class);
49		* }
50		* }
51		* ```
52		*
53		* @author Qiang Xue <[email protected]>
54		* @since 2.0
55		*/
56		class Instance
57		{
58		/**
59		* @var string the component ID, class name, interface name or alias name
60		*/
61		public $id;
62
63
64		/**
65		* Constructor.
66		* @param string $id the component ID
67		*/
68	75	protected function __construct($id)
69		{
70	75	$this->id = $id;
71	75	}
72
73		/**
74		* Creates a new Instance object.
75		* @param string $id the component ID
76		* @return Instance the new Instance object.
77		*/
78	21	public static function of($id)
79		{
80	21	return new static($id);
81		}
82
83		/**
84		* Resolves the specified reference into the actual object and makes sure it is of the specified type.
85		*
86		* The reference may be specified as a string or an Instance object. If the former,
87		* it will be treated as a component ID, a class/interface name or an alias, depending on the container type.
88		*
89		* If you do not specify a container, the method will first try `Yii::$app` followed by `Yii::$container`.
90		*
91		* For example,
92		*
93		* ```php
94		* use yii\db\Connection;
95		*
96		* // returns Yii::$app->db
97		* $db = Instance::ensure('db', Connection::class);
98		* // returns an instance of Connection using the given configuration
99		* $db = Instance::ensure(['dsn' => 'sqlite:path/to/my.db'], Connection::class);
100		* ```
101		*
102		* @param object\|string\|array\|static $reference an object or a reference to the desired object.
103		* You may specify a reference in terms of a component ID or an Instance object.
104		* Starting from version 2.0.2, you may also pass in a configuration array for creating the object.
105		* If the "class" value is not specified in the configuration array, it will use the value of `$type`.
106		* @param string $type the class/interface name to be checked. If null, type check will not be performed.
107		* @param ServiceLocator\|Container $container the container. This will be passed to [[get()]].
108		* @return object the object referenced by the Instance, or `$reference` itself if it is an object.
109		* @throws InvalidConfigException if the reference is invalid
110		*/
111	242	public static function ensure($reference, $type = null, $container = null)
112		{
113	242	if (is_array($reference)) {
114	4	$class = isset($reference['class']) ? $reference['class'] : $type;
115	4	if (!$container instanceof Container) {
116	2	$container = Yii::$container;
117		}
118	4	unset($reference['class']);
119	4	$component = $container->get($class, [], $reference);
120	4	if ($type === null \|\| $component instanceof $type) {
121	3	return $component;
122		}
123
124	1	throw new InvalidConfigException('Invalid data type: ' . $class . '. ' . $type . ' is expected.');
125		} elseif (empty($reference)) {
126	1	throw new InvalidConfigException('The required component is not specified.');
127		}
128
129	240	if (is_string($reference)) {
130	54	$reference = new static($reference);
131	213	} elseif ($type === null \|\| $reference instanceof $type) {
132	210	return $reference;
133		}
134
135	57	if ($reference instanceof self) {
136		try {
137	56	$component = $reference->get($container);
138	3	} catch (\ReflectionException $e) {
139	3	throw new InvalidConfigException('Failed to instantiate component or class "' . $reference->id . '".', 0, $e);
140		}
141	53	if ($type === null \|\| $component instanceof $type) {
142	52	return $component;
143		}
144
145	1	throw new InvalidConfigException('"' . $reference->id . '" refers to a ' . get_class($component) . " component. $type is expected.");
146		}
147
148	1	$valueType = is_object($reference) ? get_class($reference) : gettype($reference);
149	1	throw new InvalidConfigException("Invalid data type: $valueType. $type is expected.");
150		}
151
152		/**
153		* Returns the actual object referenced by this Instance object.
154		* @param ServiceLocator\|Container $container the container used to locate the referenced object.
155		* If null, the method will first try `Yii::$app` then `Yii::$container`.
156		* @return object the actual object referenced by this Instance object.
157		*/
158	57	public function get($container = null)
159		{
160	57	if ($container) {
161	6	return $container->get($this->id);
162		}
163	51	if (Yii::$app && Yii::$app->has($this->id)) {
164	47	return Yii::$app->get($this->id);
165		}
166
167	4	return Yii::$container->get($this->id);
168		}
169
170		/**
171		* Restores class state after using `var_export()`
172		*
173		* @param array $state
174		* @return Instance
175		* @throws InvalidConfigException when $state property does not contain `id` parameter
176		* @see var_export()
177		* @since 2.0.12
178		*/
179	2	public static function __set_state($state)
180		{
181	2	if (!isset($state['id'])) {
182	1	throw new InvalidConfigException('Failed to instantiate class "Instance". Required parameter "id" is missing');
183		}
184
185	1	return new self($state['id']);
186		}
187		}
188

yiisoft / yii2

Push — php7-remove-phpunit-compat ( b957db...533a50 )

Instance::get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like