Victoire\Bundle\WidgetBundle\Entity\Widget

Complexity

Total Complexity

52

Size/Duplication

Total Lines	544
Duplicated Lines	2.02 %

Coupling/Cohesion

Components	6
Dependencies	10

Importance

Changes	1
Bugs	0	Features	0

38 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isAsynchronous()	0	4	1
A	setAsynchronous()	0	4	1
A	setEntityProxy()	0	4	1
A	getEntityProxy()	0	4	1
A	getBusinessEntityName()	0	8	2
A	__toString()	0	4	1
A	getId()	0	4	1
A	setFields()	11	11	3
A	getFields()	0	4	1
A	setId()	0	4	1
A	setSlot()	0	6	1
A	getSlot()	0	4	1
A	setTheme()	0	6	1
A	getTheme()	0	4	1
A	getType()	0	4	1
A	guessType()	0	6	1
A	setMode()	0	4	1
A	getMode()	0	4	1
A	getViewId()	0	12	2
A	getChildrenSlot()	0	4	2
A	setChildrenSlot()	0	4	1
A	setWidgetMap()	0	9	2
A	getWidgetMap()	0	4	1
A	setEntity()	0	4	1
A	getEntity()	0	15	3
A	__clone()	0	16	3
A	getView()	0	4	1
A	getCriterias()	0	4	1
A	setCriterias()	0	4	1
A	addCriteria()	0	5	1
A	removeCriteria()	0	5	1
A	hasCriteria()	0	4	1
A	hasCriteriaNamed()	0	6	1
A	getQuantum()	0	4	1
A	setQuantum()	0	4	1
A	generateCacheId()	0	14	2
A	guessLocale()	0	10	4

<?php

namespace Victoire\Bundle\WidgetBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Timestampable\Traits\TimestampableEntity;
use Victoire\Bundle\CoreBundle\Entity\EntityProxy;
use Victoire\Bundle\CriteriaBundle\Entity\Criteria;
use Victoire\Bundle\QueryBundle\Entity\QueryTrait;
use Victoire\Bundle\QueryBundle\Entity\VictoireQueryInterface;
use Victoire\Bundle\WidgetBundle\Entity\Traits\StyleTrait;
use Victoire\Bundle\WidgetBundle\Model\Widget as BaseWidget;
use Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap;

/**
 * Widget.
 *
 * @ORM\Table("vic_widget")
 * @ORM\Entity(repositoryClass="Victoire\Bundle\WidgetBundle\Repository\WidgetRepository")
 * @ORM\InheritanceType("JOINED")
 * @ORM\DiscriminatorColumn(name="type", type="string")
 */
class Widget extends BaseWidget implements VictoireQueryInterface
{
    use StyleTrait;
    use QueryTrait;
    use TimestampableEntity;

    public function __construct()

Missing function doc comment

    {
        $this->childrenSlot = uniqid('', true);
        $this->criterias = new ArrayCollection();
    }

    /**
     * @var int
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="slot", type="string", length=255, nullable=true)
     */
    protected $slot;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="childrenSlot", type="string", length=100, nullable=true)
     */
    protected $childrenSlot;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="theme", type="string", length=255, nullable=true)
     */
    protected $theme;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="asynchronous", type="boolean", nullable=true)
     */
    protected $asynchronous;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="fields", type="text")
     */
    protected $fields = 'a:0:{}';

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="mode", type="string", length=255, nullable=false)
     */
    protected $mode = self::MODE_STATIC;

Declare class properties before methods

    /**
     * Auto simple mode: joined entity.
     *
     * @var EntityProxy
     *
     * @ORM\ManyToOne(targetEntity="\Victoire\Bundle\CoreBundle\Entity\EntityProxy", inversedBy="widgets", cascade={"persist"})
     * @ORM\JoinColumn(name="entityProxy_id", referencedColumnName="id", onDelete="CASCADE")
     */
    protected $entityProxy;

Declare class properties before methods

    /**
     * The entity linked to the widget.
     *
     * @var unknown
     */
    protected $entity;

Declare class properties before methods

    /**
     * @deprecated Remove Doctrine mapping and property
     *
     * @var string
     *
     * @ORM\ManyToOne(targetEntity="\Victoire\Bundle\CoreBundle\Entity\View", inversedBy="widgets", cascade={"persist"})
     * @ORM\JoinColumn(name="view_id", referencedColumnName="id", onDelete="CASCADE")
     */
    protected $view;

