Swift_DependencyContainer::withDependencies() - Code Metrics - voku/swiftmailer - Measure and Improve Code Quality continuously with Scrutinizer

Swift_DependencyContainer::withDependencies() A
last analyzed 2017-12-05 09:25 UTC

↳ Parent: Swift_DependencyContainer

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	1
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
ccs	7
cts	7
cp	1
crap	2

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Dependency Injection container.
 *
 * @author Chris Corbyn
 */
class Swift_DependencyContainer
namespace YourVendor;

class YourClass { }
{
    /**
     * Constant for literal value types
     */
    const TYPE_VALUE = 0x0001;

    /**
     * Constant for new instance types
     */
    const TYPE_INSTANCE = 0x0010;

    /**
     * Constant for shared instance types
     */
    const TYPE_SHARED = 0x0100;

    /**
     * Constant for aliases
     */
    const TYPE_ALIAS = 0x1000;

    /**
     * Singleton instance
     *
     * @var null|self
     */
    private static $_instance = null;

    /**
     * The data container
     *
     * @var array
     */
    private $_store = array();

    /**
     * The current endpoint in the data container
     */
    private $_endPoint;

    /**
     * Constructor should not be used.
     *
     * Use {@link getInstance()} instead.
     */
    public function __construct()
    {
    }

    /**
     * Returns a singleton of the DependencyContainer.
     *
     * @return self
     */
    public static function getInstance()
    {
        if (!isset(self::$_instance)) {
            self::$_instance = new self();
        }

        return self::$_instance;
    }

    /**
     * List the names of all items stored in the Container.
     *
     * @return array
     */
    public function listItems()
    {
        return array_keys($this->_store);
    }

    /**
     * Test if an item is registered in this container with the given name.
     *
     * @see register()
     *
     * @param string $itemName
     *
     * @return bool
     */
    public function has($itemName)
    {
        return isset($this->_store[$itemName]) && isset($this->_store[$itemName]['lookupType']);
    }

    /**
     * Lookup the item with the given $itemName.
     *
     * @see register()
     *
     * @param string $itemName
     *
     * @throws Swift_DependencyException If the dependency is not found
     *
     * @return mixed
     */
    public function lookup($itemName)
    {
        if (!$this->has($itemName)) {
            throw new Swift_DependencyException(
                'Cannot lookup dependency "' . $itemName . '" since it is not registered.'
            );
        }

        switch ($this->_store[$itemName]['lookupType']) {
            case self::TYPE_ALIAS:
                return $this->_createAlias($itemName);
            case self::TYPE_VALUE:
                return $this->_getValue($itemName);
            case self::TYPE_INSTANCE:
                return $this->_createNewInstance($itemName);
            case self::TYPE_SHARED:
                return $this->_createSharedInstance($itemName);
        }
    }

    /**
     * Create an array of arguments passed to the constructor of $itemName.
     *
     * @param string $itemName
     *
     * @return array
     */
    public function createDependenciesFor($itemName)
    {
        $args = array();
        if (isset($this->_store[$itemName]['args'])) {
            $args = $this->_resolveArgs($this->_store[$itemName]['args']);
        }

        return $args;
    }

    /**
     * Register a new dependency with $itemName.
     *
     * This method returns the current DependencyContainer instance because it
     * requires the use of the fluid interface to set the specific details for the
     * dependency.
     *
     * @see asNewInstanceOf(), asSharedInstanceOf(), asValue()
     *
     * @param string $itemName
     *
     * @return $this
     */
    public function register($itemName)
    {
        $this->_store[$itemName] = array();
        $this->_endPoint = &$this->_store[$itemName];

        return $this;
    }

    /**
     * Specify the previously registered item as a literal value.
     *
     * {@link register()} must be called before this will work.
     *
     * @param mixed $value
     *
     * @return $this
     */
    public function asValue($value)
    {
        $endPoint = &$this->_getEndPoint();
        $endPoint['lookupType'] = self::TYPE_VALUE;
        $endPoint['value'] = $value;

        return $this;
    }

