Page - Code Metrics - Inspection of "Update docs to add warning about 1.x and master br..." - Orbitale/CmsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8aadd3...9420d2 )

by Alex

created 2016-07-09 13:32 UTC

Page B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	487
Duplicated Lines	5.34 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	8
Bugs	3	Features	2

Metric	Value
wmc	42
c	8
b	3
f	2
lcom	1
cbo	4
dl	26
loc	487
rs	8.295

38 Methods

Rating	Name	Duplication	Size	Complexity
	getId()	0	1	?
A	__toString()	0	4	1
A	__construct()	0	5	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	getSlug()	0	4	1
A	setSlug()	0	6	1
A	getContent()	0	4	1
A	setContent()	0	6	1
A	getMetaDescription()	0	4	1
A	setMetaDescription()	0	6	1
A	getMetaTitle()	0	4	1
A	setMetaTitle()	0	6	1
A	getMetaKeywords()	0	4	1
A	setMetaKeywords()	0	6	1
A	getCategory()	0	4	1
A	setCategory()	0	6	1
A	getCss()	0	4	1
A	setCss()	0	6	1
A	getJs()	0	4	1
A	setJs()	0	6	1
A	getCreatedAt()	0	4	1
A	isEnabled()	0	4	1
A	setEnabled()	0	6	1
A	getParent()	0	4	1
A	setParent()	0	12	2
A	getChildren()	0	4	1
A	addChild()	0	6	1
A	removeChild()	0	6	1
A	isHomepage()	0	4	1
A	setHomepage()	0	6	1
A	getHost()	0	4	1
A	setHost()	0	6	1
A	getLocale()	0	4	1
A	setLocale()	0	6	1
A	getTree()	12	12	2
A	updateSlug()	0	6	2
A	onRemove()	14	14	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Page often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Page, and based on these observations, apply Extract Interface, too.

<?php

/*
* This file is part of the OrbitaleCmsBundle package.
*
* (c) Alexandre Rock Ancelet <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Orbitale\Bundle\CmsBundle\Entity;

use Behat\Transliterator\Transliterator;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;

/**
 * @UniqueEntity("slug")
 * @ORM\HasLifecycleCallbacks()
 * @ORM\MappedSuperclass(repositoryClass="Orbitale\Bundle\CmsBundle\Repository\PageRepository")
 */
abstract class Page
{
    /**
     * @return int
     */
    abstract public function getId();

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

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

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

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

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

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

