Victoire / victoire

Bundle/BusinessPageBundle/Builder/BusinessPageBuilder.php

<?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

Missing class doc comment

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

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

    /**

Doc comment for parameter "$viewReferenceBuilder" missing

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

The first parameter of a multi-line function declaration must be on the line after the opening bracket

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

The closing parenthesis of a multi-line function declaration must be on a new line

    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        $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) {

Variable "class_uses_deep" is not in valid camel caps format

            $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));

Variable "class_uses_deep" is not in valid camel caps format

        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);

$page is of type object|array, but the function expects a object<Victoire\Bundle\BusinessPageBundle\Entity\VirtualBusinessPage>.

        }

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

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

        return $page;

The expression return $page; of type object|array is incompatible with the return type documented by Victoire\Bundle\BusinessPageBundle\Builder\BusinessPageBuilder::generateEntityPageFromTemplate of type Victoire\Bundle\BusinessPageBundle\Entity\VirtualBusinessPage as it can also be of type array which is not included in this return type.

    }

    /**
     * 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)

This method seems to be duplicated in your project.

    {
        //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);

$businessEntity is of type string, but the function expects a object<Victoire\Bundle\BusinessEntityBundle\Entity\BusinessEntity>.

                //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;
    }
}