BusinessPageHelper - Code Metrics - Inspection of "Merge pull request #646 from LoicGoyet/master" - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c86a7...690ed0 )

unknown

created 2016-10-19 08:20 UTC

BusinessPageHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	219
Duplicated Lines	9.59 %

Coupling/Cohesion

Components	2
Dependencies	10

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	18
lcom	2
cbo	10
dl	21
loc	219
rs	10
c	1
b	0
f	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	8	8	1
B	isEntityAllowed()	0	34	4
A	getEntitiesAllowed()	0	6	1
A	getEntitiesAllowedQueryBuilder()	0	12	1
A	getBusinessProperties()	13	13	1
B	getIdentifierPositionInUrl()	0	36	4
B	guessBestPatternIdForEntity()	0	33	6

How to fix Duplicated Code

<?php

namespace Victoire\Bundle\BusinessPageBundle\Helper;

use Doctrine\DBAL\Schema\View;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\QueryBuilder;
use Victoire\Bundle\BusinessEntityBundle\Converter\ParameterConverter;
use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity;
use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessProperty;
use Victoire\Bundle\BusinessEntityBundle\Helper\BusinessEntityHelper;
use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
use Victoire\Bundle\CoreBundle\Helper\UrlBuilder;
use Victoire\Bundle\QueryBundle\Helper\QueryHelper;
use Victoire\Bundle\ViewReferenceBundle\Connector\ViewReferenceRepository;
use Victoire\Bundle\ViewReferenceBundle\ViewReference\BusinessPageReference;

/**
 * The business entity page pattern helper
 * ref: victoire_business_page.business_page_helper.
 */
class BusinessPageHelper
{
    protected $queryHelper = null;
    protected $viewReferenceRepository = null;
    protected $businessEntityHelper = null;
    protected $parameterConverter = null;
    protected $urlBuilder = null;

    /**
     * @param QueryHelper             $queryHelper
     * @param ViewReferenceRepository $viewReferenceRepository
     * @param BusinessEntityHelper    $businessEntityHelper
     * @param ParameterConverter      $parameterConverter
     * @param UrlBuilder              $urlBuilder
     */
    public function __construct(QueryHelper $queryHelper, ViewReferenceRepository $viewReferenceRepository, BusinessEntityHelper $businessEntityHelper, ParameterConverter $parameterConverter, UrlBuilder $urlBuilder)

    {
        $this->queryHelper = $queryHelper;
        $this->viewReferenceRepository = $viewReferenceRepository;
        $this->businessEntityHelper = $businessEntityHelper;
        $this->parameterConverter = $parameterConverter;
        $this->urlBuilder = $urlBuilder;
    }

    /**
     * Is the entity allowed for the business entity page.
     *
     * @param BusinessTemplate $businessTemplate
     * @param object|null      $entity
     * @param EntityManager    $em
     *
     * @throws \Exception
     *
     * @return bool
     */
    public function isEntityAllowed(BusinessTemplate $businessTemplate, $entity, EntityManager $em = null)
    {
        $allowed = true;

        //test that an entity is given
        if ($entity === null) {
            throw new \Exception('The entity is required.');
        }

        $queryHelper = $this->queryHelper;

        //the page id
        $entityId = $entity->getId();

        //the base of the query
        $baseQuery = $queryHelper->getQueryBuilder($businessTemplate, $em);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        $baseQuery->andWhere('main_item.id = '.$entityId);

        //filter with the query of the page
        $items = $queryHelper->buildWithSubQuery($businessTemplate, $baseQuery, $em)
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            ->getQuery()->getResult();

        //only one page can be found because we filter on the
        if (count($items) > 1) {
            throw new \Exception('More than 1 item was found, there should not be more than 1 item with this query.');
        }

        if (count($items) === 0) {
            $allowed = false;
        }

        return $allowed;
    }

    /**
     * Get the list of entities allowed for the BusinessTemplate page.
     *
     * @param BusinessTemplate $businessTemplate
     * @param EntityManager    $em
     *
     * @return array
     */
    public function getEntitiesAllowed(BusinessTemplate $businessTemplate, EntityManager $em)
    {
        return $this->getEntitiesAllowedQueryBuilder($businessTemplate, $em)
            ->getQuery()
            ->getResult();
    }

