DeniedTrait::removeDeniedItems() - Code Metrics - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

DeniedTrait::removeDeniedItems() A
last analyzed 2023-06-17 08:58 UTC

↳ Parent: DeniedTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	1
cts	1
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * php version 7.1.0
 *
 * @category  Web-security
 * @package   Shieldon
 * @author    Terry Lin <[email protected]>
 * @copyright 2019 terrylinooo
 * @license   https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
 * @link      https://github.com/terrylinooo/shieldon
 * @see       https://shieldon.io
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Component;

use function array_keys;
use function array_push;
use function in_array;
use function strpos;

/*
 * Denied trait.
 */
trait DeniedTrait
{
    /**
     *   Public methods       | Desctiotion
     *  ----------------------|---------------------------------------------
     *   setDeniedItems       | Add items to the blacklist pool.
     *   setDeniedItem        | Add an item to the blacklist pool.
     *   getDeniedItems       | Get items from the blacklist pool.
     *   getDeniedItem        | Get an item from the blacklist pool.
     *   removeDeniedItem     | Remove a denied item if exists.
     *   removeDeniedItems    | Remove all denied items.
     *   hasDeniedItem        | Check if a denied item exists.
     *   getDenyWithPrefix    | Check if a denied items exist with the same prefix.
     *   removeDenyWithPrefix | Remove denied items with the same prefix.
     *   isDenied             | Check if an item is denied?
     *  ----------------------|---------------------------------------------
     */

    /**
     * Data pool for hard blacklist.
     *
     * @var array
     */
    protected $deniedList = [];

    /**
     * Add items to the blacklist pool.
     *
     * @param array $itemList String list.
     *
     * @return void
     */
    public function setDeniedItems(array $itemList): void
    {
        $this->deniedList = $itemList;
    }

    /**
     * Add an item to the blacklist pool.
     *
     * @param string|array $value The value of the data.
     * @param string       $key   The key of the data.
     *
     * @return void
     */
    public function setDeniedItem($value, string $key = ''): void
    {
        if (!empty($key)) {
            $this->deniedList[$key] = $value;
        } elseif (!in_array($value, $this->deniedList)) {
            array_push($this->deniedList, $value);
        }
    }

    /**
     * Get items from the blacklist pool.
     *
     * @return array
     */
    public function getDeniedItems(): array
    {
        return $this->deniedList;
    }

    /**
     * Get an item from the blacklist pool.
     *
     * @param string $key The key of the data field.
     *
     * @return string|array
     */
    public function getDeniedItem(string $key)
    {
        return $this->deniedList[$key] ?? '';
    }

    /**
     * Remove a denied item if exists.
     *
     * @param string $key The key of the data.
     *
     * @return string
     */
    public function removeDeniedItem(string $key): void
    {
        unset($this->deniedList[$key]);
    }

    /**
     * Remove all denied items.
     *
     * @return void
     */
    public function removeDeniedItems(): void
    {
        $this->deniedList = [];
    }

    /**
     * Check if a denied item exists.
     *
     * @param string $key The key of the data.
     *
     * @return bool
     */
    public function hasDeniedItem(string $key): bool
    {
        return isset($this->deniedList[$key]);
    }

    /**
     * Check if a denied items exist with the same prefix.
     *
     * @param string $key The key of the data.
     *
     * @return array
     */
    public function getDenyWithPrefix(string $key): array
    {
        $temp = [];
        foreach ($this->deniedList as $keyName => $value) {
            if (strpos($keyName, $key) === 0) {
                $temp[$keyName] = $value;
            }
        }
        return $temp;
    }

    /**
     * Remove denied items with the same prefix.
     *
     * @param string $key The key of the data.
     *
     * @return void
     */
    public function removeDenyWithPrefix(string $key): void
    {
        foreach (array_keys($this->deniedList) as $keyName) {
            if (strpos($keyName, $key) === 0) {
                unset($this->deniedList[$keyName]);
            }
        }
    }

    // @codeCoverageIgnoreStart

    /**
     * Is denied?
     * This method should adjust in extended class if need.
     *
     * @return bool
     */
    public function isDenied(): bool
    {
        return false;
    }

    // @codeCoverageIgnoreEnd
}


