Container::setActive() - Code Metrics - JumpGateio/Menu - Measure and Improve Code Quality continuously with Scrutinizer

Container::setActive() A
last analyzed 2020-01-03 18:08 UTC

↳ Parent: Container

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace JumpGate\Menu;

use Illuminate\Support\Collection;

/**
 * Class Container
 *
 * @package JumpGate\Menu
 */
class Container extends Collection
{
    /**
     * The slug to set to active during render
     *
     * @var array
     */
    private $active = [];

    /**
     * Get a menu you have created.
     *
     * @param $menuName
     *
     * @return mixed
     */
    public function getMenu($menuName)
    {
        $menu = $this->getMenuObject($menuName);
        if ($menu) {
            return $menu;
        } else {
            return $this->add($menuName);
        }
    }

    /**
     * Add a new menu.
     *
     * @param $menuName
     *
     * @return Menu
     */
    public function add($menuName)
    {
        return $this->items[] = new Menu($this->snakeName($menuName));
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());
}
    }

    /**
     * Check if a menu exists.
     *
     * @param $menuName
     *
     * @return bool
     */
    public function exists($menuName)
    {
        return (bool)$this->getMenuObject($menuName);
    }

    /**
     * Check if a menu is empty
     *
     * @param $menuName
     *
     * @return bool
     */
    public function hasLinks($menuName)
    {
        return (count($this->getMenuObject($menuName)->links) > 0);
    }

    /**
     * Update the active and order values and then return the object.
     *
     * @param $menuName
     *
     * @return Menu
     * @throws \Exception
     */
    public function render($menuName)
    {
        // We set active at the last possible moment.
        $this->updateActive();

        $menu = $this->getMenuObject($menuName);

        if (! $menu) {
            throw new \Exception("Menu {$menuName} not found.");
        }

        return $menu;
    }

    /**
     * Sanitize the menus names for safe use in array keys.
     *
     * @param $name
     *
     * @return string
     */
    public function snakeName($name)
    {
        return e(snake_case($name));
    }

    /**
     * Get the menu object
     *
     * @param $menuName
     *
     * @return mixed|null
     */
    private function getMenuObject($menuName)
    {
        return $this->where('name', $this->snakeName($menuName))->first();
    }

    /**
     * Get the active link by slug.
     *
     * @return array
     */
    public function getActive()
    {
        return $this->active;
    }

    /**
     * Set the active link by slug.
     *
     * @param $slug
     */
    public function setActive($slug)
    {
        $this->active = explode('::', $slug);
    }

    /**
     * Use the active param and set the link to active
     */
    private function updateActive()
    {
        $this->each(function ($item) {
            if (isset($item->links)) {
                $this->makeActive($item);
            }
        });
    }

    /**
     * Loop through the links and check for active.
     * Sets the item and it's parents as active when told to.
     */
    private function makeActive($item, $parent = null)
    {
        $item->links->each(function ($link) use ($item, $parent) {
            if (in_array($link->slug, $this->active)) {
                $this->makeParentActive($parent);
                $this->makeParentActive($item);

                $link->setActive(true);
            }

            if (isset($link->links)) {
                $this->makeActive($link, $item);
            }
        });
    }

    /**
     * Set the parent item as active if able to do so.
     */
    private function makeParentActive($parent)
    {
        if (! is_null($parent)
            && method_exists($parent, 'activeParentage')
            && $parent->activeParentage()
        ) {
            $parent->setActive(true);
        }
    }
}


