ServiceProviderAggregate::add() - Code Metrics - Inspection of "3.x" - thephpleague/container - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#126)

by Phil

created 2017-04-01 20:05 UTC

ServiceProviderAggregate::add() C

↳ Parent: ServiceProviderAggregate

Complexity

Conditions	8
Paths	24

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	8

Importance

Changes

Metric	Value
dl	0
loc	27
c	0
b	0
f	0
ccs	17
cts	17
cp	1
rs	5.3846
cc	8
eloc	15
nc	24
nop	1
crap	8

<?php declare(strict_types=1);

namespace League\Container\ServiceProvider;

use Generator;
use League\Container\{ContainerAwareInterface, ContainerAwareTrait};
use League\Container\Exception\ContainerException;

class ServiceProviderAggregate implements ServiceProviderAggregateInterface
{
    use ContainerAwareTrait;

    /**
     * @var \League\Container\ServiceProvider\ServiceProviderInterface[]
     */
    protected $providers = [];

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

    /**
     * {@inheritdoc}
     */
    public function add($provider): ServiceProviderAggregateInterface
    {
        if (is_string($provider) && $this->getContainer()->has($provider)) {
            $provider = $this->getContainer()->get($provider);
        } elseif (is_string($provider) && class_exists($provider)) {
            $provider = new $provider;
        }

        if ($provider instanceof ContainerAwareInterface) {
            $provider->setContainer($this->getContainer());
        }

        if ($provider instanceof BootableServiceProviderInterface) {
            $provider->boot();
        }

        if ($provider instanceof ServiceProviderInterface) {
            $this->providers[] = $provider;

            return $this;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        throw new ContainerException(
            'A service provider must be a fully qualified class name or instance ' .
            'of (\League\Container\ServiceProvider\ServiceProviderInterface)'
        );
    }

    /**
     * {@inheritdoc}
     */
    public function provides(string $service): bool
    {
        foreach ($this->getIterator() as $provider) {
            if ($provider->provides($service)) {
                return true;
            }
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): Generator
    {
        $count = count($this->providers);

        for ($i = 0; $i < $count; $i++) {
            yield $this->providers[$i];
        }
    }

    /**
     * {@inheritdoc}
     */
    public function register(string $service)
    {
        if (! $this->provides($service)) {
            throw new ContainerException(
                sprintf('(%s) is not provided by a service provider', $service)
            );
        }

        foreach ($this->getIterator() as $provider) {
            if (in_array($provider->getSignature(), $this->registered)) {
                return;
            }

            $provider->register();

            $this->registered[] = $provider->getSignature();
        }
    }
}


1		<?php declare(strict_types=1);
2
3		namespace League\Container\ServiceProvider;
4
5		use Generator;
6		use League\Container\{ContainerAwareInterface, ContainerAwareTrait};
7		use League\Container\Exception\ContainerException;
8
9		class ServiceProviderAggregate implements ServiceProviderAggregateInterface
10		{
11		use ContainerAwareTrait;
12
13		/**
14		* @var \League\Container\ServiceProvider\ServiceProviderInterface[]
15		*/
16		protected $providers = [];
17
18		/**
19		* @var array
20		*/
21		protected $registered = [];
22
23		/**
24		* {@inheritdoc}
25	21	*/
26		public function add($provider): ServiceProviderAggregateInterface
27	21	{
28	3	if (is_string($provider) && $this->getContainer()->has($provider)) {
29	2	$provider = $this->getContainer()->get($provider);
30		} elseif (is_string($provider) && class_exists($provider)) {
31	21	$provider = new $provider;
32	18	}
33	12
34		if ($provider instanceof ContainerAwareInterface) {
35	21	$provider->setContainer($this->getContainer());
36	9	}
37	6
38		if ($provider instanceof BootableServiceProviderInterface) {
39	21	$provider->boot();
40	18	}
41	18
42	12	if ($provider instanceof ServiceProviderInterface) {
43		$this->providers[] = $provider;
44	18
45		return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-03-31 12:26 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`League\Container\Service...erviceProviderAggregate`) is incompatible with the return type declared by the interface `League\Container\Service...AggregateInterface::add` of type `self`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
46		}
47	3
48		throw new ContainerException(
49	1	'A service provider must be a fully qualified class name or instance ' .
50	2	'of (\League\Container\ServiceProvider\ServiceProviderInterface)'
51		);
52		}
53
54		/**
55		* {@inheritdoc}
56	33	*/
57		public function provides(string $service): bool
58	33	{
59		foreach ($this->getIterator() as $provider) {
60		if ($provider->provides($service)) {
61		return true;
62		}
63		}
64	18
65		return false;
66	18	}
67	3
68	3	/**
69	2	* {@inheritdoc}
70		*/
71		public function getIterator(): Generator
72	15	{
73	15	$count = count($this->providers);
74
75	15	for ($i = 0; $i < $count; $i++) {
76	3	yield $this->providers[$i];
77	2	}
78		}
79
80	15	/**
81	6	* {@inheritdoc}
82		*/
83		public function register(string $service)
84	15	{
85		if (! $this->provides($service)) {
86	15	throw new ContainerException(
87	15	sprintf('(%s) is not provided by a service provider', $service)
88		);
89		}
90
91		foreach ($this->getIterator() as $provider) {
92		if (in_array($provider->getSignature(), $this->registered)) {
93		return;
94		}
95
96		$provider->register();
97
98		$this->registered[] = $provider->getSignature();
99		}
100		}
101		}
102

thephpleague / container

Pull Request — master (#126)

ServiceProviderAggregate::add() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like