Victoire\Bundle\CoreBundle\Entity\View

Complexity

Total Complexity

76

Size/Duplication

Total Lines	865
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	4

Importance

Changes	17
Bugs	4	Features	4

62 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	4	1
A	getChildren()	0	4	1
A	getSlug()	0	4	1
A	getTemplate()	0	4	1
A	setParent()	0	4	1
A	getParent()	0	4	1
A	__construct()	0	7	1
A	__toString()	0	4	1
A	getId()	0	4	1
A	setId()	0	4	1
A	setName()	0	6	1
A	setSlug()	0	6	1
A	setTemplate()	0	6	1
A	setChildren()	0	11	3
A	hasChildren()	0	4	1
A	getWebViewChildren()	0	11	3
A	addChild()	0	4	1
A	removeChild()	0	4	1
A	getLft()	0	4	1
A	setLft()	0	4	1
A	getRgt()	0	4	1
A	setRgt()	0	4	1
A	getLvl()	0	4	1
A	setLvl()	0	4	1
A	getRoot()	0	4	1
A	setRoot()	0	4	1
A	setUndeletable()	0	6	1
A	isUndeletable()	0	4	1
A	getAuthor()	0	4	1
A	setAuthor()	0	6	1
A	getBodyId()	0	4	1
A	setBodyId()	0	6	1
A	getBodyClass()	0	4	1
A	setBodyClass()	0	6	1
A	setWidgetMaps()	0	6	1
A	getWidgetMaps()	0	4	1
A	addWidgetMap()	0	7	2
A	removeWidgetMap()	0	4	1
A	getWidgetsIds()	0	11	3
A	getBuiltWidgetMap()	0	4	1
A	setBuiltWidgetMap()	0	6	1
A	getType()	0	6	1
A	setPosition()	0	4	1
A	getPosition()	0	4	1
A	getReference()	0	7	4
A	getReferences()	0	4	1
A	setReferences()	0	6	1
A	setReference()	0	7	2
A	getCssHash()	0	4	1
A	setCssHash()	0	6	1
A	changeCssHash()	0	4	1
A	getWidgetMap()	0	4	1
A	getWidgets()	0	4	1
A	isTemplateOf()	0	11	3
A	isCssUpToDate()	0	4	1
A	setCssUpToDate()	0	6	1
A	setTranslatableLocale()	0	4	1
A	setLocale()	0	4	1
A	getLocale()	0	4	1
A	getTranslations()	0	4	1
A	getTranslationClass()	0	4	1
A	addTranslation()	0	7	2

<?php

namespace Victoire\Bundle\CoreBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use JMS\Serializer\Annotation as Serializer;
use Symfony\Component\Validator\Constraints as Assert;
use Victoire\Bundle\BusinessPageBundle\Entity\BusinessTemplate;
use Victoire\Bundle\I18nBundle\Entity\ViewTranslation;
use Victoire\Bundle\TemplateBundle\Entity\Template;
use Victoire\Bundle\ViewReferenceBundle\ViewReference\ViewReference;
use Victoire\Bundle\WidgetBundle\Entity\Widget;
use Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap;

/**
 * Victoire View
 * A victoire view is a visual representation with a widget map.
 *
 * @Gedmo\Tree(type="nested")
 * @Gedmo\TranslationEntity(class="Victoire\Bundle\I18nBundle\Entity\ViewTranslation")
 * @ORM\InheritanceType("SINGLE_TABLE")
 * @ORM\DiscriminatorColumn(name="type", type="string")
 * @ORM\Entity(repositoryClass="Victoire\Bundle\CoreBundle\Repository\ViewRepository")
 * @ORM\Table("vic_view")
 * @ORM\HasLifecycleCallbacks
 */
abstract class View
{
    use \Gedmo\Timestampable\Traits\TimestampableEntity;

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

    /**
     * @var string
     *
     * @Assert\NotBlank()
     * @ORM\Column(name="name", type="string", length=255)
     * @Serializer\Groups({"search"})
     * @Gedmo\Translatable
     */
    protected $name;

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

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

    /**
     * @var string
     *
     * @Gedmo\Slug(handlers={
     *     @Gedmo\SlugHandler(class="Victoire\Bundle\BusinessEntityBundle\Handler\TwigSlugHandler"
     * )},fields={"name"}, updatable=false, unique=false)
     * @Gedmo\Translatable
     * @ORM\Column(name="slug", type="string", length=255)
     */
    protected $slug;