    /**
     * Specify the previously registered item as an alias of another item.
     *
     * @param string $lookup
     *
     * @return $this
     */
    public function asAliasOf($lookup)
    {
        $endPoint = &$this->_getEndPoint();
        $endPoint['lookupType'] = self::TYPE_ALIAS;
        $endPoint['ref'] = $lookup;

        return $this;
    }

    /**
     * Specify the previously registered item as a new instance of $className.
     *
     * {@link register()} must be called before this will work.
     * Any arguments can be set with {@link withDependencies()},
     * {@link addConstructorValue()} or {@link addConstructorLookup()}.
     *
     * @see withDependencies(), addConstructorValue(), addConstructorLookup()
     *
     * @param string $className
     *
     * @return $this
     */
    public function asNewInstanceOf($className)

    {
        $endPoint = &$this->_getEndPoint();
        $endPoint['lookupType'] = self::TYPE_INSTANCE;
        $endPoint['className'] = $className;

        return $this;
    }

    /**
     * Specify the previously registered item as a shared instance of $className.
     *
     * {@link register()} must be called before this will work.
     *
     * @param string $className
     *
     * @return $this
     */
    public function asSharedInstanceOf($className)

    {
        $endPoint = &$this->_getEndPoint();
        $endPoint['lookupType'] = self::TYPE_SHARED;
        $endPoint['className'] = $className;

        return $this;
    }

    /**
     * Specify a list of injected dependencies for the previously registered item.
     *
     * This method takes an array of lookup names.
     *
     * @see addConstructorValue(), addConstructorLookup()
     *
     * @param array $lookups
     *
     * @return $this
     */
    public function withDependencies(array $lookups)
    {
        $endPoint = &$this->_getEndPoint();
        $endPoint['args'] = array();
        foreach ($lookups as $lookup) {
            $this->addConstructorLookup($lookup);
        }

        return $this;
    }

    /**
     * Specify a literal (non looked up) value for the constructor of the
     * previously registered item.
     *
     * @see withDependencies(), addConstructorLookup()
     *
     * @param mixed $value
     *
     * @return $this
     */
    public function addConstructorValue($value)

    {
        $endPoint = &$this->_getEndPoint();
        if (!isset($endPoint['args'])) {
            $endPoint['args'] = array();
        }
        $endPoint['args'][] = array('type' => 'value', 'item' => $value);

        return $this;
    }

    /**
     * Specify a dependency lookup for the constructor of the previously
     * registered item.
     *
     * @see withDependencies(), addConstructorValue()
     *
     * @param string $lookup
     *
     * @return $this
     */
    public function addConstructorLookup($lookup)

    {
        $endPoint = &$this->_getEndPoint();
        if (!isset($this->_endPoint['args'])) {
            $endPoint['args'] = array();
        }
        $endPoint['args'][] = array('type' => 'lookup', 'item' => $lookup);

        return $this;
    }

    /**
     * Get the literal value with $itemName
     *
     * @param $itemName
     *
     * @return mixed
     */
    private function _getValue($itemName)
    {
        return $this->_store[$itemName]['value'];
    }

    /**
     * Resolve an alias to another item
     *
     * @param $itemName
     *
     * @return mixed
     * @throws Swift_DependencyException
     */
    private function _createAlias($itemName)
    {
        return $this->lookup($this->_store[$itemName]['ref']);
    }

    /** Create a fresh instance of $itemName */
    private function _createNewInstance($itemName)
    {
        $reflector = new ReflectionClass($this->_store[$itemName]['className']);
        if ($reflector->getConstructor()) {
            return $reflector->newInstanceArgs(
                $this->createDependenciesFor($itemName)
            );
        }

        return $reflector->newInstance();
    }

    /**
     * Create and register a shared instance of $itemName
     *
     * @param $itemName
     *
     * @return mixed
     */
    private function _createSharedInstance($itemName)
    {
        if (!isset($this->_store[$itemName]['instance'])) {
            $this->_store[$itemName]['instance'] = $this->_createNewInstance($itemName);
        }

        return $this->_store[$itemName]['instance'];
    }