Declare class properties before methods

    /**
     * @var WidgetMap
     *
     * @ORM\ManyToOne(targetEntity="\Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap", inversedBy="widgets")
     * @ORM\JoinColumn(name="widget_map_id", referencedColumnName="id", onDelete="SET NULL"))
     */
    protected $widgetMap;

Declare class properties before methods

    /**
     * @var [Criteria]
     *
     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\CriteriaBundle\Entity\Criteria", mappedBy="widget", cascade={"persist", "remove"}, orphanRemoval=true)
     */
    protected $criterias;

Declare class properties before methods

    /**
     * @var string
     *
     * @ORM\Column(name="quantum", type="string", length=255, nullable=true)
     */
    protected $quantum;

Declare class properties before methods

    /**
     * @return string
     */
    public function isAsynchronous()
    {
        return $this->asynchronous;
    }

    /**
     * @param string $asynchronous
     */
    public function setAsynchronous($asynchronous)
    {
        $this->asynchronous = $asynchronous;
    }

    /**
     * Set the entity proxy.
     *
     * @param EntityProxy $entityProxy
     */
    public function setEntityProxy(EntityProxy $entityProxy)
    {
        $this->entityProxy = $entityProxy;
    }

    /**
     * Get the entity proxy.
     *
     * @return EntityProxy
     */
    public function getEntityProxy()
    {
        return $this->entityProxy;
    }

    /**
     * Get businessEntityName.
     *
     * @return string
     */
    public function getBusinessEntityName()
    {
        if ($entityProxy = $this->getEntityProxy()) {
            return $entityProxy->getBusinessEntity()->getName();
        }

        return $this->businessEntityName;

The property Victoire\Bundle\QueryBundle\Entity\QueryTrait::$businessEntityName has been deprecated with message: Auto list mode: businessentity type.

    }

    /**
     * to string.
     *
     * @return string
     */
    public function __toString()
    {
        return (string) $this->getId();
    }

    /**
     * Get id.
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set fields.
     *
     * @param string $fields
     *
     * @return Widget
     */
    public function setFields($fields)

This method seems to be duplicated in your project.

    {
        $data = @unserialize($fields);
        if ($fields === 'b:0;' || $data !== false) {
            $this->fields = $fields;
        } else {
            $this->fields = serialize($fields);
        }

        return $this;
    }

    /**
     * Get fields.
     *
     * @return string
     */
    public function getFields()
    {
        return unserialize($this->fields);
    }

    /**
     * Set The Id.
     *
     * @param int $id The id
     */
    public function setId($id)
    {
        $this->id = $id;
    }

    /**
     * Set slot.
     *
     * @param string $slot
     *
     * @return Widget
     */
    public function setSlot($slot)
    {
        $this->slot = $slot;

        return $this;
    }

    /**
     * Get slot.
     *
     * @return string
     */
    public function getSlot()
    {
        return $this->slot;
    }

    /**
     * Set theme.
     *
     * @param string $theme
     *
     * @return Widget
     */
    public function setTheme($theme)
    {
        $this->theme = $theme;

        return $this;
    }

    /**
     * Get theme.
     *
     * @return string
     */
    public function getTheme()
    {
        return $this->theme;
    }

    /**
     * Get the type of the object.
     *
     * @return string The type
     */
    public function getType()
    {
        return $this->guessType();
    }

    /**
     * Guess the type of this by exploding and getting the last item.
     *
     * @return string The guessed type
     */
    protected function guessType()
    {
        $type = explode('\\', get_class($this));

        return strtolower(preg_replace('/Widget/', '', end($type)));
    }

    /**
     * Set the mode.
     *
     * @param string $mode
     */
    public function setMode($mode)