    /**
     * @var [WidgetMap]
     *
     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\WidgetMapBundle\Entity\WidgetMap", mappedBy="view", orphanRemoval=true, cascade={"persist", "remove"})
     */
    protected $widgetMaps = [];

    /**
     * @Gedmo\TreeParent
     * @ORM\ManyToOne(targetEntity="View", inversedBy="children", cascade={"persist"})
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
     */
    protected $parent;

    /**
     * @var int
     *
     * @ORM\Column(name="position", type="integer", nullable=false)
     */
    protected $position = 0;

    /**
     * @Gedmo\TreeLeft
     * @ORM\Column(name="lft", type="integer")
     */
    protected $lft;

    /**
     * @Gedmo\TreeLevel
     * @ORM\Column(name="lvl", type="integer")
     */
    protected $lvl;

    /**
     * @Gedmo\TreeRight
     * @ORM\Column(name="rgt", type="integer")
     */
    protected $rgt;

    /**
     * @Gedmo\TreeRoot
     * @ORM\Column(name="root", type="integer", nullable=true)
     */
    protected $root;

    /**
     * @ORM\OneToMany(targetEntity="View", mappedBy="parent", cascade={"remove"})
     * @ORM\OrderBy({"lft" = "ASC"})
     */
    protected $children = [];

    /**
     * This relation is dynamicly added by PageSubscriber.
     */
    protected $author;

    /**
     * @var string
     *
     * @ORM\Column(name="undeletable", type="boolean")
     */
    protected $undeletable = false;

    /**
     * @var ViewReference[]
     *                      The reference is related to viewsReferences.xml file which list all app views.
     *                      This is used to speed up the routing system and identify virtual pages (BusinessPage).
     */
    protected $references;

    /**
     * @var string
     *
     * @ORM\ManyToOne(targetEntity="\Victoire\Bundle\TemplateBundle\Entity\Template", inversedBy="inheritors", cascade={"persist"})
     * @ORM\JoinColumn(name="template_id", referencedColumnName="id", onDelete="CASCADE")
     */
    protected $template;

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

    /**
     * @deprecated
     * @ORM\Column(name="widget_map", type="array")
     */
    protected $widgetMap = [];

    /**
     * @var string
     *
     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\WidgetBundle\Entity\Widget", mappedBy="view", cascade={"persist", "remove"})
     * @ORM\OrderBy({"id" = "ASC"})
     */
    protected $widgets;
    /**
     * @var bool
     *
     * @ORM\Column(name="cssUpToDate", type="boolean")
     */
    protected $cssUpToDate = false;

    /**
     * @Gedmo\Locale
     * Used locale to override Translation listener`s locale
     * this is not a mapped field of entity metadata, just a simple property
     * and it is not necessary because globally locale can be set in listener
     */
    protected $locale;

    /**
     * @ORM\OneToMany(
     *   targetEntity="Victoire\Bundle\I18nBundle\Entity\ViewTranslation",
     *   mappedBy="object",
     *   cascade={"persist", "remove"}
     * )
     */
    private $translations;

