Section::getBreadcrumb() - Code Metrics - Inspection of "Doc block" - anomalylabs/streams-platform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 98a062...441031 )

by Ryan

created 2017-03-26 03:44 UTC

Section::getBreadcrumb() A

↳ Parent: Section

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php namespace Anomaly\Streams\Platform\Ui\ControlPanel\Component\Section;

use Anomaly\Streams\Platform\Ui\ControlPanel\Component\Section\Contract\SectionInterface;

/**
 * Class Section
 *
 * @link   http://pyrocms.com/
 * @author PyroCMS, Inc. <[email protected]>
 * @author Ryan Thompson <[email protected]>
 */
class Section implements SectionInterface
{

    /**
     * The section slug.
     *
     * @var null|string
     */
    protected $slug = null;

    /**
     * The section icon.
     *
     * @var null|string
     */
    protected $icon = null;

    /**
     * The section title.
     *
     * @var null|string
     */
    protected $title = null;

    /**
     * The section label.
     *
     * @var null|string
     */
    protected $label = null;

    /**
     * The class.
     *
     * @var null|string
     */
    protected $class = null;

    /**
     * The active flag.
     *
     * @var bool
     */
    protected $active = false;

    /**
     * The path matcher.
     *
     * @var null|string
     */
    protected $matcher = null;

    /**
     * The section permalink.
     *
     * @var null|string
     */
    protected $permalink = null;

    /**
     * The section description.
     *
     * @var null|string
     */
    protected $description = null;

    /**
     * The highlighted flag.
     *
     * @var bool
     */
    protected $highlighted = false;

    /**
     * The section context.
     *
     * @var string
     */
    protected $context = 'danger';

    /**
     * The section parent.
     *
     * @var null|string
     */
    protected $parent = null;

    /**
     * Section buttons. These are only to
     * transport input to the button builder.
     *
     * @var array
     */
    protected $buttons = [];

    /**
     * The section attributes.
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * The section permission.
     *
     * @var null|string
     */
    protected $permission = null;

    /**
     * The section breadcrumb.
     *
     * @var null|string
     */
    protected $breadcrumb = null;

    /**
     * If the section will be hidden from the Control Panel.
     *
     * @var bool
     */
    protected $hidden = false;

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

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