    /**
     * @var Category
     */
    protected $category;

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

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

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="created_at", type="datetime")
     */
    protected $createdAt;

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

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

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

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

    /**
     * @var Page
     */
    protected $parent;

    /**
     * @var Page[]|ArrayCollection
     */
    protected $children;

    public function __toString()
    {
        return $this->title;
    }

    public function __construct()
    {
        $this->createdAt = new \DateTime();
        $this->children = new ArrayCollection();
    }

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

    /**
     * @param string $title
     *
     * @return Page
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * @param string $content
     *
     * @return Page
     */
    public function setContent($content)
    {
        $this->content = $content;

        return $this;
    }

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

    /**
     * @param string $metaDescription
     *
     * @return Page
     */
    public function setMetaDescription($metaDescription)
    {
        $this->metaDescription = $metaDescription;

        return $this;
    }

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

    /**
     * @param string $metaTitle
     *
     * @return Page
     */
    public function setMetaTitle($metaTitle)
    {
        $this->metaTitle = $metaTitle;

        return $this;
    }

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

    /**
     * @param string $metaKeywords
     *
     * @return Page
     */
    public function setMetaKeywords($metaKeywords)
    {
        $this->metaKeywords = $metaKeywords;

        return $this;
    }

    /**
     * @return Category
     */
    public function getCategory()
    {
        return $this->category;
    }

    /**
     * @param Category $category
     *
     * @return Page
     */
    public function setCategory($category)
    {
        $this->category = $category;

        return $this;
    }

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

    /**
     * @param string $css
     *
     * @return Page
     */
    public function setCss($css)
    {
        $this->css = $css;

        return $this;
    }

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

    /**
     * @param string $js
     *
     * @return Page
     */
    public function setJs($js)
    {
        $this->js = $js;

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    /**
     * @return bool
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * @param bool $enabled
     *
     * @return Page
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;

        return $this;
    }

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

    /**
     * @param Page|null $parent
     *
     * @return Page
     */
    public function setParent(Page $parent = null)
    {
        if ($parent === $this) {
            // Refuse the page to have itself as parent
            $this->parent = null;

            return $this;
        }
        $this->parent = $parent;

        return $this;
    }

    /**
     * @return Page[]|ArrayCollection
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * @param Page $page
     *
     * @return Page
     */
    public function addChild(Page $page)
    {
        $this->children->add($page);

        return $this;
    }

    /**
     * @param Page $page
     *
     * @return Page
     */
    public function removeChild(Page $page)
    {
        $this->children->removeElement($page);

        return $this;
    }

    /**
     * @return bool
     */
    public function isHomepage()
    {
        return $this->homepage;
    }

    /**
     * @param bool $homepage
     *
     * @return Page
     */
    public function setHomepage($homepage)
    {
        $this->homepage = $homepage;

        return $this;
    }

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

    /**
     * @param string $host
     *
     * @return Page
     */
    public function setHost($host)
    {
        $this->host = $host;

        return $this;
    }

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

    /**
     * @param string $locale
     *
     * @return Page
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;

        return $this;
    }

    /**
     * @param string $separator
     *
     * @return string
     */
    public function getTree($separator = '/')
    {
        $tree = '';

        $current = $this;
        do {
            $tree = $current->getSlug().$separator.$tree;
            $current = $current->getParent();
        } while ($current);

        return trim($tree, $separator);
    }

    /**
     * @ORM\PrePersist()
     * @ORM\PreUpdate()
     */
    public function updateSlug()
    {
        if (!$this->slug) {
            $this->slug = Transliterator::transliterate($this->title);
        }
    }

    /**
     * @ORM\PreRemove()
     *
     * @param LifecycleEventArgs $event
     */
    public function onRemove(LifecycleEventArgs $event)
    {
        $em = $event->getEntityManager();
        if ($this->children) {
            foreach ($this->children as $child) {
                $child->setParent(null);
                $em->persist($child);
            }
        }
        $this->enabled = false;
        $this->parent = null;
        $this->title .= '-'.$this->getId().'-deleted';
        $this->slug .= '-'.$this->getId().'-deleted';
    }
}