    /**
     * Construct.
     **/
    public function __construct()
    {
        $this->children = new ArrayCollection();

It seems like new \Doctrine\Common\Collections\ArrayCollection() of type object<Doctrine\Common\Collections\ArrayCollection> is incompatible with the declared type array of property $children.

        $this->widgetMaps = new ArrayCollection();

It seems like new \Doctrine\Common\Collections\ArrayCollection() of type object<Doctrine\Common\Collections\ArrayCollection> is incompatible with the declared type array of property $widgetMaps.

        $this->translations = new ArrayCollection();
        $this->references = [];
    }

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

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

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

It seems like $id of type object<Victoire\Bundle\CoreBundle\Entity\id> is incompatible with the declared type integer of property $id.

    }

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

    /**
     * Set name.
     *
     * @param string $name
     *
     * @return View
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Set slug.
     *
     * @param string $slug
     *
     * @return View
     */
    public function setSlug($slug)
    {
        $this->slug = $slug;

        return $this;
    }

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

    /**
     * Set template.
     *
     * @param View $template
     *
     * @return View
     */
    public function setTemplate($template)
    {
        $this->template = $template;

It seems like $template of type object<Victoire\Bundle\CoreBundle\Entity\View> is incompatible with the declared type string of property $template.

        return $this;
    }

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

    /**
     * Set parent.
     *
     * @param View $parent
     */
    public function setParent(View $parent = null)
    {
        $this->parent = $parent;
    }

    /**
     * Get parent.
     *
     * @return View parent
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Set children.
     *
     * @param View[] $children
     *
     * @return View
     */
    public function setChildren($children)
    {
        $this->children = $children;
        if ($children !== null) {
            foreach ($children as $child) {
                $child->setParent($this);
            }
        }

        return $this;
    }

    /**
     * Get children.
     *
     * @return View[]
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * Has children.
     *
     * @return int
     */
    public function hasChildren()
    {
        return count($this->children);
    }

    /**
     * Get WebView children.
     *
     * @return string
     */
    public function getWebViewChildren()
    {
        $webViewChildren = [];
        foreach ($this->children as $child) {
            if (!$child instanceof BusinessTemplate) {
                $webViewChildren[] = $child;
            }
        }

        return $webViewChildren;
    }

    /**
     * Add child.
     *
     * @param View $child
     */
    public function addChild(View $child)
    {
        $this->children[] = $child;
    }

    /**
     * Remove child.
     *
     * @param View $child
     */
    public function removeChild(View $child)
    {
        $this->children->removeElement($child);

The method removeElement cannot be called on $this->children (of type array).

    }

    /**
     * Get the left value.
     *
     * @return int
     */
    public function getLft()
    {
        return $this->lft;
    }

    /**
     * Set the left value.
     *
     * @param int $lft
     */
    public function setLft($lft)
    {
        $this->lft = $lft;
    }

    /**
     * Get the right value.
     *
     * @return int
     */
    public function getRgt()
    {
        return $this->rgt;
    }

    /**
     * Set the right value.
     *
     * @param int $rgt
     */
    public function setRgt($rgt)
    {
        $this->rgt = $rgt;
    }

    /**
     * Get the level value.
     *
     * @return int
     */
    public function getLvl()
    {
        return $this->lvl;
    }

    /**
     * Set the level value.
     *
     * @param int $lvl
     */
    public function setLvl($lvl)
    {
        $this->lvl = $lvl;
    }

    /**
     * Get the root value.
     *
     * @return int
     */
    public function getRoot()
    {
        return $this->root;
    }

    /**
     * Set the root value.
     *
     * @param int $root
     */
    public function setRoot($root)
    {
        $this->root = $root;
    }

    /**
     * Set undeletable.
     *
     * @param bool $undeletable
     *
     * @return View The current instance
     */
    public function setUndeletable($undeletable)
    {
        $this->undeletable = $undeletable;

The property $undeletable was declared of type string, but $undeletable is of type boolean. Maybe add a type cast?

        return $this;
    }

    /**
     * Is the widget is undeletable.
     *
     * @return string
     */
    public function isUndeletable()
    {
        return $this->undeletable;
    }

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

    /**
     * Set author.
     *
     * @param string $author
     *
     * @return $this
     */
    public function setAuthor($author)
    {
        $this->author = $author;

        return $this;
    }

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

    /**
     * Set bodyId.
     *
     * @param string $bodyId
     *
     * @return $this
     */
    public function setBodyId($bodyId)
    {
        $this->bodyId = $bodyId;

        return $this;
    }

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

    /**
     * Set bodyClass.
     *
     * @param string $bodyClass
     *
     * @return $this
     */
    public function setBodyClass($bodyClass)
    {
        $this->bodyClass = $bodyClass;

        return $this;
    }

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

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

     *
     * @return View
     */
    public function setWidgetMaps($widgetMaps)
    {
        $this->widgetMaps = $widgetMaps;

        return $this;
    }

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

