Container::auto() - Code Metrics - Inspection of "updated README" - phossa2/di - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 98ccbf...73e071 )

by Hong

created 2016-07-13 09:11 UTC

Container::auto() A

↳ Parent: Container

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Di
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Di;

use Phossa2\Config\Config;
use Phossa2\Di\Message\Message;
use Phossa2\Di\Factory\Factory;
use Phossa2\Di\Resolver\Resolver;
use Phossa2\Di\Traits\ContainerTrait;
use Phossa2\Di\Traits\ArrayAccessTrait;
use Phossa2\Shared\Base\ObjectAbstract;
use Interop\Container\ContainerInterface;
use Phossa2\Di\Interfaces\ScopeInterface;
use Phossa2\Di\Exception\RuntimeException;
use Phossa2\Di\Exception\NotFoundException;
use Phossa2\Shared\Reference\DelegatorInterface;
use Phossa2\Config\Interfaces\WritableInterface;
use Phossa2\Di\Interfaces\FactoryAwareInterface;
use Phossa2\Di\Interfaces\ResolverAwareInterface;
use Phossa2\Shared\Reference\DelegatorAwareTrait;
use Phossa2\Di\Interfaces\ExtendedContainerInterface;
use Phossa2\Shared\Reference\DelegatorAwareInterface;

/**
 * Container
 *
 * A writable, array accessable, delegator-aware and extended instance container.
 *
 * - writable:
 *
 *   ```php
 *   $container->set('cache', $cache);
 *   ```
 *
 * - array accessable:
 *
 *   ```php
 *   // get
 *   $cache = $container['cache'];
 *
 *   // set/replace
 *   $container['cache'] = $anotherCache;
 *   ```
 *
 * - delegator-aware: lookup dependent instances in the delegator
 *
 *   ```php
 *   $delegator->addRegistry($container);
 *   ```
 *
 * - extended container
 *
 *   ```php
 *   // get new instance
 *   $newCache = $container->one('cache');
 *
 *   // run callables
 *   $container->run(['${#logger}', 'warning'], ['A warning message from ${user}']);
 *   ```
 *
 * @package Phossa2\Di
 * @author  Hong Zhang <[email protected]>
 * @see     ObjectAbstract
 * @see     ScopeInterface
 * @see     ContainerInterface
 * @see     ResolverAwareInterface
 * @see     FactoryAwareInterface
 * @see     ExtendedContainerInterface
 * @see     DelegatorAwareInterface
 * @see     WritableInterface
 * @see     \ArrayAccess
 * @version 2.0.0
 * @since   2.0.0 added
 */
class Container extends ObjectAbstract implements ContainerInterface, ResolverAwareInterface, FactoryAwareInterface, ScopeInterface, ExtendedContainerInterface, DelegatorAwareInterface, \ArrayAccess, WritableInterface
{
    use ContainerTrait, ArrayAccessTrait, DelegatorAwareTrait;

    /**
     * Inject a Phossa2\Config\Config
     *
     * ```php
     * $configData = [
     *     // container class
     *     'di.class' => 'Phossa2\\Di\\Container',
     *
     *     // container service definitions
     *     'di.service' => [
     *         // ...
     *     ],
     *
     *     // interface/classname mappings
     *     'di.mapping' => [
     *     ],
     *
     *     // init methods to run after container created
     *     'di.init' => [
     *         'default' => [],
     *         'mystuff' => [ ... ],
     *     ],
     * ];
     *
     * // instantiate $config
     * $config = new Config(null, null, $configData);
     *
     * // instantiate container
     * $container = new $config['di.class']($config);
     * ```
     *
     * @param  Config $config inject the config instance
     * @param  string $baseNode container's starting node in $config
     * @access public
     */
    public function __construct(
        Config $config = null,
        /*# string */ $baseNode = 'di'
    ) {
        $conf = $config ?: new Config();

        $this
            ->setResolver(new Resolver($this, $conf, $baseNode))
            ->setFactory(new Factory($this))
            ->registerObject('container', $this)
            ->registerObject('config', $conf)
            ->initContainer();
    }