1		<?php
2
3		/*
4		* This file is part of the OrbitaleCmsBundle package.
5		*
6		* (c) Alexandre Rock Ancelet <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Orbitale\Bundle\CmsBundle\Entity;
13
14		use Behat\Transliterator\Transliterator;
15		use Doctrine\Common\Collections\ArrayCollection;
16		use Doctrine\ORM\Mapping as ORM;
17		use Doctrine\ORM\Event\LifecycleEventArgs;
18		use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
19
20		/**
21		* @UniqueEntity("slug")
22		* @ORM\HasLifecycleCallbacks()
23		* @ORM\MappedSuperclass(repositoryClass="Orbitale\Bundle\CmsBundle\Repository\PageRepository")
24		*/
25		abstract class Page
26		{
27		/**
28		* @return int
29		*/
30		abstract public function getId();
31
32		/**
33		* @var string
34		* @ORM\Column(name="title", type="string", length=255)
35		*/
36		protected $title;
37
38		/**
39		* @var string
40		* @ORM\Column(name="slug", type="string", length=255, unique=true)
41		*/
42		protected $slug;
43
44		/**
45		* @var string
46		* @ORM\Column(name="page_content", type="text", nullable=true)
47		*/
48		protected $content;
49
50		/**
51		* @var string
52		* @ORM\Column(name="meta_description", type="string", length=255, nullable=true)
53		*/
54		protected $metaDescription;
55
56		/**
57		* @var string
58		* @ORM\Column(name="meta_title", type="string", length=255, nullable=true)
59		*/
60		protected $metaTitle;
61
62		/**
63		* @var string
64		* @ORM\Column(name="meta_keywords", type="string", length=255, nullable=true)
65		*/
66		protected $metaKeywords;
67
68		/**
69		* @var Category
70		*/
71		protected $category;
72
73		/**
74		* @var string
75		* @ORM\Column(name="css", type="text", nullable=true)
76		*/
77		protected $css;
78
79		/**
80		* @var string
81		* @ORM\Column(name="js", type="text", nullable=true)
82		*/
83		protected $js;
84
85		/**
86		* @var \DateTime
87		*
88		* @ORM\Column(name="created_at", type="datetime")
89		*/
90		protected $createdAt;
91
92		/**
93		* @var bool
94		* @ORM\Column(name="enabled", type="boolean")
95		*/
96		protected $enabled = false;
97
98		/**
99		* @var bool
100		* @ORM\Column(name="homepage", type="boolean")
101		*/
102		protected $homepage = false;
103
104		/**
105		* @var string
106		* @ORM\Column(name="host", type="string", length=255, nullable=true)
107		*/
108		protected $host;
109
110		/**
111		* @var string
112		* @ORM\Column(name="locale", type="string", length=6, nullable=true)
113		*/
114		protected $locale;
115
116		/**
117		* @var Page
118		*/
119		protected $parent;
120
121		/**
122		* @var Page[]\|ArrayCollection
123		*/
124		protected $children;
125
126		public function __toString()
127		{
128		return $this->title;
129		}
130
131		public function __construct()
132		{
133		$this->createdAt = new \DateTime();
134		$this->children = new ArrayCollection();
135		}
136
137		/**
138		* @return string
139		*/
140		public function getTitle()
141		{
142		return $this->title;
143		}
144
145		/**
146		* @param string $title
147		*
148		* @return Page
149		*/
150		public function setTitle($title)
151		{
152		$this->title = $title;
153
154		return $this;
155		}
156
157		/**
158		* @return string
159		*/
160		public function getSlug()
161		{
162		return $this->slug;
163		}
164
165		/**
166		* @param string $slug
167		*
168		* @return Page
169		*/
170		public function setSlug($slug)
171		{
172		$this->slug = $slug;
173
174		return $this;
175		}
176
177		/**
178		* @return string
179		*/
180		public function getContent()
181		{
182		return $this->content;
183		}
184
185		/**
186		* @param string $content
187		*
188		* @return Page
189		*/
190		public function setContent($content)
191		{
192		$this->content = $content;
193
194		return $this;
195		}
196
197		/**
198		* @return string
199		*/
200		public function getMetaDescription()
201		{
202		return $this->metaDescription;
203		}
204
205		/**
206		* @param string $metaDescription
207		*
208		* @return Page
209		*/
210		public function setMetaDescription($metaDescription)
211		{
212		$this->metaDescription = $metaDescription;
213
214		return $this;
215		}
216
217		/**
218		* @return string
219		*/
220		public function getMetaTitle()
221		{
222		return $this->metaTitle;
223		}
224
225		/**
226		* @param string $metaTitle
227		*
228		* @return Page
229		*/
230		public function setMetaTitle($metaTitle)
231		{
232		$this->metaTitle = $metaTitle;
233
234		return $this;
235		}
236
237		/**
238		* @return string
239		*/
240		public function getMetaKeywords()
241		{
242		return $this->metaKeywords;
243		}
244
245		/**
246		* @param string $metaKeywords
247		*
248		* @return Page
249		*/
250		public function setMetaKeywords($metaKeywords)
251		{
252		$this->metaKeywords = $metaKeywords;
253
254		return $this;
255		}
256
257		/**
258		* @return Category
259		*/
260		public function getCategory()
261		{
262		return $this->category;
263		}
264
265		/**
266		* @param Category $category
267		*
268		* @return Page
269		*/
270		public function setCategory($category)
271		{
272		$this->category = $category;
273
274		return $this;
275		}
276
277		/**
278		* @return string
279		*/
280		public function getCss()
281		{
282		return $this->css;
283		}
284
285		/**
286		* @param string $css
287		*
288		* @return Page
289		*/
290		public function setCss($css)
291		{
292		$this->css = $css;
293
294		return $this;
295		}
296
297		/**
298		* @return string
299		*/
300		public function getJs()
301		{
302		return $this->js;
303		}
304
305		/**
306		* @param string $js
307		*
308		* @return Page
309		*/
310		public function setJs($js)
311		{
312		$this->js = $js;
313
314		return $this;
315		}
316
317		/**
318		* @return \DateTime
319		*/
320		public function getCreatedAt()
321		{
322		return $this->createdAt;
323		}
324
325		/**
326		* @return bool
327		*/
328		public function isEnabled()
329		{
330		return $this->enabled;
331		}
332
333		/**
334		* @param bool $enabled
335		*
336		* @return Page
337		*/
338		public function setEnabled($enabled)
339		{
340		$this->enabled = $enabled;
341
342		return $this;
343		}
344
345		/**
346		* @return Page
347		*/
348		public function getParent()
349		{
350		return $this->parent;
351		}
352
353		/**
354		* @param Page\|null $parent
355		*
356		* @return Page
357		*/
358		public function setParent(Page $parent = null)
359		{
360		if ($parent === $this) {
361		// Refuse the page to have itself as parent
362		$this->parent = null;
363
364		return $this;
365		}
366		$this->parent = $parent;
367
368		return $this;
369		}
370
371		/**
372		* @return Page[]\|ArrayCollection
373		*/
374		public function getChildren()
375		{
376		return $this->children;
377		}
378
379		/**
380		* @param Page $page
381		*
382		* @return Page
383		*/
384		public function addChild(Page $page)
385		{
386		$this->children->add($page);
387
388		return $this;
389		}
390
391		/**
392		* @param Page $page
393		*
394		* @return Page
395		*/
396		public function removeChild(Page $page)
397		{
398		$this->children->removeElement($page);
399
400		return $this;
401		}
402
403		/**
404		* @return bool
405		*/
406		public function isHomepage()
407		{
408		return $this->homepage;
409		}
410
411		/**
412		* @param bool $homepage
413		*
414		* @return Page
415		*/
416		public function setHomepage($homepage)
417		{
418		$this->homepage = $homepage;
419
420		return $this;
421		}
422
423		/**
424		* @return string
425		*/
426		public function getHost()
427		{
428		return $this->host;
429		}
430
431		/**
432		* @param string $host
433		*
434		* @return Page
435		*/
436		public function setHost($host)
437		{
438		$this->host = $host;
439
440		return $this;
441		}
442
443		/**
444		* @return string
445		*/
446		public function getLocale()
447		{
448		return $this->locale;
449		}
450
451		/**
452		* @param string $locale
453		*
454		* @return Page
455		*/
456		public function setLocale($locale)
457		{
458		$this->locale = $locale;
459
460		return $this;
461		}
462
463		/**
464		* @param string $separator
465		*
466		* @return string
467		*/
468	View Code Duplication	public function getTree($separator = '/')
469		{
470		$tree = '';
471
472		$current = $this;
473		do {
474		$tree = $current->getSlug().$separator.$tree;
475		$current = $current->getParent();
476		} while ($current);
477
478		return trim($tree, $separator);
479		}
480
481		/**
482		* @ORM\PrePersist()
483		* @ORM\PreUpdate()
484		*/
485		public function updateSlug()
486		{
487		if (!$this->slug) {
488		$this->slug = Transliterator::transliterate($this->title);
489		}
490		}
491
492		/**
493		* @ORM\PreRemove()
494		*
495		* @param LifecycleEventArgs $event
496		*/
497	View Code Duplication	public function onRemove(LifecycleEventArgs $event)
498		{
499		$em = $event->getEntityManager();
500		if ($this->children) {
501		foreach ($this->children as $child) {
502		$child->setParent(null);
503		$em->persist($child);
504		}
505		}
506		$this->enabled = false;
507		$this->parent = null;
508		$this->title .= '-'.$this->getId().'-deleted';
509		$this->slug .= '-'.$this->getId().'-deleted';
510		}
511		}
512

Orbitale / CmsBundle