MenuItem::isHidden() - Code Metrics - Inspection of "Refactor active state and streamline the whole API..." - rinvex/laravel-menus - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( e25e8d...0bf4e9 )

by Abdelrahman
created 2017-12-21 18:01 UTC
MenuItem::isHidden() A

↳ Parent: MenuItem
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	2
eloc	2
nc	2
nop	0
<?php

declare(strict_types=1);

namespace Rinvex\Menus\Models;

use Illuminate\Support\Facades\Route;
use Collective\Html\HtmlFacade as HTML;
use Illuminate\Support\Facades\Request;

class MenuItem
{
    /**
     * The properties array.
     *
     * @var array
     */
    public $properties = [];

    /**
     * The childs collection.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $childs;

    /**
     * The hide callback.
     *
     * @var callable
     */
    protected $hideWhen;

    /**
     * The active callback.
     *
     * @var callable
     */
    protected $activeWhen;

    /**
     * Constructor.
     *
     * @param array $properties
     */
    public function __construct($properties = [])
    {
        $this->fill($properties);
        $this->childs = collect();
    }

    /**
     * Get property.
     *
     * @param string $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        return data_get($this->properties, $key);
    }

    /**
     * Fill the properties.
     *
     * @param array $properties
     *
     * @return static
     */
    public function fill($properties)
    {
        $this->properties = array_merge($this->properties, $properties);

        return $this;
    }

    /**
     * Create new menu with dropdown.
     *
     * @param callable $callback
     * @param string   $title
     * @param int      $order

     * @param string   $icon

     * @param array    $attributes
     *
     * @return static
     */
    public function dropdown(callable $callback, string $title, int $order = null, string $icon = null, array $attributes = [])

    {
        call_user_func($callback, $item = $this->add(compact('title', 'order', 'icon', 'attributes')));

        return $item;
    }

    /**
     * Register new menu item using registered route.
     *
     * @param string $route

     * @param string $title
     * @param int    $order

     * @param string $icon

     * @param array  $attributes
     *
     * @return static
     */
    public function route(array $route, string $title, int $order = null, string $icon = null, array $attributes = [])
    {
        return $this->add(compact('route', 'title', 'order', 'icon', 'attributes'));
    }

    /**
     * Register new menu item using url.
     *
     * @param string $url
     * @param string $title
     * @param int    $order

     * @param string $icon

     * @param array  $attributes
     *
     * @return static
     */
    public function url(string $url, string $title, int $order = null, string $icon = null, array $attributes = [])
    {
        return $this->add(compact('url', 'title', 'order', 'icon', 'attributes'));
    }

    /**
     * Add new header item.
     *
     * @param string $title
     * @param int    $order

     * @param string $icon

     * @param array  $attributes
     *
     * @return static
     */
    public function header(string $title, int $order = null, string $icon = null, array $attributes = [])
    {
        $type = 'header';

        return $this->add(compact('type', 'url', 'title', 'order', 'icon', 'attributes'));
    }

    /**
     * Add new divider item.
     *
     * @param int   $order

     * @param array $attributes
     *
     * @return static
     */
    public function divider(int $order = null, array $attributes = [])
    {
        return $this->add(['type' => 'divider', 'order' => $order, 'attributes' => $attributes]);
    }

    /**
     * Get childs.
     *
     * @return \Illuminate\Support\Collection
     */
    public function getChilds()
    {
        return $this->childs->sortBy('properties.order');
    }