    /**
     * Extensions to the Interop\Container\ContainerInterface
     *
     * - Accepting second param as object constructor arguments
     * - Accpeting $id with scope appended, e.g. 'cache@myScope'
     *
     * {@inheritDoc}
     */
    public function get($id)
    {
        // not found
        if (!$this->has($id)) {
            throw new NotFoundException(
                Message::get(Message::DI_SERVICE_NOTFOUND, $id),
                Message::DI_SERVICE_NOTFOUND
            );
        }

        // get the instance, constructor args if any
        return $this->getInstance(
            $id, func_num_args() > 1 ? func_get_arg(1) : []
        );
    }

    /**
     * Extensions to the Interop\Container\ContainerInterface
     *
     * - Accpeting $id with scope appended, e.g. 'cache@myScope'
     *
     * {@inheritDoc}
     */
    public function has($id)
    {
        if (is_string($id)) {
            return $this->getResolver()->hasService(
                $this->idWithoutScope($id)
            );
        }
        return false;
    }

    /**
     * {@inheritDoc}
     */
    public function set(/*# string */ $id, $value)
    {
        if ($this->isWritable()) {
            // set in service definition
            $this->getResolver()->setService(
                $this->idWithoutScope($id),
                $value
            );
            return $this;
        } else {
            throw new RuntimeException(
                Message::get(Message::DI_CONTAINER_READONLY, $id),
                Message::DI_CONTAINER_READONLY
            );
        }
    }

    /**
     * {@inheritDoc}
     */
    public function one(/*# string */ $id, array $arguments = [])
    {
        // set in single scope
        return $this->get(
            $this->scopedId($id, self::SCOPE_SINGLE),
            $arguments
        );
    }

    /**
     * {@inheritDoc}
     */
    public function run($callable, array $arguments = [])
    {
        // resolve any references in the callable(array) and arguments
        $this->resolve($callable);
        $this->resolve($arguments);

        return $this->getFactory()->executeCallable($callable, $arguments);
    }