    /**
     * Get the list of entities allowed for the BusinessTemplate page.
     *
     * @param BusinessTemplate $businessTemplate
     * @param EntityManager    $em
     *
     * @throws \Exception
     *
     * @return QueryBuilder
     */
    public function getEntitiesAllowedQueryBuilder(BusinessTemplate $businessTemplate, EntityManager $em)
    {
        //the base of the query
        $baseQuery = $this->queryHelper->getQueryBuilder($businessTemplate, $em);

        // add this fake condition to ensure that there is always a "where" clause.
        // In query mode, usage of "AND" will be always valid instead of "WHERE"
        $baseQuery->andWhere('1 = 1');

        //filter with the query of the page
        return $this->queryHelper->buildWithSubQuery($businessTemplate, $baseQuery, $em);
    }

    /**
     * Get the list of business properties usable for the url.
     *
     * @param BusinessEntity $businessEntity
     *
     * @return BusinessProperty[] The list of business properties
     */
    public function getBusinessProperties(BusinessEntity $businessEntity)

    {
        //the business properties usable in a url
        $businessProperties = $businessEntity->getBusinessPropertiesByType('businessParameter');

        //the business properties usable in a url
        $seoBusinessProps = $businessEntity->getBusinessPropertiesByType('seoable');

        //the business properties are the identifier and the seoables properties
        $businessProperties = array_merge($businessProperties, $seoBusinessProps);

        return $businessProperties;
    }

    /**
     * Get the position of the identifier in the url of a business entity page pattern.
     *
     * @param BusinessTemplate $businessTemplate
     *
     * @return int The position
     */
    public function getIdentifierPositionInUrl(BusinessTemplate $businessTemplate)
    {
        $position = null;

        $url = $businessTemplate->getUrl();


        // split on the / character
        $keywords = preg_split("/\//", $url);
        // preg_match_all('/\{\%\s*([^\%\}]*)\s*\%\}|\{\{\s*([^\}\}]*)\s*\}\}/i', $url, $matches);


        //the business property link to the page
        $businessEntityId = $businessTemplate->getBusinessEntityId();

        $businessEntity = $this->businessEntityHelper->findById($businessEntityId);

        //the business properties usable in a url
        $businessProperties = $businessEntity->getBusinessPropertiesByType('businessParameter');

        //we parse the words of the url
        foreach ($keywords as $index => $keyword) {
            foreach ($businessProperties as $businessProperty) {
                $entityProperty = $businessProperty->getEntityProperty();
                $searchWord = '{{item.'.$entityProperty.'}}';

                if ($searchWord === $keyword) {
                    //the array start at index 0 but we want the position to start at 1
                    $position = [
                        'position'         => $index + 1,
                        'businessProperty' => $businessProperty,
                    ];
                }
            }
        }

        return $position;
    }

    /**
     * Guess the best pattern to represent given reflectionClass.
     *
     * @param \ReflectionClass $refClass
     * @param int              $entityId
     * @param EntityManager    $em
     * @param string           $originalRefClassName When digging into parentClass, we do not have to forget originalClass to be able to get reference after all
     *
     * @throws \Exception
     *
     * @return View
     */
    public function guessBestPatternIdForEntity($refClass, $entityId, $em, $originalRefClassName = null)
    {
        $templateId = null;
        $refClassName = $em->getClassMetadata($refClass->name)->name;

        $viewReference = null;
        if (!$originalRefClassName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $originalRefClassName = $refClassName;
        }

        $businessEntity = $this->businessEntityHelper->findByEntityClassname($refClassName);

        if ($businessEntity) {
            $parameters = [
                'entityId'        => $entityId,
                'entityNamespace' => $originalRefClassName,
            ];
            $viewReference = $this->viewReferenceRepository->getOneReferenceByParameters($parameters);
        }

        if (!$viewReference) {
            $parentRefClass = $refClass->getParentClass();
            if ($parentRefClass) {
                $templateId = $this->guessBestPatternIdForEntity($parentRefClass, $entityId, $em, $originalRefClassName);
            } else {
                throw new \Exception(sprintf('Cannot find a BusinessTemplate that can display the requested BusinessEntity ("%s", "%s".)', $refClassName, $entityId));
            }
        } elseif ($viewReference instanceof BusinessPageReference) {
            $templateId = $viewReference->getTemplateId();
        }

        return $templateId;
    }
}


