Template::setLayout() - Code Metrics - Inspection of "Upgrade/2.8 deprecations" - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#343)

by Leny

created 2016-02-24 13:03 UTC

Template::setLayout() A

↳ Parent: Template

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

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

<?php

namespace Victoire\Bundle\TemplateBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
use Victoire\Bundle\CoreBundle\Entity\View;
use Victoire\Bundle\PageBundle\Entity\BasePage;

/**
 * Template.
 *
 * @ORM\Entity(repositoryClass="Victoire\Bundle\TemplateBundle\Repository\TemplateRepository")
 */
class Template extends View
{
    const TYPE = 'template';

    /**
     * @var string
     *
     * @ORM\OneToMany(targetEntity="\Victoire\Bundle\CoreBundle\Entity\View", mappedBy="template")
     */
    protected $inheritors;

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

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

        $this->inheritors = new ArrayCollection();

        $this->pages = new ArrayCollection();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * to string.
     *
     * @return string
     **/
    public function __toString()
    {
        return 'Modèle > '.$this->name;
    }

    /**
     * add page.
     *
     * @param BasePage $page
     *
     * @return Template
     **/
    public function addPage(BasePage $page)
    {
        $page->setTemplate($this);
        $this->pages[] = $page;

        return $this;
    }

    /**
     * set page.
     *
     * @param array $pages
     *
     * @return Template
     **/
    public function setPages(array $pages)
    {
        foreach ($pages as $page) {
            $this->addPage($page);
        }

        return $this;
    }

    /**
     * remove page.
     *
     * @param BasePage $page
     *
     * @return Template
     **/
    public function removePage($page)
    {
        $this->pages->removeElement($page);

        return $this;
    }

    /**
     * Get pages (all Pages having this object as Template).
     *
     * @return ArrayCollection
     */
    public function getPages()
    {
        return $this->pages;
    }

    /**
     * Set layout.
     *
     * @param string $layout
     *
     * @return Template
     */
    public function setLayout($layout)
    {
        $this->layout = $layout;

        return $this;
    }

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

    /**
     * Set inheritors.
     *
     * @param string $inheritors
     *
     * @return Template
     */
    public function setInheritors($inheritors)
    {
        $this->inheritors = $inheritors;

        return $this;
    }

    /**
     * Get inheritors (all Views having this object as Template).
     *
     * @return [Template]

     */
    public function getInheritors()
    {
        return $this->inheritors;
    }

    /**
     * Get inheritors (all Templates having this object as Template).
     *
     * @return [Template]

     */
    public function getTemplateInheritors()

    {
        $templateInheritors = [];
        foreach ($this->inheritors as $inheritor) {

            if ($inheritor instanceof self) {
                $templateInheritors[] = $inheritor;
            }
        }

        return $templateInheritors;
    }

    /**
     * @Assert\Callback(groups={"victoire"})
     *
     * @param ExecutionContextInterface $context
     */
    public function validate(ExecutionContextInterface $context)
    {
        $template = $this;
        while ($template != null) {
            if ($template->getLayout() != null) {
                return;
            }
            $template = $template->getTemplate();
        }

        if ($this->getLayout() == null) {
            $context->buildViolation('data.template.templateform.view.type.template.layout.validator_message')->addViolation();
        }
    }
}