    /**
     * {@inheritDoc}
     */
    public function map(/*# string */ $from, $to)
    {
        $this->getResolver()->setMapping($from, $to);
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function auto(/*# bool */ $on = true)
    {
        $this->getResolver()->autoWiring($on);
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function param(/*# string */ $name, $value)
    {
        $this->getResolver()->set((string) $name, $value);
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function resolve(&$toResolve)
    {
        $this->getResolver()->resolve($toResolve);
        return $this;
    }

    /**
     * Override `setDelegator()` from 'Phossa2\Shared\Reference\DelegatorAwareTrait'
     *
     * {@inheritDoc}
     */
    public function setDelegator(DelegatorInterface $delegator)
    {
        $this->delegator = $delegator;

        // this will make sure all dependencies will be looked up in the delegator
        $this->getResolver()->setObjectResolver();

        return $this;
    }

    /**
     * Override 'isWritable()' in 'Phossa2\Config\Traits\WritableTrait'
     *
     * Container's writability is depend on its resolver
     *
     * {@inheritDoc}
     */
    public function isWritable()/*# : bool */
    {
        return $this->getResolver()->isWritable();
    }

    /**
     * Register object in 'di.service' with $name
     *
     * e.g. `$this->registerObject('container', $this)`
     *
     * - Later, $this can be referenced as '${#container}' anywhere
     *
     * - $object will skip execute common methods for created instances.
     *
     *   instead of just do
     *      `$container->set($name, $object)`
     *
     *   you may do
     *      $container->set($name, ['class' => $object, 'skip' => true]);
     *
     * @param  string $name name to register with
     * @param  object $object
     * @return $this
     * @access protected
     */
    protected function registerObject(/*# string */ $name, $object)
    {
        if (!$this->has($name) && $this->isWritable()) {
            $this->set($name, ['class' => $object, 'skip' => true]);
        }
        return $this;
    }
}


1			<?php
2			/**
3			* Phossa Project
4			*
5			* PHP version 5.4
6			*
7			* @category Library
8			* @package Phossa2\Di
9			* @copyright Copyright (c) 2016 phossa.com
10			* @license http://mit-license.org/ MIT License
11			* @link http://www.phossa.com/
12			*/
13			/# declare(strict_types=1); /
14
15			namespace Phossa2\Di;
16
17			use Phossa2\Config\Config;
18			use Phossa2\Di\Message\Message;
19			use Phossa2\Di\Factory\Factory;
20			use Phossa2\Di\Resolver\Resolver;
21			use Phossa2\Di\Traits\ContainerTrait;
22			use Phossa2\Di\Traits\ArrayAccessTrait;
23			use Phossa2\Shared\Base\ObjectAbstract;
24			use Interop\Container\ContainerInterface;
25			use Phossa2\Di\Interfaces\ScopeInterface;
26			use Phossa2\Di\Exception\RuntimeException;
27			use Phossa2\Di\Exception\NotFoundException;
28			use Phossa2\Shared\Reference\DelegatorInterface;
29			use Phossa2\Config\Interfaces\WritableInterface;
30			use Phossa2\Di\Interfaces\FactoryAwareInterface;
31			use Phossa2\Di\Interfaces\ResolverAwareInterface;
32			use Phossa2\Shared\Reference\DelegatorAwareTrait;
33			use Phossa2\Di\Interfaces\ExtendedContainerInterface;
34			use Phossa2\Shared\Reference\DelegatorAwareInterface;
35
36			/**
37			* Container
38			*
39			* A writable, array accessable, delegator-aware and extended instance container.
40			*
41			* - writable:
42			*
43			* ```php
44			* $container->set('cache', $cache);
45			* ```
46			*
47			* - array accessable:
48			*
49			* ```php
50			* // get
51			* $cache = $container['cache'];
52			*
53			* // set/replace
54			* $container['cache'] = $anotherCache;
55			* ```
56			*
57			* - delegator-aware: lookup dependent instances in the delegator
58			*
59			* ```php
60			* $delegator->addRegistry($container);
61			* ```
62			*
63			* - extended container
64			*
65			* ```php
66			* // get new instance
67			* $newCache = $container->one('cache');
68			*
69			* // run callables
70			* $container->run(['${#logger}', 'warning'], ['A warning message from ${user}']);
71			* ```
72			*
73			* @package Phossa2\Di
74			* @author Hong Zhang <[email protected]>
75			* @see ObjectAbstract
76			* @see ScopeInterface
77			* @see ContainerInterface
78			* @see ResolverAwareInterface
79			* @see FactoryAwareInterface
80			* @see ExtendedContainerInterface
81			* @see DelegatorAwareInterface
82			* @see WritableInterface
83			* @see \ArrayAccess
84			* @version 2.0.0
85			* @since 2.0.0 added
86			*/
87			class Container extends ObjectAbstract implements ContainerInterface, ResolverAwareInterface, FactoryAwareInterface, ScopeInterface, ExtendedContainerInterface, DelegatorAwareInterface, \ArrayAccess, WritableInterface
88			{
89			use ContainerTrait, ArrayAccessTrait, DelegatorAwareTrait;
90
91			/**
92			* Inject a Phossa2\Config\Config
93			*
94			* ```php
95			* $configData = [
96			* // container class
97			* 'di.class' => 'Phossa2\\Di\\Container',
98			*
99			* // container service definitions
100			* 'di.service' => [
101			* // ...
102			* ],
103			*
104			* // interface/classname mappings
105			* 'di.mapping' => [
106			* ],
107			*
108			* // init methods to run after container created
109			* 'di.init' => [
110			* 'default' => [],
111			* 'mystuff' => [ ... ],
112			* ],
113			* ];
114			*
115			* // instantiate $config
116			* $config = new Config(null, null, $configData);
117			*
118			* // instantiate container
119			* $container = new $config['di.class']($config);
120			* ```
121			*
122			* @param Config $config inject the config instance
123			* @param string $baseNode container's starting node in $config
124			* @access public
125			*/
126			public function __construct(
127			Config $config = null,
128			/# string / $baseNode = 'di'
129			) {
130			$conf = $config ?: new Config();
131
132			$this
133			->setResolver(new Resolver($this, $conf, $baseNode))
134			->setFactory(new Factory($this))
135			->registerObject('container', $this)
136			->registerObject('config', $conf)
137			->initContainer();
138			}
139
140			/**
141			* Extensions to the Interop\Container\ContainerInterface
142			*
143			* - Accepting second param as object constructor arguments
144			* - Accpeting $id with scope appended, e.g. 'cache@myScope'
145			*
146			* {@inheritDoc}
147			*/
148			public function get($id)
149			{
150			// not found
151			if (!$this->has($id)) {
152			throw new NotFoundException(
153			Message::get(Message::DI_SERVICE_NOTFOUND, $id),
154			Message::DI_SERVICE_NOTFOUND
155			);
156			}
157
158			// get the instance, constructor args if any
159			return $this->getInstance(
160			$id, func_num_args() > 1 ? func_get_arg(1) : []
161			);
162			}
163
164			/**
165			* Extensions to the Interop\Container\ContainerInterface
166			*
167			* - Accpeting $id with scope appended, e.g. 'cache@myScope'
168			*
169			* {@inheritDoc}
170			*/
171			public function has($id)
172			{
173			if (is_string($id)) {
174			return $this->getResolver()->hasService(
175			$this->idWithoutScope($id)
176			);
177			}
178			return false;
179			}
180
181			/**
182			* {@inheritDoc}
183			*/
184			public function set(/# string / $id, $value)
185			{
186			if ($this->isWritable()) {
187			// set in service definition
188			$this->getResolver()->setService(
189			$this->idWithoutScope($id),
190			$value
191			);
192			return $this;
193			} else {
194			throw new RuntimeException(
195			Message::get(Message::DI_CONTAINER_READONLY, $id),
196			Message::DI_CONTAINER_READONLY
197			);
198			}
199			}
200
201			/**
202			* {@inheritDoc}
203			*/
204			public function one(/# string / $id, array $arguments = [])
205			{
206			// set in single scope
207			return $this->get(
208			$this->scopedId($id, self::SCOPE_SINGLE),
209			$arguments
210			);
211			}
212
213			/**
214			* {@inheritDoc}
215			*/
216			public function run($callable, array $arguments = [])
217			{
218			// resolve any references in the callable(array) and arguments
219			$this->resolve($callable);
220			$this->resolve($arguments);
221
222			return $this->getFactory()->executeCallable($callable, $arguments);
223			}
224
225			/**
226			* {@inheritDoc}
227			*/
228			public function map(/# string / $from, $to)
229			{
230			$this->getResolver()->setMapping($from, $to);
231			return $this;
232			}
233
234			/**
235			* {@inheritDoc}
236			*/
237			public function auto(/# bool / $on = true)
238			{
239			$this->getResolver()->autoWiring($on);
240			return $this;
241			}
242
243			/**
244			* {@inheritDoc}
245			*/
246			public function param(/# string / $name, $value)
247			{
248			$this->getResolver()->set((string) $name, $value);
249			return $this;
250			}
251
252			/**
253			* {@inheritDoc}
254			*/
255			public function resolve(&$toResolve)
256			{
257			$this->getResolver()->resolve($toResolve);
258			return $this;
259			}
260
261			/**
262			* Override `setDelegator()` from 'Phossa2\Shared\Reference\DelegatorAwareTrait'
263			*
264			* {@inheritDoc}
265			*/
266			public function setDelegator(DelegatorInterface $delegator)
267			{
268			$this->delegator = $delegator;
269
270			// this will make sure all dependencies will be looked up in the delegator
271			$this->getResolver()->setObjectResolver();
272
273			return $this;
274			}
275
276			/**
277			* Override 'isWritable()' in 'Phossa2\Config\Traits\WritableTrait'
278			*
279			* Container's writability is depend on its resolver
280			*
281			* {@inheritDoc}
282			*/
283			public function isWritable()/# : bool /
284			{
285			return $this->getResolver()->isWritable();
286			}
287
288			/**
289			* Register object in 'di.service' with $name
290			*
291			* e.g. `$this->registerObject('container', $this)`
292			*
293			* - Later, $this can be referenced as '${#container}' anywhere
294			*
295			* - $object will skip execute common methods for created instances.
296			*
297			* instead of just do
298			* `$container->set($name, $object)`
299			*
300			* you may do
301			* $container->set($name, ['class' => $object, 'skip' => true]);
302			*
303			* @param string $name name to register with
304			* @param object $object
305			* @return $this
306			* @access protected
307			*/
308			protected function registerObject(/# string / $name, $object)
309			{
310			if (!$this->has($name) && $this->isWritable()) {
311			$this->set($name, ['class' => $object, 'skip' => true]);
312			}
313			return $this;
314			}
315			}
316

phossa2 / di

GitHub Access Token became invalid

Push — master ( 98ccbf...73e071 )

Container::auto() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like