        return $this;
    }

    /**
     * Get the icon.
     *
     * @return null|string
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * Set the icon.
     *
     * @param $icon
     * @return $this
     */
    public function setIcon($icon)
    {
        $this->icon = $icon;

        return $this;
    }

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

    /**
     * Set the title.
     *
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

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

    /**
     * Set the label.
     *
     * @param  string $label
     * @return $this
     */
    public function setLabel($label)
    {
        $this->label = $label;

        return $this;
    }

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

    /**
     * Set the class.
     *
     * @param $class
     * @return $this
     */
    public function setClass($class)
    {
        $this->class = $class;

        return $this;
    }

    /**
     * Get the active flag.
     *
     * @return boolean
     */
    public function isActive()
    {
        return $this->active;
    }

    /**
     * Set the active flag.
     *
     * @param boolean $active
     */
    public function setActive($active)
    {
        $this->active = $active;

        return $this;
    }

    /**
     * Get the matcher.
     *
     * @return null|string
     */
    public function getMatcher()
    {
        return $this->matcher;
    }

    /**
     * Set the matcher.
     *
     * @param $matcher
     * @return $this
     */
    public function setMatcher($matcher)
    {
        $this->matcher = $matcher;

        return $this;
    }

    /**
     * Get the permalink.
     *
     * @return null|string
     */
    public function getPermalink()
    {
        return $this->permalink;
    }

    /**
     * Set the permalink.
     *
     * @param $permalink
     * @return $this
     */
    public function setPermalink($permalink)
    {
        $this->permalink = $permalink;

        return $this;
    }

    /**
     * Get the description.
     *
     * @return null|string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Set the description.
     *
     * @param $description
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Get the highlighted flag.
     *
     * @return boolean
     */
    public function isHighlighted()
    {
        return $this->highlighted;
    }

    /**
     * Set the highlighted flag.
     *
     * @param  boolean $active
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return $this
     */
    public function setHighlighted($highlighted)
    {
        $this->highlighted = $highlighted;

        return $this;
    }

    /**
     * Get the context.
     *
     * @return boolean
     */
    public function getContext()
    {
        return $this->context;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Set the context flag.
     *
     * @param  boolean $active
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return $this
     */
    public function setContext($context)
    {
        $this->context = $context;

        return $this;
    }

    /**
     * Get the parent.
     *
     * @return null|string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Return if the section is
     * a sub-section or not.
     *
     * @return bool
     */
    public function isSubSection()
    {
        return (bool)$this->getParent();
    }

    /**
     * Set the parent.
     *
     * @param $parent
     * @return $this
     */
    public function setParent($parent)
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * Get the buttons.
     *
     * @return array
     */
    public function getButtons()
    {
        return $this->buttons;
    }

    /**
     * Set the buttons.
     *
     * @param array $buttons
     */
    public function setButtons($buttons)
    {
        $this->buttons = $buttons;
    }

    /**
     * Get the attributes.
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Set the attributes.
     *
     * @param array $attributes
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
    }

    /**
     * Get the permission.
     *
     * @return null|string
     */
    public function getPermission()
    {
        return $this->permission;
    }

    /**
     * Set the permission.
     *
     * @param $permission
     * @return $this
     */
    public function setPermission($permission)
    {
        $this->permission = $permission;

        return $this;
    }

    /**
     * Get the breadcrumb.
     *
     * @return null|string
     */
    public function getBreadcrumb()
    {
        return $this->breadcrumb;
    }

    /**
     * Set the breadcrumb.
     *
     * @param $breadcrumb
     * @return $this
     */
    public function setBreadcrumb($breadcrumb)
    {
        $this->breadcrumb = $breadcrumb;

        return $this;
    }

    /**
     * Get the hidden flag.
     *
     * @return bool
     */
    public function isHidden()
    {
        return $this->hidden;
    }

    /**
     * Set the hidden flag.
     *
     * @param $hidden
     * @return $this
     */
    public function setHidden($hidden)
    {
        $this->hidden = $hidden;

        return $this;
    }

    /**
     * Get the HREF attribute.
     *
     * @param  null $path
     * @return string
     */
    public function getHref($path = null)
    {
        return ($this->getPermalink() ?: array_get($this->attributes, 'href')) . ($path ? '/' . $path : $path);
    }

    /**
     * Return the child sections.
     *
     * @return SectionCollection
     */
    public function getChildren()
    {
        return app(SectionCollection::class)->children($this->getSlug());
    }

    /**
     * Return whether the section
     * has children or not.
     *
     * @return bool
     */
    public function hasChildren()
    {
        return !$this->getChildren()->isEmpty();
    }
}