The doc-type Collection[WidgetMap] could not be parsed: Expected "]" at position 2, but found "WidgetMap". (view supported doc-types)

     */
    public function getWidgetMaps()
    {
        return $this->widgetMaps;
    }

    /**
     * Add widget.
     *
     * @param Widget $widgetMap
     */
    public function addWidgetMap(WidgetMap $widgetMap)
    {
        if (!$widgetMap->getView()) {
            $widgetMap->setView($this);
        }
        $this->widgetMaps[] = $widgetMap;
    }

    /**
     * Remove a widgetMap.
     *
     * @param WidgetMap $widgetMap
     */
    public function removeWidgetMap(WidgetMap $widgetMap)
    {
        $this->widgetMaps->removeElement($widgetMap);

The method removeElement cannot be called on $this->widgetMaps (of type array).

    }

    /**
     * Get widgets ids as array.
     *
     * @return array
     */
    public function getWidgetsIds()
    {
        $widgetIds = [];
        foreach ($this->getBuiltWidgetMap() as $slot => $_widgetMaps) {
            foreach ($_widgetMaps as $widgetMap) {
                $widgetIds[] = $widgetMap->getWidget()->getId();
            }
        }

        return $widgetIds;
    }

    /**
     * Get builtWidgetMap.
     *
     * @return array
     */
    public function getBuiltWidgetMap()
    {
        return $this->builtWidgetMap;

The property builtWidgetMap does not seem to exist. Did you mean widgetMap?

    }

    /**
     * Set builtWidgetMap.
     *
     * @param string $builtWidgetMap
     *
     * @return $this
     */
    public function setBuiltWidgetMap($builtWidgetMap)
    {
        $this->builtWidgetMap = $builtWidgetMap;

The property builtWidgetMap does not seem to exist. Did you mean widgetMap?

        return $this;
    }

    /**
     * Get discriminator type.
     *
     * @return int
     */
    public function getType()
    {
        $class = get_called_class();

        return $class::TYPE;
    }

    /**
     * Set position.
     *
     * @param int $position
     */
    public function setPosition($position)
    {
        $this->position = $position;
    }

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

    /**
     * Get reference according to the current locale.
     *
     * @param string $locale
     *
     * @return null|ViewReference
     */
    public function getReference($locale = null)
    {
        $locale = $locale ?: $this->getLocale();
        if (is_array($this->references) && isset($this->references[$locale])) {
            return $this->references[$locale];
        }
    }

    /**
     * Get references.
     *
     * @return ViewReference[]
     */
    public function getReferences()
    {
        return $this->references;
    }

    /**
     * Set references.
     *
     * @param ViewReference[] $references
     *
     * @return $this
     */
    public function setReferences($references)
    {
        $this->references = $references;

        return $this;
    }

    /**
     * Set reference.
     *
     * @param ViewReference $reference
     * @param string        $locale
     *
     * @return $this
     */
    public function setReference(ViewReference $reference, $locale = null)
    {
        $locale = $locale ?: $this->getLocale();
        $this->references[$locale] = $reference;

        return $this;
    }

    /**
     * Get CSS hash.
     *
     * @return string
     */
    public function getCssHash()
    {
        return $this->cssHash;
    }

    /**
     * Set CSS hash.
     *
     * @param string $cssHash
     *
     * @return $this
     */
    public function setCssHash($cssHash)
    {
        $this->cssHash = $cssHash;

        return $this;
    }

    /**
     * Change cssHash.
     */
    public function changeCssHash()
    {
        $this->cssHash = sha1(uniqid());
    }

    /**
     * @deprecated
     * Get widgetMap.
     *
     * @return widgetMap
     */
    public function getWidgetMap()
    {
        return $this->widgetMap;

The property Victoire\Bundle\CoreBundle\Entity\View::$widgetMap has been deprecated.

    }

    /**
     * @deprecated
     * Get widgets.
     *
     * @return string
     */
    public function getWidgets()
    {
        return $this->widgets;
    }

    public function isTemplateOf(View $view)
    {
        while ($_view = $view->getTemplate()) {
            if ($this == $_view) {
                return true;
            }
            $view = $_view;
        }

        return false;
    }

    /**
     * Get cssUpToDate.
     *
     * @return bool
     */
    public function isCssUpToDate()
    {
        return $this->cssUpToDate;
    }

    /**
     * Set CssUpToDate.
     *
     * @param bool $cssUpToDate
     *
     * @return $this
     */
    public function setCssUpToDate($cssUpToDate)
    {
        $this->cssUpToDate = $cssUpToDate;

        return $this;
    }

    public function setTranslatableLocale($locale)
    {
        $this->locale = $locale;
    }

    public function setLocale($locale)
    {
        $this->locale = $locale;
    }

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

    /**
     * @return ViewTranslation[]
     */
    public function getTranslations()
    {
        return $this->translations;
    }

    /**
     * @return ViewTranslation[]
     */
    public function getTranslationClass()
    {
        return 'Victoire\Bundle\I18nBundle\Entity\ViewTranslation';
    }

    /**
     * @param ViewTranslation $t
     */
    public function addTranslation(ViewTranslation $t)
    {
        if (!$this->translations->contains($t)) {
            $this->translations[] = $t;
            $t->setObject($this);
        }
    }
}