Declare public methods first,then protected ones and finally private ones

    {
        $this->mode = $mode;
    }

    /**
     * Get the mode.
     *
     * @return string
     */
    public function getMode()
    {
        return $this->mode;
    }

    /**
     * Get the view id.
     *
     * @return int The view id
     */
    public function getViewId()
    {
        $viewId = null;

        $view = $this->getView();

The method Victoire\Bundle\WidgetBundle\Entity\Widget::getView() has been deprecated with message: Get view

        if ($view !== null) {
            $viewId = $view->getId();
        }

        return $viewId;
    }

    /**
     * @return string
     */
    public function getChildrenSlot()
    {
        return $this->childrenSlot ?: $this->getId();
    }

    /**
     * @param string $childrenSlot
     */
    public function setChildrenSlot($childrenSlot)
    {
        $this->childrenSlot = $childrenSlot;
    }

    /**
     * Set widgets.
     *
     * @param [WidgetMap] $widgetMap

The doc-type [WidgetMap] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return Widget
     */
    public function setWidgetMap(WidgetMap $widgetMap = null)
    {
        if ($widgetMap) {
            $widgetMap->addWidget($this);
        }
        $this->widgetMap = $widgetMap;

        return $this;
    }

    /**
     * Get widgets.
     *
     * @return [WidgetMap]

The doc-type [WidgetMap] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function getWidgetMap()
    {
        return $this->widgetMap;
    }

    /**
     * Set the entity.
     *
     * @param object $entity
     */
    public function setEntity($entity)
    {
        $this->entity = $entity;
    }

    /**
     * Get the entity.
     *
     * @return number
     */
    public function getEntity()
    {
        //if there is no entity
        if ($this->entity === null) {
            //we try to get one from the proxy
            $entityProxy = $this->getEntityProxy();

            //if there is a proxy
            if ($entityProxy !== null) {
                $this->entity = $entityProxy->getEntity();
            }
        }

        return $this->entity;
    }

    /**
     * Clone a widget.
     */
    public function __clone()
    {
        // if there is a proxy
        if ($this->entityProxy) {
            // we clone this one
            $this->entityProxy = clone $this->entityProxy;
        }

        // This check should be in the __constructor, but Doctrine does not use __constructor to
        // instanciate entites but __clone method.
        if (property_exists(get_called_class(), 'widget')) {
            throw new \Exception(sprintf('A property $widget was found in %s object.
                The $widget property is reserved for Victoire.
                You should chose a different property name.', get_called_class()));
        }
    }

    /**
     * @deprecated
     * Get view
     *
     * @return string
     */
    public function getView()
    {
        return $this->view;

The property Victoire\Bundle\WidgetBundle\Entity\Widget::$view has been deprecated with message: Remove Doctrine mapping and property

    }

    /**
     * @return [Criteria]

The doc-type [Criteria] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function getCriterias()
    {
        return $this->criterias;
    }

    /**
     * @param [Criteria] $criterias

The doc-type [Criteria] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function setCriterias($criterias)
    {
        $this->criterias = $criterias;
    }

    /**
     * @param Criteria $criteria
     */
    public function addCriteria($criteria)
    {
        $criteria->setWidget($this);
        $this->criterias[] = $criteria;
    }

    /**
     * @param Criteria $criteria
     */
    public function removeCriteria(Criteria $criteria)
    {
        $criteria->setWidget(null);

null is of type null, but the function expects a object<Victoire\Bundle\WidgetBundle\Entity\Widget>.

        $this->criterias->removeElement($criteria);
    }

    /**
     * @param Criteria $criteria
     *
     * @return bool
     */
    public function hasCriteria(Criteria $criteria)
    {
        return $this->criterias->contains($criteria);
    }

    /**
     * @param string $criteriaAlias
     *
     * @return bool
     */
    public function hasCriteriaNamed($criteriaAlias)
    {
        return $this->criterias->exists(function ($key, $element) use ($criteriaAlias) {
            return $criteriaAlias === $element->getName();
        });
    }

    /**
     * @return string
     */
    public function getQuantum()
    {
        return $this->quantum;
    }

    /**
     * @param string $quantum
     */
    public function setQuantum($quantum)
    {
        $this->quantum = $quantum;
    }

    /**
     * Generate the CacheId, insert params that can invalid the cache.
     *
     * @return string
     */
    public function generateCacheId()
    {
        if (!$this->getCurrentView()) {
            throw new \Exception(sprintf('Cannot generate an hash for widget %s if currentView is not defined.',
                $this->getId()
            ));
        }

        return sprintf('%s-%s-%s',
            $this->getId(),
            $this->getUpdatedAt()->getTimestamp(),
            $this->getCurrentView()->getReference()->getId()
        );
    }

    /**
     * This method parse the widget criterias to discover in which locale this widget is used.
     *
     * @param $defaultLocale

Missing parameter name

     *
     * @return string|null
     */
    public function guessLocale()
    {
        if ($this->hasCriteriaNamed('locale')) {
            foreach ($this->getCriterias() as $criteria) {
                if ($criteria->getName() === 'locale') {
                    return $criteria->getValue();
                }
            }
        }
    }
}