1		<?php
2		/**
3		* This file is part of the Shieldon package.
4		*
5		* (c) Terry L. <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		* php version 7.1.0
11		*
12		* @category Web-security
13		* @package Shieldon
14		* @author Terry Lin <[email protected]>
15		* @copyright 2019 terrylinooo
16		* @license https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
17		* @link https://github.com/terrylinooo/shieldon
18		* @see https://shieldon.io
19		*/
20
21		declare(strict_types=1);
22
23		namespace Shieldon\Firewall\Component;
24
25		use function array_keys;
26		use function array_push;
27		use function in_array;
28		use function strpos;
29
30		/*
31		* Denied trait.
32		*/
33		trait DeniedTrait
34		{
35		/**
36		* Public methods \| Desctiotion
37		* ----------------------\|---------------------------------------------
38		* setDeniedItems \| Add items to the blacklist pool.
39		* setDeniedItem \| Add an item to the blacklist pool.
40		* getDeniedItems \| Get items from the blacklist pool.
41		* getDeniedItem \| Get an item from the blacklist pool.
42		* removeDeniedItem \| Remove a denied item if exists.
43		* removeDeniedItems \| Remove all denied items.
44		* hasDeniedItem \| Check if a denied item exists.
45		* getDenyWithPrefix \| Check if a denied items exist with the same prefix.
46		* removeDenyWithPrefix \| Remove denied items with the same prefix.
47		* isDenied \| Check if an item is denied?
48		* ----------------------\|---------------------------------------------
49		*/
50
51		/**
52		* Data pool for hard blacklist.
53		*
54		* @var array
55		*/
56		protected $deniedList = [];
57
58		/**
59		* Add items to the blacklist pool.
60		*
61		* @param array $itemList String list.
62		*
63		* @return void
64		*/
65	87	public function setDeniedItems(array $itemList): void
66		{
67	87	$this->deniedList = $itemList;
68		}
69
70		/**
71		* Add an item to the blacklist pool.
72		*
73		* @param string\|array $value The value of the data.
74		* @param string $key The key of the data.
75		*
76		* @return void
77		*/
78	9	public function setDeniedItem($value, string $key = ''): void
79		{
80	9	if (!empty($key)) {
81	2	$this->deniedList[$key] = $value;
82		} elseif (!in_array($value, $this->deniedList)) {
83	7	array_push($this->deniedList, $value);
84	7	}
85		}
86
87		/**
88		* Get items from the blacklist pool.
89		*
90		* @return array
91		*/
92		public function getDeniedItems(): array
93	18	{
94		return $this->deniedList;
95	18	}
96
97		/**
98		* Get an item from the blacklist pool.
99		*
100		* @param string $key The key of the data field.
101		*
102		* @return string\|array
103		*/
104		public function getDeniedItem(string $key)
105	1	{
106		return $this->deniedList[$key] ?? '';
107	1	}
108
109		/**
110		* Remove a denied item if exists.
111		*
112		* @param string $key The key of the data.
113		*
114		* @return string
115		*/
116		public function removeDeniedItem(string $key): void
117	3	{
118		unset($this->deniedList[$key]);
119	3	}
120
121		/**
122		* Remove all denied items.
123		*
124		* @return void
125		*/
126		public function removeDeniedItems(): void
127	2	{
128		$this->deniedList = [];
129	2	}
130
131		/**
132		* Check if a denied item exists.
133		*
134		* @param string $key The key of the data.
135		*
136		* @return bool
137		*/
138		public function hasDeniedItem(string $key): bool
139	1	{
140		return isset($this->deniedList[$key]);
141	1	}
142
143		/**
144		* Check if a denied items exist with the same prefix.
145		*
146		* @param string $key The key of the data.
147		*
148		* @return array
149		*/
150		public function getDenyWithPrefix(string $key): array
151	1	{
152		$temp = [];
153	1	foreach ($this->deniedList as $keyName => $value) {
154	1	if (strpos($keyName, $key) === 0) {
155	1	$temp[$keyName] = $value;
156	1	}
157		}
158		return $temp;
159	1	}
160
161		/**
162		* Remove denied items with the same prefix.
163		*
164		* @param string $key The key of the data.
165		*
166		* @return void
167		*/
168		public function removeDenyWithPrefix(string $key): void
169	1	{
170		foreach (array_keys($this->deniedList) as $keyName) {
171	1	if (strpos($keyName, $key) === 0) {
172	1	unset($this->deniedList[$keyName]);
173	1	}
174		}
175		}
176
177		// @codeCoverageIgnoreStart
178
179		/**
180		* Is denied?
181		* This method should adjust in extended class if need.
182		*
183		* @return bool
184		*/
185		public function isDenied(): bool
186		{
187		return false;
188		}
189
190		// @codeCoverageIgnoreEnd
191		}
192

terrylinooo / shieldon

DeniedTrait::removeDeniedItems() A last analyzed 2023-06-17 08:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DeniedTrait::removeDeniedItems() A
last analyzed 2023-06-17 08:58 UTC