BusinessPageBuilder::setEntityAttributeValue() - Code Metrics - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

BusinessPageBuilder::setEntityAttributeValue() A
last analyzed 2017-05-22 12:29 UTC

↳ Parent: BusinessPageBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Victoire\Bundle\BusinessPageBundle\Builder;

use Doctrine\ORM\EntityManager;
use Knp\DoctrineBehaviors\Model\Translatable\Translatable;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessor;
use Victoire\Bundle\BlogBundle\Entity\Article;
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\BusinessEntityBundle\Provider\EntityProxyProvider;
use Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage;
use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
use Victoire\Bundle\BusinessPageBundle\Entity\VirtualBusinessPage;
use Victoire\Bundle\CoreBundle\Exception\IdentifierNotDefinedException;
use Victoire\Bundle\CoreBundle\Helper\UrlBuilder;
use Victoire\Bundle\ViewReferenceBundle\Builder\ViewReferenceBuilder;

class BusinessPageBuilder

{
    protected $businessEntityHelper;
    protected $urlBuilder;
    protected $parameterConverter;
    protected $entityProxyProvider;
    protected $viewReferenceBuilder;

    //@todo Make it dynamic please
    protected $pageParameters = [
        'name',
        'bodyId',
        'bodyClass',
        'slug',
        'currentLocale',
    ];

    /**

     * @param BusinessEntityHelper $businessEntityHelper
     * @param UrlBuilder           $urlBuilder
     * @param ParameterConverter   $parameterConverter
     * @param EntityProxyProvider  $entityProxyProvider
     */
    public function __construct(BusinessEntityHelper $businessEntityHelper,

        UrlBuilder $urlBuilder,
        ParameterConverter $parameterConverter,
        EntityProxyProvider $entityProxyProvider,
        ViewReferenceBuilder $viewReferenceBuilder)

    {

        $this->businessEntityHelper = $businessEntityHelper;
        $this->urlBuilder = $urlBuilder;
        $this->parameterConverter = $parameterConverter;
        $this->entityProxyProvider = $entityProxyProvider;
        $this->viewReferenceBuilder = $viewReferenceBuilder;
    }