1			<?php
2
3			namespace JumpGate\Menu;
4
5			use Illuminate\Support\Collection;
6
7			/**
8			* Class Container
9			*
10			* @package JumpGate\Menu
11			*/
12			class Container extends Collection
13			{
14			/**
15			* The slug to set to active during render
16			*
17			* @var array
18			*/
19			private $active = [];
20
21			/**
22			* Get a menu you have created.
23			*
24			* @param $menuName
25			*
26			* @return mixed
27			*/
28			public function getMenu($menuName)
29			{
30			$menu = $this->getMenuObject($menuName);
31			if ($menu) {
32			return $menu;
33			} else {
34			return $this->add($menuName);
35			}
36			}
37
38			/**
39			* Add a new menu.
40			*
41			* @param $menuName
42			*
43			* @return Menu
44			*/
45			public function add($menuName)
46			{
47			return $this->items[] = new Menu($this->snakeName($menuName));
			0 ignored issues – show Bug Best Practice introduced 2019-07-20 05:21 UTC by Report Bug Copy Issue Report The return type of `return $this->items[] = ...>snakeName($menuName));` (`JumpGate\Menu\Menu`) is incompatible with the return type of the parent method `Illuminate\Support\Collection::add` of type `Illuminate\Support\Collection`. 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...
48			}
49
50			/**
51			* Check if a menu exists.
52			*
53			* @param $menuName
54			*
55			* @return bool
56			*/
57			public function exists($menuName)
58			{
59			return (bool)$this->getMenuObject($menuName);
60			}
61
62			/**
63			* Check if a menu is empty
64			*
65			* @param $menuName
66			*
67			* @return bool
68			*/
69			public function hasLinks($menuName)
70			{
71			return (count($this->getMenuObject($menuName)->links) > 0);
72			}
73
74			/**
75			* Update the active and order values and then return the object.
76			*
77			* @param $menuName
78			*
79			* @return Menu
80			* @throws \Exception
81			*/
82			public function render($menuName)
83			{
84			// We set active at the last possible moment.
85			$this->updateActive();
86
87			$menu = $this->getMenuObject($menuName);
88
89			if (! $menu) {
90			throw new \Exception("Menu {$menuName} not found.");
91			}
92
93			return $menu;
94			}
95
96			/**
97			* Sanitize the menus names for safe use in array keys.
98			*
99			* @param $name
100			*
101			* @return string
102			*/
103			public function snakeName($name)
104			{
105			return e(snake_case($name));
106			}
107
108			/**
109			* Get the menu object
110			*
111			* @param $menuName
112			*
113			* @return mixed\|null
114			*/
115			private function getMenuObject($menuName)
116			{
117			return $this->where('name', $this->snakeName($menuName))->first();
118			}
119
120			/**
121			* Get the active link by slug.
122			*
123			* @return array
124			*/
125			public function getActive()
126			{
127			return $this->active;
128			}
129
130			/**
131			* Set the active link by slug.
132			*
133			* @param $slug
134			*/
135			public function setActive($slug)
136			{
137			$this->active = explode('::', $slug);
138			}
139
140			/**
141			* Use the active param and set the link to active
142			*/
143			private function updateActive()
144			{
145			$this->each(function ($item) {
146			if (isset($item->links)) {
147			$this->makeActive($item);
148			}
149			});
150			}
151
152			/**
153			* Loop through the links and check for active.
154			* Sets the item and it's parents as active when told to.
155			*/
156			private function makeActive($item, $parent = null)
157			{
158			$item->links->each(function ($link) use ($item, $parent) {
159			if (in_array($link->slug, $this->active)) {
160			$this->makeParentActive($parent);
161			$this->makeParentActive($item);
162
163			$link->setActive(true);
164			}
165
166			if (isset($link->links)) {
167			$this->makeActive($link, $item);
168			}
169			});
170			}
171
172			/**
173			* Set the parent item as active if able to do so.
174			*/
175			private function makeParentActive($parent)
176			{
177			if (! is_null($parent)
178			&& method_exists($parent, 'activeParentage')
179			&& $parent->activeParentage()
180			) {
181			$parent->setActive(true);
182			}
183			}
184			}
185

JumpGateio / Menu

Container::setActive() A last analyzed 2020-01-03 18:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Container::setActive() A
last analyzed 2020-01-03 18:08 UTC