1		<?php
2
3		namespace Victoire\Bundle\BusinessPageBundle\Helper;
4
5		use Doctrine\DBAL\Schema\View;
6		use Doctrine\ORM\EntityManager;
7		use Doctrine\ORM\QueryBuilder;
8		use Victoire\Bundle\BusinessEntityBundle\Converter\ParameterConverter;
9		use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity;
10		use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessProperty;
11		use Victoire\Bundle\BusinessEntityBundle\Helper\BusinessEntityHelper;
12		use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
13		use Victoire\Bundle\CoreBundle\Helper\UrlBuilder;
14		use Victoire\Bundle\QueryBundle\Helper\QueryHelper;
15		use Victoire\Bundle\ViewReferenceBundle\Connector\ViewReferenceRepository;
16		use Victoire\Bundle\ViewReferenceBundle\ViewReference\BusinessPageReference;
17
18		/**
19		* The business entity page pattern helper
20		* ref: victoire_business_page.business_page_helper.
21		*/
22		class BusinessPageHelper
23		{
24		protected $queryHelper = null;
25		protected $viewReferenceRepository = null;
26		protected $businessEntityHelper = null;
27		protected $parameterConverter = null;
28		protected $urlBuilder = null;
29
30		/**
31		* @param QueryHelper $queryHelper
32		* @param ViewReferenceRepository $viewReferenceRepository
33		* @param BusinessEntityHelper $businessEntityHelper
34		* @param ParameterConverter $parameterConverter
35		* @param UrlBuilder $urlBuilder
36		*/
37	View Code Duplication	public function __construct(QueryHelper $queryHelper, ViewReferenceRepository $viewReferenceRepository, BusinessEntityHelper $businessEntityHelper, ParameterConverter $parameterConverter, UrlBuilder $urlBuilder)
		0 ignored issues – show Duplication introduced 2016-04-01 16:20 UTC by Report Bug Copy Issue Report This method 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...
38		{
39		$this->queryHelper = $queryHelper;
40		$this->viewReferenceRepository = $viewReferenceRepository;
41		$this->businessEntityHelper = $businessEntityHelper;
42		$this->parameterConverter = $parameterConverter;
43		$this->urlBuilder = $urlBuilder;
44		}
45
46		/**
47		* Is the entity allowed for the business entity page.
48		*
49		* @param BusinessTemplate $businessTemplate
50		* @param object\|null $entity
51		* @param EntityManager $em
52		*
53		* @throws \Exception
54		*
55		* @return bool
56		*/
57		public function isEntityAllowed(BusinessTemplate $businessTemplate, $entity, EntityManager $em = null)
58		{
59		$allowed = true;
60
61		//test that an entity is given
62		if ($entity === null) {
63		throw new \Exception('The entity is required.');
64		}
65
66		$queryHelper = $this->queryHelper;
67
68		//the page id
69		$entityId = $entity->getId();
70
71		//the base of the query
72		$baseQuery = $queryHelper->getQueryBuilder($businessTemplate, $em);
		0 ignored issues – show Bug introduced 2016-02-08 10:21 UTC by Report Bug Copy Issue Report It seems like `$em` defined by parameter `$em` on line `57` can be `null`; however, `Victoire\Bundle\QueryBun...lper::getQueryBuilder()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
73
74		$baseQuery->andWhere('main_item.id = '.$entityId);
75
76		//filter with the query of the page
77		$items = $queryHelper->buildWithSubQuery($businessTemplate, $baseQuery, $em)
		0 ignored issues – show Bug introduced 2016-02-08 10:21 UTC by Report Bug Copy Issue Report It seems like `$em` defined by parameter `$em` on line `57` can be `null`; however, `Victoire\Bundle\QueryBun...er::buildWithSubQuery()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
78		->getQuery()->getResult();
79
80		//only one page can be found because we filter on the
81		if (count($items) > 1) {
82		throw new \Exception('More than 1 item was found, there should not be more than 1 item with this query.');
83		}
84
85		if (count($items) === 0) {
86		$allowed = false;
87		}
88
89		return $allowed;
90		}
91
92		/**
93		* Get the list of entities allowed for the BusinessTemplate page.
94		*
95		* @param BusinessTemplate $businessTemplate
96		* @param EntityManager $em
97		*
98		* @return array
99		*/
100		public function getEntitiesAllowed(BusinessTemplate $businessTemplate, EntityManager $em)
101		{
102		return $this->getEntitiesAllowedQueryBuilder($businessTemplate, $em)
103		->getQuery()
104		->getResult();
105		}
106
107		/**
108		* Get the list of entities allowed for the BusinessTemplate page.
109		*
110		* @param BusinessTemplate $businessTemplate
111		* @param EntityManager $em
112		*
113		* @throws \Exception
114		*
115		* @return QueryBuilder
116		*/
117		public function getEntitiesAllowedQueryBuilder(BusinessTemplate $businessTemplate, EntityManager $em)
118		{
119		//the base of the query
120		$baseQuery = $this->queryHelper->getQueryBuilder($businessTemplate, $em);
121
122		// add this fake condition to ensure that there is always a "where" clause.
123		// In query mode, usage of "AND" will be always valid instead of "WHERE"
124		$baseQuery->andWhere('1 = 1');
125
126		//filter with the query of the page
127		return $this->queryHelper->buildWithSubQuery($businessTemplate, $baseQuery, $em);
128		}
129
130		/**
131		* Get the list of business properties usable for the url.
132		*
133		* @param BusinessEntity $businessEntity
134		*
135		* @return BusinessProperty[] The list of business properties
136		*/
137	View Code Duplication	public function getBusinessProperties(BusinessEntity $businessEntity)
		0 ignored issues – show Duplication introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report This method 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...
138		{
139		//the business properties usable in a url
140		$businessProperties = $businessEntity->getBusinessPropertiesByType('businessParameter');
141
142		//the business properties usable in a url
143		$seoBusinessProps = $businessEntity->getBusinessPropertiesByType('seoable');
144
145		//the business properties are the identifier and the seoables properties
146		$businessProperties = array_merge($businessProperties, $seoBusinessProps);
147
148		return $businessProperties;
149		}
150
151		/**
152		* Get the position of the identifier in the url of a business entity page pattern.
153		*
154		* @param BusinessTemplate $businessTemplate
155		*
156		* @return int The position
157		*/
158		public function getIdentifierPositionInUrl(BusinessTemplate $businessTemplate)
159		{
160		$position = null;
161
162		$url = $businessTemplate->getUrl();
		0 ignored issues – show Bug introduced 2015-12-01 09:43 UTC by Report Bug Copy Issue Report The method `getUrl()` does not seem to exist on `object<Victoire\Bundle\B...ntity\BusinessTemplate>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
163
164		// split on the / character
165		$keywords = preg_split("/\//", $url);
166		// preg_match_all('/\{\%\s([^\%\}])\s\%\}\|\{\{\s([^\}\}])\s\}\}/i', $url, $matches);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-08 10:21 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
167
168		//the business property link to the page
169		$businessEntityId = $businessTemplate->getBusinessEntityId();
170
171		$businessEntity = $this->businessEntityHelper->findById($businessEntityId);
172
173		//the business properties usable in a url
174		$businessProperties = $businessEntity->getBusinessPropertiesByType('businessParameter');
175
176		//we parse the words of the url
177		foreach ($keywords as $index => $keyword) {
178		foreach ($businessProperties as $businessProperty) {
179		$entityProperty = $businessProperty->getEntityProperty();
180		$searchWord = '{{item.'.$entityProperty.'}}';
181
182		if ($searchWord === $keyword) {
183		//the array start at index 0 but we want the position to start at 1
184		$position = [
185		'position' => $index + 1,
186		'businessProperty' => $businessProperty,
187		];
188		}
189		}
190		}
191
192		return $position;
193		}
194
195		/**
196		* Guess the best pattern to represent given reflectionClass.
197		*
198		* @param \ReflectionClass $refClass
199		* @param int $entityId
200		* @param EntityManager $em
201		* @param string $originalRefClassName When digging into parentClass, we do not have to forget originalClass to be able to get reference after all
202		*
203		* @throws \Exception
204		*
205		* @return View
206		*/
207		public function guessBestPatternIdForEntity($refClass, $entityId, $em, $originalRefClassName = null)
208		{
209		$templateId = null;
210		$refClassName = $em->getClassMetadata($refClass->name)->name;
211
212		$viewReference = null;
213		if (!$originalRefClassName) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report The expression `$originalRefClassName` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
214		$originalRefClassName = $refClassName;
215		}
216
217		$businessEntity = $this->businessEntityHelper->findByEntityClassname($refClassName);
218
219		if ($businessEntity) {
220		$parameters = [
221		'entityId' => $entityId,
222		'entityNamespace' => $originalRefClassName,
223		];
224		$viewReference = $this->viewReferenceRepository->getOneReferenceByParameters($parameters);
225		}
226
227		if (!$viewReference) {
228		$parentRefClass = $refClass->getParentClass();
229		if ($parentRefClass) {
230		$templateId = $this->guessBestPatternIdForEntity($parentRefClass, $entityId, $em, $originalRefClassName);
231		} else {
232		throw new \Exception(sprintf('Cannot find a BusinessTemplate that can display the requested BusinessEntity ("%s", "%s".)', $refClassName, $entityId));
233		}
234		} elseif ($viewReference instanceof BusinessPageReference) {
235		$templateId = $viewReference->getTemplateId();
236		}
237
238		return $templateId;
239		}
240		}
241

Victoire / victoire

Push — master ( 2c86a7...690ed0 )

BusinessPageHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like