    /**
     * Get the current endpoint in the store
     *
     * @return mixed
     */
    private function &_getEndPoint()
    {
        if (!isset($this->_endPoint)) {
            throw new BadMethodCallException(
                'Component must first be registered by calling register()'
            );
        }

        return $this->_endPoint;
    }

    /**
     * Get an argument list with dependencies resolved
     *
     * @param array $args
     *
     * @return array
     */
    private function _resolveArgs(array $args)
    {
        $resolved = array();
        foreach ($args as $argDefinition) {
            switch ($argDefinition['type']) {
                case 'lookup':
                    $resolved[] = $this->_lookupRecursive($argDefinition['item']);
                    break;
                case 'value':
                    $resolved[] = $argDefinition['item'];
                    break;
            }
        }

        return $resolved;
    }

    /** Resolve a single dependency with an collections */
    private function _lookupRecursive($item)
    {
        if (is_array($item)) {
            $collection = array();
            foreach ($item as $k => $v) {
                $collection[$k] = $this->_lookupRecursive($v);
            }

            return $collection;
        }

        return $this->lookup($item);
    }
}


1			<?php
2
3			/*
4			* This file is part of SwiftMailer.
5			* (c) 2004-2009 Chris Corbyn
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			/**
12			* Dependency Injection container.
13			*
14			* @author Chris Corbyn
15			*/
16			class Swift_DependencyContainer
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17			{
18			/**
19			* Constant for literal value types
20			*/
21			const TYPE_VALUE = 0x0001;
22
23			/**
24			* Constant for new instance types
25			*/
26			const TYPE_INSTANCE = 0x0010;
27
28			/**
29			* Constant for shared instance types
30			*/
31			const TYPE_SHARED = 0x0100;
32
33			/**
34			* Constant for aliases
35			*/
36			const TYPE_ALIAS = 0x1000;
37
38			/**
39			* Singleton instance
40			*
41			* @var null\|self
42			*/
43			private static $_instance = null;
44
45			/**
46			* The data container
47			*
48			* @var array
49			*/
50			private $_store = array();
51
52			/**
53			* The current endpoint in the data container
54			*/
55			private $_endPoint;
56
57			/**
58			* Constructor should not be used.
59			*
60			* Use {@link getInstance()} instead.
61			*/
62	18		public function __construct()
63			{
64	18		}
65
66			/**
67			* Returns a singleton of the DependencyContainer.
68			*
69			* @return self
70			*/
71	175		public static function getInstance()
72			{
73	175		if (!isset(self::$_instance)) {
74			self::$_instance = new self();
75			}
76
77	175		return self::$_instance;
78			}
79
80			/**
81			* List the names of all items stored in the Container.
82			*
83			* @return array
84			*/
85	1		public function listItems()
86			{
87	1		return array_keys($this->_store);
88			}
89
90			/**
91			* Test if an item is registered in this container with the given name.
92			*
93			* @see register()
94			*
95			* @param string $itemName
96			*
97			* @return bool
98			*/
99	192		public function has($itemName)
100			{
101	192		return isset($this->_store[$itemName]) && isset($this->_store[$itemName]['lookupType']);
102			}
103
104			/**
105			* Lookup the item with the given $itemName.
106			*
107			* @see register()
108			*
109			* @param string $itemName
110			*
111			* @throws Swift_DependencyException If the dependency is not found
112			*
113			* @return mixed
114			*/
115	188		public function lookup($itemName)
116			{
117	188		if (!$this->has($itemName)) {
118			throw new Swift_DependencyException(
119			'Cannot lookup dependency "' . $itemName . '" since it is not registered.'
120			);
121			}
122
123	188		switch ($this->_store[$itemName]['lookupType']) {
124	188		case self::TYPE_ALIAS:
125	164		return $this->_createAlias($itemName);
126	188		case self::TYPE_VALUE:
127	172		return $this->_getValue($itemName);
128	185		case self::TYPE_INSTANCE:
129	182		return $this->_createNewInstance($itemName);
130	173		case self::TYPE_SHARED:
131	173		return $this->_createSharedInstance($itemName);
132			}
133			}
134
135			/**
136			* Create an array of arguments passed to the constructor of $itemName.
137			*
138			* @param string $itemName
139			*
140			* @return array
141			*/
142	184		public function createDependenciesFor($itemName)
143			{
144	184		$args = array();
145	184		if (isset($this->_store[$itemName]['args'])) {
146	180		$args = $this->_resolveArgs($this->_store[$itemName]['args']);
147	180		}
148
149	184		return $args;
150			}
151
152			/**
153			* Register a new dependency with $itemName.
154			*
155			* This method returns the current DependencyContainer instance because it
156			* requires the use of the fluid interface to set the specific details for the
157			* dependency.
158			*
159			* @see asNewInstanceOf(), asSharedInstanceOf(), asValue()
160			*
161			* @param string $itemName
162			*
163			* @return $this
164			*/
165	145		public function register($itemName)
166			{
167	145		$this->_store[$itemName] = array();
168	145		$this->_endPoint = &$this->_store[$itemName];
169
170	145		return $this;
171			}
172
173			/**
174			* Specify the previously registered item as a literal value.
175			*
176			* {@link register()} must be called before this will work.
177			*
178			* @param mixed $value
179			*
180			* @return $this
181			*/
182	130		public function asValue($value)
183			{
184	130		$endPoint = &$this->_getEndPoint();
185	130		$endPoint['lookupType'] = self::TYPE_VALUE;
186	130		$endPoint['value'] = $value;
187
188	130		return $this;
189			}
190
191			/**
192			* Specify the previously registered item as an alias of another item.
193			*
194			* @param string $lookup
195			*
196			* @return $this
197			*/
198	2		public function asAliasOf($lookup)
199			{
200	2		$endPoint = &$this->_getEndPoint();
201	2		$endPoint['lookupType'] = self::TYPE_ALIAS;
202	2		$endPoint['ref'] = $lookup;
203
204	2		return $this;
205			}
206
207			/**
208			* Specify the previously registered item as a new instance of $className.
209			*
210			* {@link register()} must be called before this will work.
211			* Any arguments can be set with {@link withDependencies()},
212			* {@link addConstructorValue()} or {@link addConstructorLookup()}.
213			*
214			* @see withDependencies(), addConstructorValue(), addConstructorLookup()
215			*
216			* @param string $className
217			*
218			* @return $this
219			*/
220	18	View Code Duplication	public function asNewInstanceOf($className)
			0 ignored issues – show Duplication introduced 2017-09-21 08:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
221			{
222	18		$endPoint = &$this->_getEndPoint();
223	18		$endPoint['lookupType'] = self::TYPE_INSTANCE;
224	18		$endPoint['className'] = $className;
225
226	18		return $this;
227			}
228
229			/**
230			* Specify the previously registered item as a shared instance of $className.
231			*
232			* {@link register()} must be called before this will work.
233			*
234			* @param string $className
235			*
236			* @return $this
237			*/
238	3	View Code Duplication	public function asSharedInstanceOf($className)
			0 ignored issues – show Duplication introduced 2017-09-21 08:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
239			{
240	3		$endPoint = &$this->_getEndPoint();
241	3		$endPoint['lookupType'] = self::TYPE_SHARED;
242	3		$endPoint['className'] = $className;
243
244	3		return $this;
245			}
246
247			/**
248			* Specify a list of injected dependencies for the previously registered item.
249			*
250			* This method takes an array of lookup names.
251			*
252			* @see addConstructorValue(), addConstructorLookup()
253			*
254			* @param array $lookups
255			*
256			* @return $this
257			*/
258	13		public function withDependencies(array $lookups)
259			{
260	13		$endPoint = &$this->_getEndPoint();
261	13		$endPoint['args'] = array();
262	13		foreach ($lookups as $lookup) {
263	13		$this->addConstructorLookup($lookup);
264	13		}
265
266	13		return $this;
267			}
268
269			/**
270			* Specify a literal (non looked up) value for the constructor of the
271			* previously registered item.
272			*
273			* @see withDependencies(), addConstructorLookup()
274			*
275			* @param mixed $value
276			*
277			* @return $this
278			*/
279	9	View Code Duplication	public function addConstructorValue($value)
			0 ignored issues – show Duplication introduced 2017-09-21 08:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
280			{
281	9		$endPoint = &$this->_getEndPoint();
282	9		if (!isset($endPoint['args'])) {
283	1		$endPoint['args'] = array();
284	1		}
285	9		$endPoint['args'][] = array('type' => 'value', 'item' => $value);
286
287	9		return $this;
288			}
289
290			/**
291			* Specify a dependency lookup for the constructor of the previously
292			* registered item.
293			*
294			* @see withDependencies(), addConstructorValue()
295			*
296			* @param string $lookup
297			*
298			* @return $this
299			*/
300	14	View Code Duplication	public function addConstructorLookup($lookup)
			0 ignored issues – show Duplication introduced 2017-09-21 08:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
301			{
302	14		$endPoint = &$this->_getEndPoint();
303	14		if (!isset($this->_endPoint['args'])) {
304	1		$endPoint['args'] = array();
305	1		}
306	14		$endPoint['args'][] = array('type' => 'lookup', 'item' => $lookup);
307
308	14		return $this;
309			}
310
311			/**
312			* Get the literal value with $itemName
313			*
314			* @param $itemName
315			*
316			* @return mixed
317			*/
318	172		private function _getValue($itemName)
319			{
320	172		return $this->_store[$itemName]['value'];
321			}
322
323			/**
324			* Resolve an alias to another item
325			*
326			* @param $itemName
327			*
328			* @return mixed
329			* @throws Swift_DependencyException
330			*/
331	164		private function _createAlias($itemName)
332			{
333	164		return $this->lookup($this->_store[$itemName]['ref']);
334			}
335
336			/** Create a fresh instance of $itemName */
337	184		private function _createNewInstance($itemName)
338			{
339	184		$reflector = new ReflectionClass($this->_store[$itemName]['className']);
340	184		if ($reflector->getConstructor()) {
341	184		return $reflector->newInstanceArgs(
342	184		$this->createDependenciesFor($itemName)
343	184		);
344			}
345
346	170		return $reflector->newInstance();
347			}
348
349			/**
350			* Create and register a shared instance of $itemName
351			*
352			* @param $itemName
353			*
354			* @return mixed
355			*/
356	173		private function _createSharedInstance($itemName)
357			{
358	173		if (!isset($this->_store[$itemName]['instance'])) {
359	6		$this->_store[$itemName]['instance'] = $this->_createNewInstance($itemName);
360	6		}
361
362	173		return $this->_store[$itemName]['instance'];
363			}
364
365			/**
366			* Get the current endpoint in the store
367			*
368			* @return mixed
369			*/
370	145		private function &_getEndPoint()
371			{
372	145		if (!isset($this->_endPoint)) {
373			throw new BadMethodCallException(
374			'Component must first be registered by calling register()'
375			);
376			}
377
378	145		return $this->_endPoint;
379			}
380
381			/**
382			* Get an argument list with dependencies resolved
383			*
384			* @param array $args
385			*
386			* @return array
387			*/
388	180		private function _resolveArgs(array $args)
389			{
390	180		$resolved = array();
391	180		foreach ($args as $argDefinition) {
392	180		switch ($argDefinition['type']) {
393	180		case 'lookup':
394	177		$resolved[] = $this->_lookupRecursive($argDefinition['item']);
395	177		break;
396	173		case 'value':
397	173		$resolved[] = $argDefinition['item'];
398	173		break;
399	180		}
400	180		}
401
402	180		return $resolved;
403			}
404
405			/** Resolve a single dependency with an collections */
406	177		private function _lookupRecursive($item)
407			{
408	177		if (is_array($item)) {
409	6		$collection = array();
410	6		foreach ($item as $k => $v) {
411	6		$collection[$k] = $this->_lookupRecursive($v);
412	6		}
413
414	6		return $collection;
415			}
416
417	177		return $this->lookup($item);
418			}
419			}
420

voku / swiftmailer

Swift_DependencyContainer::withDependencies() A last analyzed 2017-12-05 09:25 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Swift_DependencyContainer::withDependencies() A
last analyzed 2017-12-05 09:25 UTC