Container::isProtected() - Code Metrics - Inspection of "Enhancement: Allow to protect the container" - thephpleague/container - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#96)

by Andreas

created 2016-03-24 10:22 UTC

Container::isProtected() A

↳ Parent: Container

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace League\Container;

use Interop\Container\ContainerInterface as InteropContainerInterface;
use League\Container\Definition\DefinitionFactory;
use League\Container\Definition\DefinitionFactoryInterface;
use League\Container\Definition\DefinitionInterface;
use League\Container\Exception\ProtectedException;
use League\Container\Exception\NotFoundException;
use League\Container\Inflector\InflectorAggregate;
use League\Container\Inflector\InflectorAggregateInterface;
use League\Container\ServiceProvider\ServiceProviderAggregate;
use League\Container\ServiceProvider\ServiceProviderAggregateInterface;

class Container implements ContainerInterface
{
    /**
     * @var \League\Container\Definition\DefinitionFactoryInterface
     */
    protected $definitionFactory;

    /**
     * @var \League\Container\Definition\DefinitionInterface[]
     */
    protected $definitions = [];

    /**
     * @var \League\Container\Definition\DefinitionInterface[]
     */
    protected $sharedDefinitions = [];

    /**
     * @var \League\Container\Inflector\InflectorAggregateInterface
     */
    protected $inflectors;

    /**
     * @var \League\Container\ServiceProvider\ServiceProviderAggregateInterface
     */
    protected $providers;

    /**
     * @var array
     */
    protected $shared = [];

    /**
     * @var \Interop\Container\ContainerInterface[]
     */
    protected $delegates = [];

    /**
     * @var bool
     */
    protected $isProtected = false;

    /**
     * Constructor.
     *
     * @param \League\Container\ServiceProvider\ServiceProviderAggregateInterface|null $providers
     * @param \League\Container\Inflector\InflectorAggregateInterface|null             $inflectors
     * @param \League\Container\Definition\DefinitionFactoryInterface|null             $definitionFactory
     */
    public function __construct(
        ServiceProviderAggregateInterface $providers         = null,
        InflectorAggregateInterface       $inflectors        = null,
        DefinitionFactoryInterface        $definitionFactory = null
    ) {
        // set required dependencies
        $this->providers         = (is_null($providers))
                                 ? (new ServiceProviderAggregate)->setContainer($this)
                                 : $providers->setContainer($this);

        $this->inflectors        = (is_null($inflectors))
                                 ? (new InflectorAggregate)->setContainer($this)
                                 : $inflectors->setContainer($this);

        $this->definitionFactory = (is_null($definitionFactory))
                                 ? (new DefinitionFactory)->setContainer($this)
                                 : $definitionFactory->setContainer($this);
    }