    /**
     * Generate update the page parameters with the entity.
     *
     * @param BusinessTemplate $businessTemplate
     * @param mixed            $entity
     * @param EntityManager    $em
     *
     * @return VirtualBusinessPage
     */
    public function generateEntityPageFromTemplate(BusinessTemplate $businessTemplate, $entity, EntityManager $em)
    {
        $page = new VirtualBusinessPage();
        $currentLocale = $businessTemplate->getCurrentLocale();

        $reflect = new \ReflectionClass($businessTemplate);
        $templateProperties = $reflect->getProperties();
        $accessor = PropertyAccess::createPropertyAccessor();

        foreach ($templateProperties as $property) {
            if (!in_array($property->getName(), ['id', 'widgetMap', 'slots', 'seo', 'i18n', 'widgets', 'translations']) && !$property->isStatic()) {
                $value = $accessor->getValue($businessTemplate, $property->getName());
                $setMethod = 'set'.ucfirst($property->getName());
                if (method_exists($page, $setMethod)) {
                    $accessor->setValue($page, $property->getName(), $value);
                }
            }
        }

        //find Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity object according to the given $entity
        $businessEntity = $businessTemplate->getBusinessEntity();
        //the business properties usable in a url
        $businessProperties = $this->getBusinessProperties($businessEntity);

        $entityProxy = $this->entityProxyProvider->getEntityProxy($entity, $businessEntity, $em);

        $page->setEntityProxy($entityProxy);
        $page->setTemplate($businessTemplate);
        /*
         * Returns class and parent's uses
         *
         * @param $class
         * @param bool $autoload
         * @return array
         */
        $class_uses_deep = function ($class, $autoload = true) {

            $traits = [];
            do {
                $traits = array_merge(class_uses($class, $autoload), $traits);
            } while ($class = get_parent_class($class));
            foreach ($traits as $trait => $same) {
                $traits = array_merge(class_uses($trait, $autoload), $traits);
            }

            return array_unique($traits);
        };

        $isTranslatableEntity = in_array(Translatable::class, $class_uses_deep($entity));

        foreach ($businessTemplate->getTranslations() as $translation) {
            if ($entity instanceof Article &&
                    !in_array($translation->getLocale(), $entity->getBlog()->getAvailableLocales())
                ) {
                continue;
            }

            if ($isTranslatableEntity) {
                $entity->setCurrentLocale($translation->getLocale());
            }
            $page->setCurrentLocale($translation->getLocale());
            $businessTemplate->setCurrentLocale($translation->getLocale());
            $page = $this->populatePage($page, $businessTemplate, $businessProperties, $em, $entity);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if ($isTranslatableEntity) {
            $entity->setCurrentLocale($currentLocale);
        }
        $page->setCurrentLocale($currentLocale);
        $businessTemplate->setCurrentLocale($currentLocale);

        if ($seo = $businessTemplate->getSeo()) {
            $pageSeo = clone $seo;
            $page->setSeo($pageSeo);
        }

        return $page;

    }

    /**
     * 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->toArray(), $seoBusinessProps->toArray());

        return $businessProperties;
    }

    /**
     * Generate update the page parameters with the entity.
     *
     * @param BusinessPage $page
     * @param Entity       $entity
     */
    public function updatePageParametersByEntity(BusinessPage $page, $entity)
    {
        //if no entity is provided
        if ($entity === null) {
            //we look for the entity of the page
            if ($page->getEntity() !== null) {
                $entity = $page->getEntity();
            }
        }

        //only if we have an entity instance
        if ($entity !== null) {
            $businessEntity = $page->getBusinessEntity();

            if ($businessEntity !== null) {
                $businessProperties = $this->getBusinessProperties($businessEntity);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                //parse the business properties
                foreach ($businessProperties as $businessProperty) {
                    //parse of seo attributes
                    foreach ($this->pageParameters as $pageAttribute) {
                        $accessor = new PropertyAccessor();
                        $string = $accessor->getValue($page, $pageAttribute);
                        $updatedString = $this->parameterConverter->convertFromEntity($string, $businessProperty, $entity);
                        $this->setEntityAttributeValue($page, $pageAttribute, $updatedString);
                    }
                }
            }
        }
    }

    /**
     * Update the value of the entity.
     *
     * @param BusinessPage $entity
     * @param string       $field
     * @param string       $value
     *
     * @return mixed
     */
    protected function setEntityAttributeValue($entity, $field, $value)
    {
        $functionName = 'set'.ucfirst($field);

        call_user_func([$entity, $functionName], $value);
    }

    /**
     * @param VirtualBusinessPage $page
     * @param BusinessTemplate    $businessTemplate
     * @param array               $businessProperties
     * @param EntityManager       $em
     * @param                     $entity
     *
     * @throws IdentifierNotDefinedException
     * @throws \Exception
     *
     * @return VirtualBusinessPage
     */
    private function populatePage(VirtualBusinessPage $page, BusinessTemplate $businessTemplate, array $businessProperties, EntityManager $em, $entity)
    {
        $pageName = $businessTemplate->getName();
        $pageSlug = $businessTemplate->getSlug();
        $page->setSlug($pageSlug);
        $page->setName($pageName);
        $pageUrl = $this->urlBuilder->buildUrl($page);
        //parse the business properties
        foreach ($businessProperties as $businessProperty) {
            $pageUrl = $this->parameterConverter->convertFromEntity($pageUrl, $businessProperty, $entity);
            $pageSlug = $this->parameterConverter->convertFromEntity($pageSlug, $businessProperty, $entity);
            $pageName = $this->parameterConverter->convertFromEntity($pageName, $businessProperty, $entity);
        }
        //Check that all twig variables in pattern url was removed for it's generated BusinessPage
        preg_match_all('/\{\%\s*([^\%\}]*)\s*\%\}|\{\{\s*([^\}\}]*)\s*\}\}/i', $pageUrl, $matches);

        if (count($matches[2])) {
            throw new IdentifierNotDefinedException($matches[2]);
        }

        $page->setUrl($pageUrl);
        $page->setSlug($pageSlug);
        $page->setName($pageName);
        $page->setReference($this->viewReferenceBuilder->buildViewReference($page, $em));

        return $page;
    }
}


1		<?php
2
3		namespace Victoire\Bundle\BusinessPageBundle\Builder;
4
5		use Doctrine\ORM\EntityManager;
6		use Knp\DoctrineBehaviors\Model\Translatable\Translatable;
7		use Symfony\Component\PropertyAccess\PropertyAccess;
8		use Symfony\Component\PropertyAccess\PropertyAccessor;
9		use Victoire\Bundle\BlogBundle\Entity\Article;
10		use Victoire\Bundle\BusinessEntityBundle\Converter\ParameterConverter;
11		use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity;
12		use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessProperty;
13		use Victoire\Bundle\BusinessEntityBundle\Helper\BusinessEntityHelper;
14		use Victoire\Bundle\BusinessEntityBundle\Provider\EntityProxyProvider;
15		use Victoire\Bundle\BusinessPageBundle\Entity\BusinessPage;
16		use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
17		use Victoire\Bundle\BusinessPageBundle\Entity\VirtualBusinessPage;
18		use Victoire\Bundle\CoreBundle\Exception\IdentifierNotDefinedException;
19		use Victoire\Bundle\CoreBundle\Helper\UrlBuilder;
20		use Victoire\Bundle\ViewReferenceBundle\Builder\ViewReferenceBuilder;
21
22		class BusinessPageBuilder
		0 ignored issues – show introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
23		{
24		protected $businessEntityHelper;
25		protected $urlBuilder;
26		protected $parameterConverter;
27		protected $entityProxyProvider;
28		protected $viewReferenceBuilder;
29
30		//@todo Make it dynamic please
31		protected $pageParameters = [
32		'name',
33		'bodyId',
34		'bodyClass',
35		'slug',
36		'currentLocale',
37		];
38
39		/**
		0 ignored issues – show introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report Doc comment for parameter "$viewReferenceBuilder" missing Loading history...
40		* @param BusinessEntityHelper $businessEntityHelper
41		* @param UrlBuilder $urlBuilder
42		* @param ParameterConverter $parameterConverter
43		* @param EntityProxyProvider $entityProxyProvider
44		*/
45		public function __construct(BusinessEntityHelper $businessEntityHelper,
		0 ignored issues – show Coding Style introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report The first parameter of a multi-line function declaration must be on the line after the opening bracket Loading history...
46		UrlBuilder $urlBuilder,
47		ParameterConverter $parameterConverter,
48		EntityProxyProvider $entityProxyProvider,
49		ViewReferenceBuilder $viewReferenceBuilder)
		0 ignored issues – show Coding Style introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report The closing parenthesis of a multi-line function declaration must be on a new line Loading history...
50		{
		0 ignored issues – show Coding Style introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line Loading history...
51		$this->businessEntityHelper = $businessEntityHelper;
52		$this->urlBuilder = $urlBuilder;
53		$this->parameterConverter = $parameterConverter;
54		$this->entityProxyProvider = $entityProxyProvider;
55		$this->viewReferenceBuilder = $viewReferenceBuilder;
56		}
57
58		/**
59		* Generate update the page parameters with the entity.
60		*
61		* @param BusinessTemplate $businessTemplate
62		* @param mixed $entity
63		* @param EntityManager $em
64		*
65		* @return VirtualBusinessPage
66		*/
67		public function generateEntityPageFromTemplate(BusinessTemplate $businessTemplate, $entity, EntityManager $em)
68		{
69		$page = new VirtualBusinessPage();
70		$currentLocale = $businessTemplate->getCurrentLocale();
71
72		$reflect = new \ReflectionClass($businessTemplate);
73		$templateProperties = $reflect->getProperties();
74		$accessor = PropertyAccess::createPropertyAccessor();
75
76		foreach ($templateProperties as $property) {
77		if (!in_array($property->getName(), ['id', 'widgetMap', 'slots', 'seo', 'i18n', 'widgets', 'translations']) && !$property->isStatic()) {
78		$value = $accessor->getValue($businessTemplate, $property->getName());
79		$setMethod = 'set'.ucfirst($property->getName());
80		if (method_exists($page, $setMethod)) {
81		$accessor->setValue($page, $property->getName(), $value);
82		}
83		}
84		}
85
86		//find Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity object according to the given $entity
87		$businessEntity = $businessTemplate->getBusinessEntity();
88		//the business properties usable in a url
89		$businessProperties = $this->getBusinessProperties($businessEntity);
90
91		$entityProxy = $this->entityProxyProvider->getEntityProxy($entity, $businessEntity, $em);
92
93		$page->setEntityProxy($entityProxy);
94		$page->setTemplate($businessTemplate);
95		/*
96		* Returns class and parent's uses
97		*
98		* @param $class
99		* @param bool $autoload
100		* @return array
101		*/
102		$class_uses_deep = function ($class, $autoload = true) {
		0 ignored issues – show Coding Style introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report Variable "class_uses_deep" is not in valid camel caps format Loading history...
103		$traits = [];
104		do {
105		$traits = array_merge(class_uses($class, $autoload), $traits);
106		} while ($class = get_parent_class($class));
107		foreach ($traits as $trait => $same) {
108		$traits = array_merge(class_uses($trait, $autoload), $traits);
109		}
110
111		return array_unique($traits);
112		};
113
114		$isTranslatableEntity = in_array(Translatable::class, $class_uses_deep($entity));
		0 ignored issues – show Coding Style introduced 2017-03-21 09:25 UTC by Report Bug Copy Issue Report Variable "class_uses_deep" is not in valid camel caps format Loading history...
115		foreach ($businessTemplate->getTranslations() as $translation) {
116		if ($entity instanceof Article &&
117		!in_array($translation->getLocale(), $entity->getBlog()->getAvailableLocales())
118		) {
119		continue;
120		}
121
122		if ($isTranslatableEntity) {
123		$entity->setCurrentLocale($translation->getLocale());
124		}
125		$page->setCurrentLocale($translation->getLocale());
126		$businessTemplate->setCurrentLocale($translation->getLocale());
127		$page = $this->populatePage($page, $businessTemplate, $businessProperties, $em, $entity);
		0 ignored issues – show Documentation introduced 2016-05-27 15:10 UTC by Report Bug Copy Issue Report `$page` is of type `object\|array`, but the function expects a `object<Victoire\Bundle\B...ty\VirtualBusinessPage>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
128		}
129
130		if ($isTranslatableEntity) {
131		$entity->setCurrentLocale($currentLocale);
132		}
133		$page->setCurrentLocale($currentLocale);
134		$businessTemplate->setCurrentLocale($currentLocale);
135
136		if ($seo = $businessTemplate->getSeo()) {
137		$pageSeo = clone $seo;
138		$page->setSeo($pageSeo);
139		}
140
141		return $page;
		0 ignored issues – show Bug Compatibility introduced 2016-01-08 14:36 UTC by Report Bug Copy Issue Report The expression `return $page;` of type `object\|array` is incompatible with the return type documented by `Victoire\Bundle\Business...eEntityPageFromTemplate` of type `Victoire\Bundle\Business...ity\VirtualBusinessPage` as it can also be of type `array` which is not included in this return type. Loading history...
142		}
143
144		/**
145		* Get the list of business properties usable for the url.
146		*
147		* @param BusinessEntity $businessEntity
148		*
149		* @return BusinessProperty[] The list of business properties
150		*/
151	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...
152		{
153		//the business properties usable in a url
154		$businessProperties = $businessEntity->getBusinessPropertiesByType('businessParameter');
155
156		//the business properties usable in a url
157		$seoBusinessProps = $businessEntity->getBusinessPropertiesByType('seoable');
158
159		//the business properties are the identifier and the seoables properties
160		$businessProperties = array_merge($businessProperties->toArray(), $seoBusinessProps->toArray());
161
162		return $businessProperties;
163		}
164
165		/**
166		* Generate update the page parameters with the entity.
167		*
168		* @param BusinessPage $page
169		* @param Entity $entity
170		*/
171		public function updatePageParametersByEntity(BusinessPage $page, $entity)
172		{
173		//if no entity is provided
174		if ($entity === null) {
175		//we look for the entity of the page
176		if ($page->getEntity() !== null) {
177		$entity = $page->getEntity();
178		}
179		}
180
181		//only if we have an entity instance
182		if ($entity !== null) {
183		$businessEntity = $page->getBusinessEntity();
184
185		if ($businessEntity !== null) {
186		$businessProperties = $this->getBusinessProperties($businessEntity);
		0 ignored issues – show Documentation introduced 2017-03-08 18:26 UTC by Report Bug Copy Issue Report `$businessEntity` is of type `string`, but the function expects a `object<Victoire\Bundle\B...\Entity\BusinessEntity>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
187
188		//parse the business properties
189		foreach ($businessProperties as $businessProperty) {
190		//parse of seo attributes
191		foreach ($this->pageParameters as $pageAttribute) {
192		$accessor = new PropertyAccessor();
193		$string = $accessor->getValue($page, $pageAttribute);
194		$updatedString = $this->parameterConverter->convertFromEntity($string, $businessProperty, $entity);
195		$this->setEntityAttributeValue($page, $pageAttribute, $updatedString);
196		}
197		}
198		}
199		}
200		}
201
202		/**
203		* Update the value of the entity.
204		*
205		* @param BusinessPage $entity
206		* @param string $field
207		* @param string $value
208		*
209		* @return mixed
210		*/
211		protected function setEntityAttributeValue($entity, $field, $value)
212		{
213		$functionName = 'set'.ucfirst($field);
214
215		call_user_func([$entity, $functionName], $value);
216		}
217
218		/**
219		* @param VirtualBusinessPage $page
220		* @param BusinessTemplate $businessTemplate
221		* @param array $businessProperties
222		* @param EntityManager $em
223		* @param $entity
224		*
225		* @throws IdentifierNotDefinedException
226		* @throws \Exception
227		*
228		* @return VirtualBusinessPage
229		*/
230		private function populatePage(VirtualBusinessPage $page, BusinessTemplate $businessTemplate, array $businessProperties, EntityManager $em, $entity)
231		{
232		$pageName = $businessTemplate->getName();
233		$pageSlug = $businessTemplate->getSlug();
234		$page->setSlug($pageSlug);
235		$page->setName($pageName);
236		$pageUrl = $this->urlBuilder->buildUrl($page);
237		//parse the business properties
238		foreach ($businessProperties as $businessProperty) {
239		$pageUrl = $this->parameterConverter->convertFromEntity($pageUrl, $businessProperty, $entity);
240		$pageSlug = $this->parameterConverter->convertFromEntity($pageSlug, $businessProperty, $entity);
241		$pageName = $this->parameterConverter->convertFromEntity($pageName, $businessProperty, $entity);
242		}
243		//Check that all twig variables in pattern url was removed for it's generated BusinessPage
244		preg_match_all('/\{\%\s([^\%\}])\s\%\}\|\{\{\s([^\}\}])\s\}\}/i', $pageUrl, $matches);
245
246		if (count($matches[2])) {
247		throw new IdentifierNotDefinedException($matches[2]);
248		}
249
250		$page->setUrl($pageUrl);
251		$page->setSlug($pageSlug);
252		$page->setName($pageName);
253		$page->setReference($this->viewReferenceBuilder->buildViewReference($page, $em));
254
255		return $page;
256		}
257		}
258

Victoire / victoire

BusinessPageBuilder::setEntityAttributeValue() A last analyzed 2017-05-22 12:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BusinessPageBuilder::setEntityAttributeValue() A
last analyzed 2017-05-22 12:29 UTC