ContainerModelPooler::setContainer() - Code Metrics - Inspection of "Add suppor for symfony's 3.3 service locator" - pomm-project/pomm-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#73)

unknown

created 2017-07-26 16:32 UTC

ContainerModelPooler::setContainer() A

↳ Parent: ContainerModelPooler

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	7
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * This file is part of the PommProject/PommBundle package.
 *
 * (c) 2014 - 2016 Grégoire HUBERT <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\PommBundle\Model;

use PommProject\ModelManager\Model\ModelPooler;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Psr\Container\ContainerInterface as PsrContainerInterface;

/**
 * PommExtension
 *
 * DIC extension
 *
 * @package   PommBundle
 * @copyright 2016 Grégoire HUBERT
 * @author    Miha Vrhovnik
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       Extension
 */
class ContainerModelPooler extends ModelPooler implements ServiceMapInterface

{
    private $serviceMap = [];
    /** @var PsrContainerInterface|ContainerInterface */
    private $container;

    /**
     * {@inheritdoc}
     */
    public function addModelToServiceMapping($class, $serviceId)
    {
        $this->serviceMap[$class] = $serviceId;
    }

    /**
     * {@inheritdoc}
     */
    protected function createClient($class)
    {
        if (array_key_exists($class, $this->serviceMap)) {
            return $this->container->get($this->serviceMap[$class]);
        }

        return parent::createClient($class);
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());
}
    }

    /**
     * @param PsrContainerInterface|ContainerInterface $container
     */
    public function setContainer($container)
    {
        if (!($container instanceof PsrContainerInterface) && !($container instanceof ContainerInterface)) {
            throw new \InvalidArgumentException('$contaner should be instance of Symfony\Component\DependencyInjection\ContainerInterface or Psr\Container\ContainerInterface');
        }
        $this->container = $container;
    }
}


1		<?php
2		/*
3		* This file is part of the PommProject/PommBundle package.
4		*
5		* (c) 2014 - 2016 Grégoire HUBERT <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10		namespace PommProject\PommBundle\Model;
11
12		use PommProject\ModelManager\Model\ModelPooler;
13		use Symfony\Component\DependencyInjection\ContainerInterface;
14		use Psr\Container\ContainerInterface as PsrContainerInterface;
15
16		/**
17		* PommExtension
18		*
19		* DIC extension
20		*
21		* @package PommBundle
22		* @copyright 2016 Grégoire HUBERT
23		* @author Miha Vrhovnik
24		* @license X11 {@link http://opensource.org/licenses/mit-license.php}
25		* @see Extension
26		*/
27	View Code Duplication	class ContainerModelPooler extends ModelPooler implements ServiceMapInterface
		0 ignored issues – show Duplication introduced 2017-07-26 16:39 UTC by Report Bug Copy Issue Report This class 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...
28		{
29		private $serviceMap = [];
30		/** @var PsrContainerInterface\|ContainerInterface */
31		private $container;
32
33		/**
34		* {@inheritdoc}
35		*/
36		public function addModelToServiceMapping($class, $serviceId)
37		{
38		$this->serviceMap[$class] = $serviceId;
39		}
40
41		/**
42		* {@inheritdoc}
43		*/
44		protected function createClient($class)
45		{
46		if (array_key_exists($class, $this->serviceMap)) {
47		return $this->container->get($this->serviceMap[$class]);
48		}
49
50		return parent::createClient($class);
		0 ignored issues – show Bug Best Practice introduced 2017-06-12 10:12 UTC by Report Bug Copy Issue Report The return type of `return parent::createClient($class);` (`PommProject\ModelManager\Model\Model`) is incompatible with the return type declared by the abstract method `PommProject\Foundation\C...entPooler::createClient` of type `PommProject\Foundation\Client\Client`. 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...
51		}
52
53		/**
54		* @param PsrContainerInterface\|ContainerInterface $container
55		*/
56		public function setContainer($container)
57		{
58		if (!($container instanceof PsrContainerInterface) && !($container instanceof ContainerInterface)) {
59		throw new \InvalidArgumentException('$contaner should be instance of Symfony\Component\DependencyInjection\ContainerInterface or Psr\Container\ContainerInterface');
60		}
61		$this->container = $container;
62		}
63		}
64

pomm-project / pomm-bundle

Pull Request — master (#73)

ContainerModelPooler::setContainer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like