BlockMatcherFactory - Code Metrics - Inspection of "Fix EZP-25003: clear HTTP cache when trashing cont..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp25003-trash_subitems_count_... ( c4ee15...9f71a1 )

unknown

created 2016-04-19 15:41 UTC

BlockMatcherFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	60
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	6
lcom	1
cbo	4
dl	60
loc	60
rs	10
c	1
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setContainer()	4	4	1
A	__construct()	14	14	1
A	getMatcher()	8	8	2
A	setSiteAccess()	8	8	2

How to fix Duplicated Code

<?php

/**
 * File containing the BlockMatcherFactory class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 *
 * @version //autogentag//
 */
namespace eZ\Bundle\EzPublishCoreBundle\Matcher;

use eZ\Publish\API\Repository\Repository;
use eZ\Publish\Core\MVC\ConfigResolverInterface;
use eZ\Publish\Core\MVC\Symfony\Matcher\BlockMatcherFactory as BaseFactory;
use eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessAware;
use eZ\Publish\Core\MVC\Symfony\SiteAccess;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * @deprecated Deprecated since 6.0, will be removed in 6.1. Use the ServiceAwareMatcherFactory instead.
 */
class BlockMatcherFactory extends BaseFactory implements SiteAccessAware, ContainerAwareInterface

{
    /**
     * @var \Symfony\Component\DependencyInjection\ContainerInterface
     */
    private $container;

    /**
     * @var \eZ\Publish\Core\MVC\ConfigResolverInterface;
     */
    private $configResolver;

    public function __construct(ConfigResolverInterface $configResolver, Repository $repository)
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            "BlockMatcherFactory is deprecated, and will be removed in ezpublish-kernel 6.1.\n" .
            'Use the ServiceAwareMatcherFactory with the relative namespace as a constructor argument.',
            E_USER_DEPRECATED
        );

        $this->configResolver = $configResolver;
        parent::__construct(
            $repository,
            $this->configResolver->getParameter('block_view')
        );
    }

    public function setContainer(ContainerInterface $container = null)
    {
        $this->container = $container;
    }

    /**
     * @param string $matcherIdentifier
     *
     * @return \eZ\Publish\Core\MVC\Symfony\Matcher\ContentBased\MatcherInterface
     */
    protected function getMatcher($matcherIdentifier)
    {
        if ($this->container->has($matcherIdentifier)) {
            return $this->container->get($matcherIdentifier);
        }

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

    /**
     * Changes internal configuration to use the one for passed SiteAccess.
     *
     * @param SiteAccess $siteAccess
     */
    public function setSiteAccess(SiteAccess $siteAccess = null)
    {
        if ($siteAccess === null) {
            return;
        }

        $this->matchConfig = $this->configResolver->getParameter('block_view', 'ezsettings', $siteAccess->name);

    }
}


1		<?php
2
3		/**
4		* File containing the BlockMatcherFactory class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*
9		* @version //autogentag//
10		*/
11		namespace eZ\Bundle\EzPublishCoreBundle\Matcher;
12
13		use eZ\Publish\API\Repository\Repository;
14		use eZ\Publish\Core\MVC\ConfigResolverInterface;
15		use eZ\Publish\Core\MVC\Symfony\Matcher\BlockMatcherFactory as BaseFactory;
16		use eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessAware;
17		use eZ\Publish\Core\MVC\Symfony\SiteAccess;
18		use Symfony\Component\DependencyInjection\ContainerAwareInterface;
19		use Symfony\Component\DependencyInjection\ContainerInterface;
20
21		/**
22		* @deprecated Deprecated since 6.0, will be removed in 6.1. Use the ServiceAwareMatcherFactory instead.
23		*/
24	View Code Duplication	class BlockMatcherFactory extends BaseFactory implements SiteAccessAware, ContainerAwareInterface
		0 ignored issues – show Deprecated Code introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report The class `eZ\Publish\Core\MVC\Symf...her\BlockMatcherFactory` has been deprecated with message: Deprecated since 6.0, will be removed in 6.1. Use the AbstractMatcherFactory instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history... Duplication introduced 2015-11-21 14:37 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...
25		{
26		/**
27		* @var \Symfony\Component\DependencyInjection\ContainerInterface
28		*/
29		private $container;
30
31		/**
32		* @var \eZ\Publish\Core\MVC\ConfigResolverInterface;
33		*/
34		private $configResolver;
35
36		public function __construct(ConfigResolverInterface $configResolver, Repository $repository)
37		{
38		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
39		"BlockMatcherFactory is deprecated, and will be removed in ezpublish-kernel 6.1.\n" .
40		'Use the ServiceAwareMatcherFactory with the relative namespace as a constructor argument.',
41		E_USER_DEPRECATED
42		);
43
44		$this->configResolver = $configResolver;
45		parent::__construct(
46		$repository,
47		$this->configResolver->getParameter('block_view')
48		);
49		}
50
51		public function setContainer(ContainerInterface $container = null)
52		{
53		$this->container = $container;
54		}
55
56		/**
57		* @param string $matcherIdentifier
58		*
59		* @return \eZ\Publish\Core\MVC\Symfony\Matcher\ContentBased\MatcherInterface
60		*/
61		protected function getMatcher($matcherIdentifier)
62		{
63		if ($this->container->has($matcherIdentifier)) {
64		return $this->container->get($matcherIdentifier);
65		}
66
67		return parent::getMatcher($matcherIdentifier);
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report The return type of `return parent::getMatcher($matcherIdentifier);` (`eZ\Publish\Core\MVC\Symf...\Block\MatcherInterface`) is incompatible with the return type documented by `eZ\Bundle\EzPublishCoreB...cherFactory::getMatcher` of type `eZ\Publish\Core\MVC\Symf...tBased\MatcherInterface`. 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...
68		}
69
70		/**
71		* Changes internal configuration to use the one for passed SiteAccess.
72		*
73		* @param SiteAccess $siteAccess
74		*/
75		public function setSiteAccess(SiteAccess $siteAccess = null)
76		{
77		if ($siteAccess === null) {
78		return;
79		}
80
81		$this->matchConfig = $this->configResolver->getParameter('block_view', 'ezsettings', $siteAccess->name);
		0 ignored issues – show Documentation Bug introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report It seems like `$this->configResolver->g...gs', $siteAccess->name)` of type `*` is incompatible with the declared type `array` of property `$matchConfig`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
82		}
83		}
84

ezsystems / ezpublish-kernel

Push — ezp25003-trash_subitems_count_... ( c4ee15...9f71a1 )

BlockMatcherFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like