    /**
     * {@inheritdoc}
     */
    public function get($alias, array $args = [])
    {
        $service = $this->getFromThisContainer($alias, $args);

        if ($service === false && $this->providers->provides($alias)) {
            $this->providers->register($alias);
            $service = $this->getFromThisContainer($alias, $args);
        }

        if ($service !== false) {
            return $service;
        }

        if ($resolved = $this->getFromDelegate($alias, $args)) {
            return $this->inflectors->inflect($resolved);
        }

        throw new NotFoundException(
            sprintf('Alias (%s) is not being managed by the container', $alias)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function has($alias)
    {
        if (array_key_exists($alias, $this->definitions) || $this->hasShared($alias)) {
            return true;
        }

        if ($this->providers->provides($alias)) {
            return true;
        }

        return $this->hasInDelegate($alias);
    }

    /**
     * Returns a boolean to determine if the container has a shared instance of an alias.
     *
     * @param  string  $alias
     * @param  boolean $resolved
     * @return boolean
     */
    public function hasShared($alias, $resolved = false)
    {
        $shared = ($resolved === false) ? array_merge($this->shared, $this->sharedDefinitions) : $this->shared;

        return (array_key_exists($alias, $shared));
    }

    /**
     * {@inheritdoc}
     */
    public function add($alias, $concrete = null, $share = false)
    {
        if (is_null($concrete)) {
            $concrete = $alias;
        }

        if ($this->isProtected() && $this->has($alias)) {
            throw new ProtectedException('Container has been protected, overriding services is not allowed.');
        }

        $definition = $this->definitionFactory->getDefinition($alias, $concrete);

        if ($definition instanceof DefinitionInterface) {
            if ($share === false) {
                $this->definitions[$alias] = $definition;
            } else {
                $this->sharedDefinitions[$alias] = $definition;
            }

            return $definition;
        }

        // dealing with a value that cannot build a definition
        $this->shared[$alias] = $concrete;
    }

    /**
     * {@inheritdoc}
     */
    public function share($alias, $concrete = null)
    {
        return $this->add($alias, $concrete, true);
    }

    /**
     * {@inheritdoc}
     */
    public function addServiceProvider($provider)
    {
        if ($this->isProtected()) {
            throw new ProtectedException('Container has been protected, adding service providers is not allowed');
        }

        $this->providers->add($provider);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function extend($alias)
    {
        if ($this->providers->provides($alias)) {
            $this->providers->register($alias);
        }

        if (array_key_exists($alias, $this->definitions)) {
            return $this->definitions[$alias];
        }

        if (array_key_exists($alias, $this->sharedDefinitions)) {
            return $this->sharedDefinitions[$alias];
        }

        throw new NotFoundException(
            sprintf('Unable to extend alias (%s) as it is not being managed as a definition', $alias)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function inflector($type, callable $callback = null)
    {
        if ($this->isProtected()) {
            throw new ProtectedException('Container has been protected, adding inflectors is not allowed');
        }

        return $this->inflectors->add($type, $callback);
    }

    /**
     * {@inheritdoc}
     */
    public function call(callable $callable, array $args = [])
    {
        return (new ReflectionContainer)->setContainer($this)->call($callable, $args);
    }

    /**
     * Marks the container as protected.
     *
     * Prevents overriding services and delegating to other containers once the container is marked as protected.
     */
    public function protect()
    {
        $this->isProtected = true;
    }

    /**
     * Marks the container as unprotected.
     *
     * Allows overriding services and delegating to other containers (this is the default).
     */
    public function unprotect()
    {
        $this->isProtected = false;
    }

    /**
     * Returns true if the container is protected.
     *
     * @return bool
     */
    public function isProtected()
    {
        return $this->isProtected;
    }

    /**
     * Delegate a backup container to be checked for services if it
     * cannot be resolved via this container.
     *
     * @param  \Interop\Container\ContainerInterface $container
     * @return $this
     */
    public function delegate(InteropContainerInterface $container)
    {
        if ($this->isProtected()) {
            throw new ProtectedException('Container has been protected, delegating to additional containers is not allowed');
        }

        $this->delegates[] = $container;

        if ($container instanceof ImmutableContainerAwareInterface) {
            $container->setContainer($this);
        }

        return $this;
    }

    /**
     * Returns true if service is registered in one of the delegated backup containers.
     *
     * @param  string $alias
     * @return boolean
     */
    public function hasInDelegate($alias)
    {
        foreach ($this->delegates as $container) {
            if ($container->has($alias)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Attempt to get a service from the stack of delegated backup containers.
     *
     * @param  string $alias
     * @param  array  $args
     * @return mixed
     */
    protected function getFromDelegate($alias, array $args = [])
    {
        foreach ($this->delegates as $container) {
            if ($container->has($alias)) {
                return $container->get($alias, $args);
            }

            continue;
        }

        return false;
    }

    /**
     * Get a service that has been registered in this container.
     *
     * @param  string $alias
     * @param  array $args
     * @return mixed
     */
    protected function getFromThisContainer($alias, array $args = [])
    {
        if ($this->hasShared($alias, true)) {
            return $this->inflectors->inflect($this->shared[$alias]);
        }

        if (array_key_exists($alias, $this->sharedDefinitions)) {
            $shared = $this->inflectors->inflect($this->sharedDefinitions[$alias]->build());
            $this->shared[$alias] = $shared;
            return $shared;
        }

        if (array_key_exists($alias, $this->definitions)) {
            return $this->inflectors->inflect(
                $this->definitions[$alias]->build($args)
            );
        }

        return false;
    }
}


1		<?php
2
3		namespace League\Container;
4
5		use Interop\Container\ContainerInterface as InteropContainerInterface;
6		use League\Container\Definition\DefinitionFactory;
7		use League\Container\Definition\DefinitionFactoryInterface;
8		use League\Container\Definition\DefinitionInterface;
9		use League\Container\Exception\ProtectedException;
10		use League\Container\Exception\NotFoundException;
11		use League\Container\Inflector\InflectorAggregate;
12		use League\Container\Inflector\InflectorAggregateInterface;
13		use League\Container\ServiceProvider\ServiceProviderAggregate;
14		use League\Container\ServiceProvider\ServiceProviderAggregateInterface;
15
16		class Container implements ContainerInterface
17		{
18		/**
19		* @var \League\Container\Definition\DefinitionFactoryInterface
20		*/
21		protected $definitionFactory;
22
23		/**
24		* @var \League\Container\Definition\DefinitionInterface[]
25		*/
26		protected $definitions = [];
27
28		/**
29		* @var \League\Container\Definition\DefinitionInterface[]
30		*/
31		protected $sharedDefinitions = [];
32
33		/**
34		* @var \League\Container\Inflector\InflectorAggregateInterface
35		*/
36		protected $inflectors;
37
38		/**
39		* @var \League\Container\ServiceProvider\ServiceProviderAggregateInterface
40		*/
41		protected $providers;
42
43		/**
44		* @var array
45		*/
46		protected $shared = [];
47
48		/**
49		* @var \Interop\Container\ContainerInterface[]
50		*/
51		protected $delegates = [];
52
53		/**
54		* @var bool
55		*/
56		protected $isProtected = false;
57
58		/**
59	42	* Constructor.
60		*
61		* @param \League\Container\ServiceProvider\ServiceProviderAggregateInterface\|null $providers
62		* @param \League\Container\Inflector\InflectorAggregateInterface\|null $inflectors
63		* @param \League\Container\Definition\DefinitionFactoryInterface\|null $definitionFactory
64		*/
65	42	public function __construct(
66	42	ServiceProviderAggregateInterface $providers = null,
67	42	InflectorAggregateInterface $inflectors = null,
68		DefinitionFactoryInterface $definitionFactory = null
69	42	) {
70	42	// set required dependencies
71	42	$this->providers = (is_null($providers))
72		? (new ServiceProviderAggregate)->setContainer($this)
73	42	: $providers->setContainer($this);
74	42
75	42	$this->inflectors = (is_null($inflectors))
76	42	? (new InflectorAggregate)->setContainer($this)
77		: $inflectors->setContainer($this);
78
79		$this->definitionFactory = (is_null($definitionFactory))
80		? (new DefinitionFactory)->setContainer($this)
81	30	: $definitionFactory->setContainer($this);
82		}
83	30
84		/**
85	30	* {@inheritdoc}
86	12	*/
87	12	public function get($alias, array $args = [])
88	12	{
89		$service = $this->getFromThisContainer($alias, $args);
90	30
91	24	if ($service === false && $this->providers->provides($alias)) {
92		$this->providers->register($alias);
93		$service = $this->getFromThisContainer($alias, $args);
94	12	}
95	6
96		if ($service !== false) {
97		return $service;
98	6	}
99	6
100	6	if ($resolved = $this->getFromDelegate($alias, $args)) {
101		return $this->inflectors->inflect($resolved);
102		}
103
104		throw new NotFoundException(
105		sprintf('Alias (%s) is not being managed by the container', $alias)
106	18	);
107		}
108	18
109	12	/**
110		* {@inheritdoc}
111		*/
112	9	public function has($alias)
113	3	{
114		if (array_key_exists($alias, $this->definitions) \|\| $this->hasShared($alias)) {
115		return true;
116	9	}
117
118		if ($this->providers->provides($alias)) {
119		return true;
120		}
121
122		return $this->hasInDelegate($alias);
123		}
124
125		/**
126	36	* Returns a boolean to determine if the container has a shared instance of an alias.
127		*
128	36	* @param string $alias
129		* @param boolean $resolved
130	36	* @return boolean
131		*/
132		public function hasShared($alias, $resolved = false)
133		{
134		$shared = ($resolved === false) ? array_merge($this->shared, $this->sharedDefinitions) : $this->shared;
135
136	30	return (array_key_exists($alias, $shared));
137		}
138	30
139	3	/**
140	3	* {@inheritdoc}
141		*/
142	30	public function add($alias, $concrete = null, $share = false)
143		{
144	30	if (is_null($concrete)) {
145	27	$concrete = $alias;
146	9	}
147	9
148	21	if ($this->isProtected() && $this->has($alias)) {
149		throw new ProtectedException('Container has been protected, overriding services is not allowed.');
150		}
151	27
152		$definition = $this->definitionFactory->getDefinition($alias, $concrete);
153
154		if ($definition instanceof DefinitionInterface) {
155	3	if ($share === false) {
156	3	$this->definitions[$alias] = $definition;
157		} else {
158		$this->sharedDefinitions[$alias] = $definition;
159		}
160
161	21	return $definition;
162		}
163	21
164		// dealing with a value that cannot build a definition
165		$this->shared[$alias] = $concrete;
166		}
167
168		/**
169	12	* {@inheritdoc}
170		*/
171	12	public function share($alias, $concrete = null)
172		{
173	12	return $this->add($alias, $concrete, true);
174		}
175
176		/**
177		* {@inheritdoc}
178		*/
179	6	public function addServiceProvider($provider)
180		{
181	6	if ($this->isProtected()) {
182	3	throw new ProtectedException('Container has been protected, adding service providers is not allowed');
183	3	}
184
185	6	$this->providers->add($provider);
186	3
187		return $this;
188		}
189	6
190	3	/**
191		* {@inheritdoc}
192		*/
193	3	public function extend($alias)
194	3	{
195	3	if ($this->providers->provides($alias)) {
196		$this->providers->register($alias);
197		}
198
199		if (array_key_exists($alias, $this->definitions)) {
200		return $this->definitions[$alias];
201		}
202
203		if (array_key_exists($alias, $this->sharedDefinitions)) {
204		return $this->sharedDefinitions[$alias];
205		}
206
207		throw new NotFoundException(
208		sprintf('Unable to extend alias (%s) as it is not being managed as a definition', $alias)
209		);
210		}
211
212		/**
213		* {@inheritdoc}
214		*/
215		public function inflector($type, callable $callback = null)
216		{
217		if ($this->isProtected()) {
218		throw new ProtectedException('Container has been protected, adding inflectors is not allowed');
219		}
220
221	9	return $this->inflectors->add($type, $callback);
222		}
223	9
224		/**
225	9	* {@inheritdoc}
226	3	*/
227	3	public function call(callable $callable, array $args = [])
228		{
229	9	return (new ReflectionContainer)->setContainer($this)->call($callable, $args);
230		}
231
232		/**
233		* Marks the container as protected.
234		*
235		* Prevents overriding services and delegating to other containers once the container is marked as protected.
236		*/
237		public function protect()
238	9	{
239		$this->isProtected = true;
240	9	}
241	3
242	3	/**
243		* Marks the container as unprotected.
244	9	*
245		* Allows overriding services and delegating to other containers (this is the default).
246	6	*/
247		public function unprotect()
248		{
249		$this->isProtected = false;
250		}
251
252		/**
253		* Returns true if the container is protected.
254		*
255		* @return bool
256	12	*/
257		public function isProtected()
258	12	{
259	6	return $this->isProtected;
260	6	}
261
262		/**
263	3	* Delegate a backup container to be checked for services if it
264	6	* cannot be resolved via this container.
265		*
266	6	* @param \Interop\Container\ContainerInterface $container
267		* @return $this
268		*/
269		public function delegate(InteropContainerInterface $container)
270		{
271		if ($this->isProtected()) {
272		throw new ProtectedException('Container has been protected, delegating to additional containers is not allowed');
273		}
274
275		$this->delegates[] = $container;
276	30
277		if ($container instanceof ImmutableContainerAwareInterface) {
278	30	$container->setContainer($this);
279	9	}
280
281		return $this;
282	27	}
283	15
284	15	/**
285	15	* Returns true if service is registered in one of the delegated backup containers.
286		*
287		* @param string $alias
288	24	* @return boolean
289	6	*/
290	6	public function hasInDelegate($alias)
291	6	{
292		foreach ($this->delegates as $container) {
293		if ($container->has($alias)) {
294	21	return true;
295		}
296		}
297
298		return false;
299		}
300
301		/**
302		* Attempt to get a service from the stack of delegated backup containers.
303		*
304		* @param string $alias
305		* @param array $args
306		* @return mixed
307		*/
308		protected function getFromDelegate($alias, array $args = [])
309		{
310		foreach ($this->delegates as $container) {
311		if ($container->has($alias)) {
312		return $container->get($alias, $args);
313		}
314
315		continue;
316		}
317
318		return false;
319		}
320
321		/**
322		* Get a service that has been registered in this container.
323		*
324		* @param string $alias
325		* @param array $args
326		* @return mixed
327		*/
328		protected function getFromThisContainer($alias, array $args = [])
329		{
330		if ($this->hasShared($alias, true)) {
331		return $this->inflectors->inflect($this->shared[$alias]);
332		}
333
334		if (array_key_exists($alias, $this->sharedDefinitions)) {
335		$shared = $this->inflectors->inflect($this->sharedDefinitions[$alias]->build());
336		$this->shared[$alias] = $shared;
337		return $shared;
338		}
339
340		if (array_key_exists($alias, $this->definitions)) {
341		return $this->inflectors->inflect(
342		$this->definitions[$alias]->build($args)
343		);
344		}
345
346		return false;
347		}
348		}
349

thephpleague / container

Pull Request — master (#96)

Container::isProtected() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like