1		<?php
2
3		namespace Victoire\Bundle\TemplateBundle\Entity;
4
5		use Doctrine\Common\Collections\ArrayCollection;
6		use Doctrine\ORM\Mapping as ORM;
7		use Symfony\Component\Validator\Constraints as Assert;
8		use Symfony\Component\Validator\Context\ExecutionContextInterface;
9		use Victoire\Bundle\CoreBundle\Entity\View;
10		use Victoire\Bundle\PageBundle\Entity\BasePage;
11
12		/**
13		* Template.
14		*
15		* @ORM\Entity(repositoryClass="Victoire\Bundle\TemplateBundle\Repository\TemplateRepository")
16		*/
17		class Template extends View
18		{
19		const TYPE = 'template';
20
21		/**
22		* @var string
23		*
24		* @ORM\OneToMany(targetEntity="\Victoire\Bundle\CoreBundle\Entity\View", mappedBy="template")
25		*/
26		protected $inheritors;
27
28		/**
29		* @var string
30		*
31		* @ORM\Column(name="layout", type="string", length=255)
32		*/
33		protected $layout;
34
35		/**
36		* Construct.
37		**/
38		public function __construct()
39		{
40		parent::__construct();
41		$this->widgets = new ArrayCollection();
		0 ignored issues – show Documentation Bug introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report It seems like `new \Doctrine\Common\Collections\ArrayCollection()` of type `object<Doctrine\Common\C...ctions\ArrayCollection>` is incompatible with the declared type `string` of property `$widgets`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
42		$this->inheritors = new ArrayCollection();
		0 ignored issues – show Documentation Bug introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report It seems like `new \Doctrine\Common\Collections\ArrayCollection()` of type `object<Doctrine\Common\C...ctions\ArrayCollection>` is incompatible with the declared type `string` of property `$inheritors`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
43		$this->pages = new ArrayCollection();
		0 ignored issues – show Bug introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report The property `pages` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
44		}
45
46		/**
47		* to string.
48		*
49		* @return string
50		**/
51		public function __toString()
52		{
53		return 'Modèle > '.$this->name;
54		}
55
56		/**
57		* add page.
58		*
59		* @param BasePage $page
60		*
61		* @return Template
62		**/
63		public function addPage(BasePage $page)
64		{
65		$page->setTemplate($this);
66		$this->pages[] = $page;
67
68		return $this;
69		}
70
71		/**
72		* set page.
73		*
74		* @param array $pages
75		*
76		* @return Template
77		**/
78		public function setPages(array $pages)
79		{
80		foreach ($pages as $page) {
81		$this->addPage($page);
82		}
83
84		return $this;
85		}
86
87		/**
88		* remove page.
89		*
90		* @param BasePage $page
91		*
92		* @return Template
93		**/
94		public function removePage($page)
95		{
96		$this->pages->removeElement($page);
97
98		return $this;
99		}
100
101		/**
102		* Get pages (all Pages having this object as Template).
103		*
104		* @return ArrayCollection
105		*/
106		public function getPages()
107		{
108		return $this->pages;
109		}
110
111		/**
112		* Set layout.
113		*
114		* @param string $layout
115		*
116		* @return Template
117		*/
118		public function setLayout($layout)
119		{
120		$this->layout = $layout;
121
122		return $this;
123		}
124
125		/**
126		* Get layout.
127		*
128		* @return string
129		*/
130		public function getLayout()
131		{
132		return $this->layout;
133		}
134
135		/**
136		* Set inheritors.
137		*
138		* @param string $inheritors
139		*
140		* @return Template
141		*/
142		public function setInheritors($inheritors)
143		{
144		$this->inheritors = $inheritors;
145
146		return $this;
147		}
148
149		/**
150		* Get inheritors (all Views having this object as Template).
151		*
152		* @return [Template]
		0 ignored issues – show Documentation introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report The doc-type `[Template]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
153		*/
154		public function getInheritors()
155		{
156		return $this->inheritors;
157		}
158
159		/**
160		* Get inheritors (all Templates having this object as Template).
161		*
162		* @return [Template]
		0 ignored issues – show Documentation introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report The doc-type `[Template]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
163		*/
164	View Code Duplication	public function getTemplateInheritors()
		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...
165		{
166		$templateInheritors = [];
167		foreach ($this->inheritors as $inheritor) {
		0 ignored issues – show Bug introduced 2015-11-24 15:51 UTC by Report Bug Copy Issue Report The expression `$this->inheritors` of type `string` is not traversable. Loading history...
168		if ($inheritor instanceof self) {
169		$templateInheritors[] = $inheritor;
170		}
171		}
172
173		return $templateInheritors;
174		}
175
176		/**
177		* @Assert\Callback(groups={"victoire"})
178		*
179		* @param ExecutionContextInterface $context
180		*/
181		public function validate(ExecutionContextInterface $context)
182		{
183		$template = $this;
184		while ($template != null) {
185		if ($template->getLayout() != null) {
186		return;
187		}
188		$template = $template->getTemplate();
189		}
190
191		if ($this->getLayout() == null) {
192		$context->buildViolation('data.template.templateform.view.type.template.layout.validator_message')->addViolation();
193		}
194		}
195		}
196

Victoire / victoire

Pull Request — master (#343)

Template::setLayout() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like