ActiveChecker::__construct() - Code Metrics - Inspection of "Improve Active Checker Class" - jeroennoten/Laravel-AdminLTE - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#637)

by Diego

created 2020-06-15 22:09 UTC

ActiveChecker::__construct() A

↳ Parent: ActiveChecker

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
ccs	4
cts	4
cp	1
cc	1
nc	1
nop	2
crap	1

<?php

namespace JeroenNoten\LaravelAdminLte\Menu;

use Illuminate\Contracts\Routing\UrlGenerator;
use Illuminate\Http\Request;
use Illuminate\Support\Str;

class ActiveChecker
{
    /**
     * The request instance.
     *
     * @var Request
     */
    private $request;

    /**
     * The url generator instance.
     *
     * @var UrlGenerator
     */
    private $url;

    /**
     * Constructor.
     *
     * @param Request $request
     * @param UrlGenerator $url
     */
    public function __construct(Request $request, UrlGenerator $url)

    {
        $this->request = $request;
        $this->url = $url;
    }

    /**
     * Checks if a menu item is currently active. Active items will be
     * highlighted.
     *
     * @param mixed $item The menu item to check
     * @return bool
     */
    public function isActive($item)
    {
        if (isset($item['submenu'])) {
            return $this->containsActive($item['submenu']);
        } elseif (isset($item['active'])) {
            return $this->isExplicitActive($item['active']);
        } elseif (isset($item['href'])) {
            return $this->checkPattern($item['href']);
        } elseif (isset($item['url'])) {
            // Support URL for backwards compatibility.
            return $this->checkPattern($item['url']);
        }

        return false;
    }

    /**
     * Checks if an array of items contains an active item.
     *
     * @param array $items The items to check
     * @return bool
     */
    protected function containsActive($items)
    {
        foreach ($items as $item) {
            if ($this->isActive($item)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Checks if an item is active by explicit definition of 'active' state.
     *
     * @param bool|array $activeDef
     * @return bool
     */
    protected function isExplicitActive($activeDef)
    {
        // If the active definition is a bool, return it.

        if (is_bool($activeDef)) {
            return $activeDef;
        }

        // Otherwise, check if any of the url patterns that defines the active
        // state matches the requested url.

        foreach ($activeDef as $pattern) {
            if ($this->checkPattern($pattern)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Checks if an url pattern matches the requested url.
     *
     * @param string $pattern
     * @return bool
     */
    protected function checkPattern($pattern)
    {
        // First, check if the pattern is a regular expression.

        if (Str::startsWith($pattern, 'regex:')) {
            $regex = Str::substr($pattern, 6);
            return (bool) preg_match($regex, $this->request->path());
        }

        // If pattern is not a regex, check if the requested url matches the
        // absolute path to the given pattern.

        return Str::is($this->url->to($pattern), $this->request->url());
    }
}


1		<?php
2
3		namespace JeroenNoten\LaravelAdminLte\Menu;
4
5		use Illuminate\Contracts\Routing\UrlGenerator;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Str;
8
9		class ActiveChecker
10		{
11		/**
12		* The request instance.
13		*
14		* @var Request
15		*/
16		private $request;
17
18		/**
19		* The url generator instance.
20		*
21		* @var UrlGenerator
22		*/
23		private $url;
24
25		/**
26		* Constructor.
27		*
28		* @param Request $request
29		* @param UrlGenerator $url
30		*/
31	56	public function __construct(Request $request, UrlGenerator $url)
		0 ignored issues – show Bug introduced 2017-08-02 21:10 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
32		{
33	56	$this->request = $request;
34	56	$this->url = $url;
35	56	}
36
37		/**
38		* Checks if a menu item is currently active. Active items will be
39		* highlighted.
40		*
41		* @param mixed $item The menu item to check
42		* @return bool
43		*/
44	55	public function isActive($item)
45		{
46	55	if (isset($item['submenu'])) {
47	18	return $this->containsActive($item['submenu']);
48	52	} elseif (isset($item['active'])) {
49	19	return $this->isExplicitActive($item['active']);
50	48	} elseif (isset($item['href'])) {
51	36	return $this->checkPattern($item['href']);
52	12	} elseif (isset($item['url'])) {
53		// Support URL for backwards compatibility.
54	11	return $this->checkPattern($item['url']);
55		}
56
57	1	return false;
58		}
59
60		/**
61		* Checks if an array of items contains an active item.
62		*
63		* @param array $items The items to check
64		* @return bool
65		*/
66	18	protected function containsActive($items)
67		{
68	18	foreach ($items as $item) {
69	15	if ($this->isActive($item)) {
70	3	return true;
71		}
72		}
73
74	15	return false;
75		}
76
77		/**
78		* Checks if an item is active by explicit definition of 'active' state.
79		*
80		* @param bool\|array $activeDef
81		* @return bool
82		*/
83	19	protected function isExplicitActive($activeDef)
84		{
85		// If the active definition is a bool, return it.
86
87	19	if (is_bool($activeDef)) {
88	13	return $activeDef;
89		}
90
91		// Otherwise, check if any of the url patterns that defines the active
92		// state matches the requested url.
93
94	6	foreach ($activeDef as $pattern) {
95	6	if ($this->checkPattern($pattern)) {
96	5	return true;
97		}
98		}
99
100	4	return false;
101		}
102
103		/**
104		* Checks if an url pattern matches the requested url.
105		*
106		* @param string $pattern
107		* @return bool
108		*/
109	51	protected function checkPattern($pattern)
110		{
111		// First, check if the pattern is a regular expression.
112
113	51	if (Str::startsWith($pattern, 'regex:')) {
114	1	$regex = Str::substr($pattern, 6);
115	1	return (bool) preg_match($regex, $this->request->path());
116		}
117
118		// If pattern is not a regex, check if the requested url matches the
119		// absolute path to the given pattern.
120
121	50	return Str::is($this->url->to($pattern), $this->request->url());
122		}
123		}
124

jeroennoten / Laravel-AdminLTE

Pull Request — master (#637)

ActiveChecker::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like