    /**
     * Get url.
     *
     * @return string

     */
    public function getUrl()
    {
        return $this->route ? route($this->route[0], $this->route[1] ?? []) : ($this->url ? url($this->url) : '');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Get HTML attribute data.
     *
     * @return mixed
     */
    public function getAttributes()
    {
        return HTML::attributes($this->attributes);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Check if the current item is divider.
     *
     * @return bool
     */
    public function isDivider(): bool
    {
        return $this->type === 'divider';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Check if the current item is header.
     *
     * @return bool
     */
    public function isHeader(): bool
    {
        return $this->type === 'header';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Check is the current item has sub menu .
     *
     * @return bool
     */
    public function hasChilds()
    {
        return $this->childs->isNotEmpty();
    }

    /**
     * Check the active state for current menu.
     *
     * @return bool
     */
    public function hasActiveOnChild()
    {
        return $this->hasChilds() ? $this->hasActiveStateFromChilds() : false;
    }

    /**
     * Set hide callback for current menu item.
     *
     * @param callable $callback
     *
     * @return $this
     */
    public function hideWhen(callable $callback)
    {
        $this->hideWhen = $callback;

        return $this;
    }

    /**
     * Set authorization callback for current menu item.
     *
     * @param string $ability
     * @param mixed  $params
     *
     * @return $this
     */
    public function ifCan(string $ability, $params = null)
    {
        $this->hideWhen = function () use ($ability, $params) {
            return ! auth()->user()->can($ability, $params);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        };

        return $this;
    }

    /**
     * Set authentication callback for current menu item.
     *
     * @return $this
     */
    public function ifUser()
    {
        $this->hideWhen = function () {
            return ! auth()->user();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        };

        return $this;
    }

    /**
     * Set authentication callback for current menu item.
     *
     * @return $this
     */
    public function ifGuest()
    {
        $this->hideWhen = function () {
            return auth()->user();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        };

        return $this;
    }

    /**
     * Check if the menu item is hidden.
     *
     * @return bool
     */
    public function isHidden()
    {
        return $this->hideWhen ? (bool) call_user_func($this->hideWhen) : false;
    }

    /**
     * Get active state for current item.
     *
     * @return bool
     */
    public function isActive()
    {
        if (is_callable($activeWhen = $this->activeWhen)) {
            return call_user_func($activeWhen);
        }

        if ($this->route) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return $this->hasActiveStateFromRoute();
        }

        return $this->hasActiveStateFromUrl();
    }

    /**
     * Set active callback.
     *
     * @param callable $route
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return $this
     */
    public function activateWhen(callable $callback)
    {
        $this->activeWhen = $callback;

        return $this;
    }

    /**
     * Set active callback on the given route.
     *
     * @param string $route
     *
     * @return $this
     */
    public function activateOnRoute(string $route)
    {
        $this->activeWhen = function () use ($route) {
            return str_contains(Route::currentRouteName(), $route);
        };

        return $this;
    }

    /**
     * Add new child item.
     *
     * @param array $properties
     *
     * @return static
     */
    protected function add(array $properties = [])
    {
        $properties['attributes']['id'] = $properties['attributes']['id'] ?? md5(json_encode($properties));
        $this->childs->push($item = new static($properties));

        return $item;
    }

    /**
     * Get active status using route.
     *
     * @return bool
     */
    protected function hasActiveStateFromRoute(): bool
    {
        return Route::is($this->route);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Get active status using request url.
     *
     * @return bool
     */
    protected function hasActiveStateFromUrl(): bool
    {
        return Request::is($this->url);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Check if the item has active state from childs.
     *
     * @return bool
     */
    protected function hasActiveStateFromChilds(): bool
    {
        return $this->getChilds()->contains(function (MenuItem $child) {
                return ($child->hasChilds() && $child->hasActiveStateFromChilds())
                       || ($child->route && $child->hasActiveStateFromRoute())
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                       || $child->isActive() || $child->hasActiveStateFromUrl();
            }) ?? false;
    }
}

Push — develop ( e25e8d...0bf4e9 )

MenuItem::isHidden() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			declare(strict_types=1);
4
5			namespace Rinvex\Menus\Models;
6
7			use Illuminate\Support\Facades\Route;
8			use Collective\Html\HtmlFacade as HTML;
9			use Illuminate\Support\Facades\Request;
10
11			class MenuItem
12			{
13			/**
14			* The properties array.
15			*
16			* @var array
17			*/
18			public $properties = [];
19
20			/**
21			* The childs collection.
22			*
23			* @var \Illuminate\Support\Collection
24			*/
25			protected $childs;
26
27			/**
28			* The hide callback.
29			*
30			* @var callable
31			*/
32			protected $hideWhen;
33
34			/**
35			* The active callback.
36			*
37			* @var callable
38			*/
39			protected $activeWhen;
40
rinvex / laravel-menus

Push — develop ( e25e8d...0bf4e9 )

MenuItem::isHidden() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