1			<?php namespace Anomaly\Streams\Platform\Ui\ControlPanel\Component\Section;
2
3			use Anomaly\Streams\Platform\Ui\ControlPanel\Component\Section\Contract\SectionInterface;
4
5			/**
6			* Class Section
7			*
8			* @link http://pyrocms.com/
9			* @author PyroCMS, Inc. <[email protected]>
10			* @author Ryan Thompson <[email protected]>
11			*/
12			class Section implements SectionInterface
13			{
14
15			/**
16			* The section slug.
17			*
18			* @var null\|string
19			*/
20			protected $slug = null;
21
22			/**
23			* The section icon.
24			*
25			* @var null\|string
26			*/
27			protected $icon = null;
28
29			/**
30			* The section title.
31			*
32			* @var null\|string
33			*/
34			protected $title = null;
35
36			/**
37			* The section label.
38			*
39			* @var null\|string
40			*/
41			protected $label = null;
42
43			/**
44			* The class.
45			*
46			* @var null\|string
47			*/
48			protected $class = null;
49
50			/**
51			* The active flag.
52			*
53			* @var bool
54			*/
55			protected $active = false;
56
57			/**
58			* The path matcher.
59			*
60			* @var null\|string
61			*/
62			protected $matcher = null;
63
64			/**
65			* The section permalink.
66			*
67			* @var null\|string
68			*/
69			protected $permalink = null;
70
71			/**
72			* The section description.
73			*
74			* @var null\|string
75			*/
76			protected $description = null;
77
78			/**
79			* The highlighted flag.
80			*
81			* @var bool
82			*/
83			protected $highlighted = false;
84
85			/**
86			* The section context.
87			*
88			* @var string
89			*/
90			protected $context = 'danger';
91
92			/**
93			* The section parent.
94			*
95			* @var null\|string
96			*/
97			protected $parent = null;
98
99			/**
100			* Section buttons. These are only to
101			* transport input to the button builder.
102			*
103			* @var array
104			*/
105			protected $buttons = [];
106
107			/**
108			* The section attributes.
109			*
110			* @var array
111			*/
112			protected $attributes = [];
113
114			/**
115			* The section permission.
116			*
117			* @var null\|string
118			*/
119			protected $permission = null;
120
121			/**
122			* The section breadcrumb.
123			*
124			* @var null\|string
125			*/
126			protected $breadcrumb = null;
127
128			/**
129			* If the section will be hidden from the Control Panel.
130			*
131			* @var bool
132			*/
133			protected $hidden = false;
134
135			/**
136			* Get the slug.
137			*
138			* @return null\|string
139			*/
140			public function getSlug()
141			{
142			return $this->slug;
143			}
144
145			/**
146			* Set the slug.
147			*
148			* @param $slug
149			* @return $this
150			*/
151			public function setSlug($slug)
152			{
153			$this->slug = $slug;
154
155			return $this;
156			}
157
158			/**
159			* Get the icon.
160			*
161			* @return null\|string
162			*/
163			public function getIcon()
164			{
165			return $this->icon;
166			}
167
168			/**
169			* Set the icon.
170			*
171			* @param $icon
172			* @return $this
173			*/
174			public function setIcon($icon)
175			{
176			$this->icon = $icon;
177
178			return $this;
179			}
180
181			/**
182			* Get the title.
183			*
184			* @return string
185			*/
186			public function getTitle()
187			{
188			return $this->title;
189			}
190
191			/**
192			* Set the title.
193			*
194			* @param string $title
195			*/
196			public function setTitle($title)
197			{
198			$this->title = $title;
199			}
200
201			/**
202			* Get the label.
203			*
204			* @return string
205			*/
206			public function getLabel()
207			{
208			return $this->label;
209			}
210
211			/**
212			* Set the label.
213			*
214			* @param string $label
215			* @return $this
216			*/
217			public function setLabel($label)
218			{
219			$this->label = $label;
220
221			return $this;
222			}
223
224			/**
225			* Get the class.
226			*
227			* @return string
228			*/
229			public function getClass()
230			{
231			return $this->class;
232			}
233
234			/**
235			* Set the class.
236			*
237			* @param $class
238			* @return $this
239			*/
240			public function setClass($class)
241			{
242			$this->class = $class;
243
244			return $this;
245			}
246
247			/**
248			* Get the active flag.
249			*
250			* @return boolean
251			*/
252			public function isActive()
253			{
254			return $this->active;
255			}
256
257			/**
258			* Set the active flag.
259			*
260			* @param boolean $active
261			*/
262			public function setActive($active)
263			{
264			$this->active = $active;
265
266			return $this;
267			}
268
269			/**
270			* Get the matcher.
271			*
272			* @return null\|string
273			*/
274			public function getMatcher()
275			{
276			return $this->matcher;
277			}
278
279			/**
280			* Set the matcher.
281			*
282			* @param $matcher
283			* @return $this
284			*/
285			public function setMatcher($matcher)
286			{
287			$this->matcher = $matcher;
288
289			return $this;
290			}
291
292			/**
293			* Get the permalink.
294			*
295			* @return null\|string
296			*/
297			public function getPermalink()
298			{
299			return $this->permalink;
300			}
301
302			/**
303			* Set the permalink.
304			*
305			* @param $permalink
306			* @return $this
307			*/
308			public function setPermalink($permalink)
309			{
310			$this->permalink = $permalink;
311
312			return $this;
313			}
314
315			/**
316			* Get the description.
317			*
318			* @return null\|string
319			*/
320			public function getDescription()
321			{
322			return $this->description;
323			}
324
325			/**
326			* Set the description.
327			*
328			* @param $description
329			* @return $this
330			*/
331			public function setDescription($description)
332			{
333			$this->description = $description;
334
335			return $this;
336			}
337
338			/**
339			* Get the highlighted flag.
340			*
341			* @return boolean
342			*/
343			public function isHighlighted()
344			{
345			return $this->highlighted;
346			}
347
348			/**
349			* Set the highlighted flag.
350			*
351			* @param boolean $active
			0 ignored issues – show Bug introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report There is no parameter named `$active`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
352			* @return $this
353			*/
354			public function setHighlighted($highlighted)
355			{
356			$this->highlighted = $highlighted;
357
358			return $this;
359			}
360
361			/**
362			* Get the context.
363			*
364			* @return boolean
365			*/
366			public function getContext()
367			{
368			return $this->context;
			0 ignored issues – show Bug Best Practice introduced 2017-03-26 03:54 UTC by Report Bug Copy Issue Report The return type of `return $this->context;` (`string`) is incompatible with the return type declared by the interface `Anomaly\Streams\Platform...onInterface::getContext` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
369			}
370
371			/**
372			* Set the context flag.
373			*
374			* @param boolean $active
			0 ignored issues – show Bug introduced 2017-03-26 03:54 UTC by Report Bug Copy Issue Report There is no parameter named `$active`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
375			* @return $this
376			*/
377			public function setContext($context)
378			{
379			$this->context = $context;
380
381			return $this;
382			}
383
384			/**
385			* Get the parent.
386			*
387			* @return null\|string
388			*/
389			public function getParent()
390			{
391			return $this->parent;
392			}
393
394			/**
395			* Return if the section is
396			* a sub-section or not.
397			*
398			* @return bool
399			*/
400			public function isSubSection()
401			{
402			return (bool)$this->getParent();
403			}
404
405			/**
406			* Set the parent.
407			*
408			* @param $parent
409			* @return $this
410			*/
411			public function setParent($parent)
412			{
413			$this->parent = $parent;
414
415			return $this;
416			}
417
418			/**
419			* Get the buttons.
420			*
421			* @return array
422			*/
423			public function getButtons()
424			{
425			return $this->buttons;
426			}
427
428			/**
429			* Set the buttons.
430			*
431			* @param array $buttons
432			*/
433			public function setButtons($buttons)
434			{
435			$this->buttons = $buttons;
436			}
437
438			/**
439			* Get the attributes.
440			*
441			* @return array
442			*/
443			public function getAttributes()
444			{
445			return $this->attributes;
446			}
447
448			/**
449			* Set the attributes.
450			*
451			* @param array $attributes
452			*/
453			public function setAttributes(array $attributes)
454			{
455			$this->attributes = $attributes;
456			}
457
458			/**
459			* Get the permission.
460			*
461			* @return null\|string
462			*/
463			public function getPermission()
464			{
465			return $this->permission;
466			}
467
468			/**
469			* Set the permission.
470			*
471			* @param $permission
472			* @return $this
473			*/
474			public function setPermission($permission)
475			{
476			$this->permission = $permission;
477
478			return $this;
479			}
480
481			/**
482			* Get the breadcrumb.
483			*
484			* @return null\|string
485			*/
486			public function getBreadcrumb()
487			{
488			return $this->breadcrumb;
489			}
490
491			/**
492			* Set the breadcrumb.
493			*
494			* @param $breadcrumb
495			* @return $this
496			*/
497			public function setBreadcrumb($breadcrumb)
498			{
499			$this->breadcrumb = $breadcrumb;
500
501			return $this;
502			}
503
504			/**
505			* Get the hidden flag.
506			*
507			* @return bool
508			*/
509			public function isHidden()
510			{
511			return $this->hidden;
512			}
513
514			/**
515			* Set the hidden flag.
516			*
517			* @param $hidden
518			* @return $this
519			*/
520			public function setHidden($hidden)
521			{
522			$this->hidden = $hidden;
523
524			return $this;
525			}
526
527			/**
528			* Get the HREF attribute.
529			*
530			* @param null $path
531			* @return string
532			*/
533			public function getHref($path = null)
534			{
535			return ($this->getPermalink() ?: array_get($this->attributes, 'href')) . ($path ? '/' . $path : $path);
536			}
537
538			/**
539			* Return the child sections.
540			*
541			* @return SectionCollection
542			*/
543			public function getChildren()
544			{
545			return app(SectionCollection::class)->children($this->getSlug());
546			}
547
548			/**
549			* Return whether the section
550			* has children or not.
551			*
552			* @return bool
553			*/
554			public function hasChildren()
555			{
556			return !$this->getChildren()->isEmpty();
557			}
558			}
559

anomalylabs / streams-platform

Push — master ( 98a062...441031 )

Section::getBreadcrumb() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like