IteratorDot::get() - Code Metrics - Inspection of "add class ValidateDot" - knut7/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1785b4...1ac661 )

by Marcio

created 2020-06-26 20:52 UTC

IteratorDot::get() B

↳ Parent: IteratorDot

Complexity

Conditions	7
Paths	6

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	12
dl	0
loc	19
rs	8.8333
c	1
b	0
f	0
cc	7
nc	6
nop	2

<?php

/**
 * Dot - PHP dot notation access to arrays
 *
 * @author  Riku Särkinen <[email protected]>
 * @link    https://github.com/adbario/php-dot-notation
 * @license https://github.com/adbario/php-dot-notation/blob/2.x/LICENSE.md (MIT License)
 */

namespace Ballybran\Core\Collections\Collection;
use Ballybran\Core\Collections\Collection\ValidateDot;

use ArrayIterator;

/**
 * Dot
 *
 * This class provides a dot notation access and helper functions for
 * working with arrays of data. Inspired by Laravel Collection.
 */
class IteratorDot extends ValidateDot
{
    /**
     * The stored items
     *
     * @var array
     */
    protected $items = [];
    
    /**
     *  elements
     *
     * @var array
     */
    protected $elements;

    /**
     * Create a new Dot instance
     *
     * @param mixed $items
     */
    public function __construct($items = [])
    {
        $this->elements = $this->getArrayItems($items);
    }

    /**
     * Set a given key / value pair or pairs
     * if the key doesn't exist already
     *
     * @param array|int|string $keys
     * @param mixed $value
     */
    public function add($keys, $value = null)
    {
        if (is_array($keys)) {
            foreach ($keys as $key => $value) {
                $this->add($key, $value);
            }
        } elseif (is_null($this->get($keys))) {
            $this->set($keys, $value);
        }
    }

    /**
     * Delete the contents of a given key or keys
     *
     * @param array|int|string|null $keys
     */
    public function clear($keys = null)
    {
        if (is_null($keys)) {
            $this->elements = [];
            return;
        }
        $keys = (array)$keys;
        foreach ($keys as $key) {
            $this->set($key, []);
        }
    }

    /**
     * Delete the given key or keys
     *
     * @param array|int|string $keys
     */
    public function delete($keys)
    {
        $keys = (array)$keys;
        foreach ($keys as $key) {
            if ($this->exists($this->elements, $key)) {
                unset($this->elements[$key]);
                continue;
            }
            $items = &$this->elements;
            $segments = explode('.', $key);
            $lastSegment = array_pop($segments);
            foreach ($segments as $segment) {
                if (!isset($items[$segment]) || !is_array($items[$segment])) {
                    continue 2;
                }
                $items = &$items[$segment];
            }
            unset($items[$lastSegment]);
        }
    }

    /**
     * Flatten an array with the given character as a key delimiter
     *
     * @param  string $delimiter
     * @param  array|null $items
     * @param  string $prepend
     * @return array
     */
    public function flatten($delimiter = '.', $items = null, $prepend = '')
    {
        $flatten = [];
        if (is_null($items)) {
            $items = $this->elements;
        }
        foreach ($items as $key => $value) {
            if (is_array($value) && !empty($value)) {
                $flatten = array_merge(
                    $flatten,
                    $this->flatten($delimiter, $value, $prepend . $key . $delimiter)
                );
            } else {
                $flatten[$prepend . $key] = $value;
            }
        }
        return $flatten;
    }

    /**
     * Return the value of a given key
     *
     * @param  int|string|null $key
     * @param  mixed $default
     * @return mixed
     */
    public function get($key = null, $default = null)
    {
        if (is_null($key)) {
            return $this->elements;
        }
        if ($this->exists($this->elements, $key)) {
            return $this->elements[$key];
        }
        if (false === strpos($key, '.')) {
            return $default;
        }
        $items = $this->elements;
        foreach (explode('.', $key) as $segment) {
            if (!is_array($items) || !$this->exists($items, $segment)) {
                return $default;
            }
            $items = &$items[$segment];
        }
        return $items;
    }

    /**
     * Return the given items as an array
     *
     * @param  mixed $items
     * @return array
     */
    protected function getArrayItems($items)
    {
        if (is_array($items)) {
            return $items;
        } elseif ($items instanceof self) {
            return $items->all();
        }
        return (array)$items;
    }

    /**
     * Check if a given key or keys exists
     *
     * @param  array|int|string $keys
     * @return bool
     */
    public function has($keys)
    {
        $keys = (array)$keys;
        if ( empty($this->elements) || $keys === []) {
            return false;
        }
        foreach ($keys as $key) {
            $items = $this->elements;
            if ($this->exists($items, $key)) {
                continue;
            }
            foreach (explode('.', $key) as $segment) {
                if (!is_array($items) || !$this->exists($items, $segment)) {
                    return false;
                }
                $items = $items[$segment];
            }
        }
        return true;
    }

    /**
     * Check if a given key or keys are empty
     *
     * @param  array|int|string|null $keys
     * @return bool
     */
    public function isEmpty($keys = null)
    {
        if (is_null($keys)) {
            return empty($this->elements);
        }
        $keys = (array)$keys;
        foreach ($keys as $key) {
            if (!empty($this->get($key))) {
                return false;
            }
        }
        return true;
    }

    /**
     * Merge a given array or a Dot object with the given key
     * or with the whole Dot object
     *
     * @param array|string|self $key
     * @param array $value
     */
    public function merge($key, $value = null)
    {
        if (is_array($key)) {
            $this->elements = array_merge($this->elements, $key);
        } elseif (is_string($key)) {
            $items = (array)$this->get($key);
            $value = array_merge($items, $this->getArrayItems($value));
            $this->set($key, $value);
        } 
         $this->elements = array_merge($this->elements, $key->all());
        
    }

    /**
     * Return the value of a given key and
     * delete the key
     *
     * @param  int|string|null $key
     * @param  mixed $default
     * @return mixed
     */
    public function pull($key = null, $default = null)
    {
        if (is_null($key)) {
            $value = $this->all();
            $this->clear();
            return $value;
        }
        $value = $this->get($key, $default);
        $this->delete($key);
        return $value;
    }

    /**
     * Push a given value to the end of the array
     * in a given key
     *
     * @param mixed $key
     * @param mixed $value
     */
    public function push($key, $value = null)
    {
        if (is_null($value)) {
            $this->elements[] = $key;
            return;
        }
        $items = $this->get($key);
        if (is_array($items) || is_null($items)) {
            $items[] = $value;
            $this->set($key, $items);
        }
    }

    /**
     * Set a given key / value pair or pairs
     *
     * @param array|int|string $keys
     * @param mixed $value
     */
    public function set($keys, $value = null)
    {
        if (is_array($keys)) {
            foreach ($keys as $key => $value) {
                $this->set($key, $value);
            }
            return;
        }
        $items = &$this->elements;
        foreach (explode('.', $keys) as $key) {
            if (!isset($items[$key]) || !is_array($items[$key])) {
                $items[$key] = [];
            }
            $items = &$items[$key];
        }
        $items = $value;
    }

    /**
     * Return the value of a given key or all the values as JSON
     *
     * @param  mixed $key
     * @param  int $options
     * @return string
     */
    public function toJson($key = null, $options = 0)
    {
        if (is_string($key)) {
            return json_encode($this->get($key), $options);
        }
        $options = $key === null ? 0 : $key;
        return json_encode($this->elements, $options);
    }
        
}

1			<?php
2
3			/**
4			* Dot - PHP dot notation access to arrays
5			*
6			* @author Riku Särkinen <[email protected]>
7			* @link https://github.com/adbario/php-dot-notation
8			* @license https://github.com/adbario/php-dot-notation/blob/2.x/LICENSE.md (MIT License)
9			*/
10
11			namespace Ballybran\Core\Collections\Collection;
12			use Ballybran\Core\Collections\Collection\ValidateDot;
13
14			use ArrayIterator;
15
16			/**
17			* Dot
18			*
19			* This class provides a dot notation access and helper functions for
20			* working with arrays of data. Inspired by Laravel Collection.
21			*/
22			class IteratorDot extends ValidateDot
23			{
24			/**
25			* The stored items
26			*
27			* @var array
28			*/
29			protected $items = [];
30
31			/**
32			* elements
33			*
34			* @var array
35			*/
36			protected $elements;
37
38			/**
39			* Create a new Dot instance
40			*
41			* @param mixed $items
42			*/
43			public function __construct($items = [])
44			{
45			$this->elements = $this->getArrayItems($items);
46			}
47
48			/**
49			* Set a given key / value pair or pairs
50			* if the key doesn't exist already
51			*
52			* @param array\|int\|string $keys
53			* @param mixed $value
54			*/
55			public function add($keys, $value = null)
56			{
57			if (is_array($keys)) {
58			foreach ($keys as $key => $value) {
59			$this->add($key, $value);
60			}
61			} elseif (is_null($this->get($keys))) {
62			$this->set($keys, $value);
63			}
64			}
65
66			/**
67			* Delete the contents of a given key or keys
68			*
69			* @param array\|int\|string\|null $keys
70			*/
71			public function clear($keys = null)
72			{
73			if (is_null($keys)) {
74			$this->elements = [];
75			return;
76			}
77			$keys = (array)$keys;
78			foreach ($keys as $key) {
79			$this->set($key, []);
80			}
81			}
82
83			/**
84			* Delete the given key or keys
85			*
86			* @param array\|int\|string $keys
87			*/
88			public function delete($keys)
89			{
90			$keys = (array)$keys;
91			foreach ($keys as $key) {
92			if ($this->exists($this->elements, $key)) {
93			unset($this->elements[$key]);
94			continue;
95			}
96			$items = &$this->elements;
97			$segments = explode('.', $key);
98			$lastSegment = array_pop($segments);
99			foreach ($segments as $segment) {
100			if (!isset($items[$segment]) \|\| !is_array($items[$segment])) {
101			continue 2;
102			}
103			$items = &$items[$segment];
104			}
105			unset($items[$lastSegment]);
106			}
107			}
108
109			/**
110			* Flatten an array with the given character as a key delimiter
111			*
112			* @param string $delimiter
113			* @param array\|null $items
114			* @param string $prepend
115			* @return array
116			*/
117			public function flatten($delimiter = '.', $items = null, $prepend = '')
118			{
119			$flatten = [];
120			if (is_null($items)) {
121			$items = $this->elements;
122			}
123			foreach ($items as $key => $value) {
124			if (is_array($value) && !empty($value)) {
125			$flatten = array_merge(
126			$flatten,
127			$this->flatten($delimiter, $value, $prepend . $key . $delimiter)
128			);
129			} else {
130			$flatten[$prepend . $key] = $value;
131			}
132			}
133			return $flatten;
134			}
135
136			/**
137			* Return the value of a given key
138			*
139			* @param int\|string\|null $key
140			* @param mixed $default
141			* @return mixed
142			*/
143			public function get($key = null, $default = null)
144			{
145			if (is_null($key)) {
146			return $this->elements;
147			}
148			if ($this->exists($this->elements, $key)) {
149			return $this->elements[$key];
150			}
151			if (false === strpos($key, '.')) {
152			return $default;
153			}
154			$items = $this->elements;
155			foreach (explode('.', $key) as $segment) {
156			if (!is_array($items) \|\| !$this->exists($items, $segment)) {
157			return $default;
158			}
159			$items = &$items[$segment];
160			}
161			return $items;
162			}
163
164			/**
165			* Return the given items as an array
166			*
167			* @param mixed $items
168			* @return array
169			*/
170			protected function getArrayItems($items)
171			{
172			if (is_array($items)) {
173			return $items;
174			} elseif ($items instanceof self) {
175			return $items->all();
176			}
177			return (array)$items;
178			}
179
180			/**
181			* Check if a given key or keys exists
182			*
183			* @param array\|int\|string $keys
184			* @return bool
185			*/
186			public function has($keys)
187			{
188			$keys = (array)$keys;
189			if ( empty($this->elements) \|\| $keys === []) {
190			return false;
191			}
192			foreach ($keys as $key) {
193			$items = $this->elements;
194			if ($this->exists($items, $key)) {
195			continue;
196			}
197			foreach (explode('.', $key) as $segment) {
198			if (!is_array($items) \|\| !$this->exists($items, $segment)) {
199			return false;
200			}
201			$items = $items[$segment];
202			}
203			}
204			return true;
205			}
206
207			/**
208			* Check if a given key or keys are empty
209			*
210			* @param array\|int\|string\|null $keys
211			* @return bool
212			*/
213			public function isEmpty($keys = null)
214			{
215			if (is_null($keys)) {
216			return empty($this->elements);
217			}
218			$keys = (array)$keys;
219			foreach ($keys as $key) {
220			if (!empty($this->get($key))) {
221			return false;
222			}
223			}
224			return true;
225			}
226
227			/**
228			* Merge a given array or a Dot object with the given key
229			* or with the whole Dot object
230			*
231			* @param array\|string\|self $key
232			* @param array $value
233			*/
234			public function merge($key, $value = null)
235			{
236			if (is_array($key)) {
237			$this->elements = array_merge($this->elements, $key);
238			} elseif (is_string($key)) {
239			$items = (array)$this->get($key);
240			$value = array_merge($items, $this->getArrayItems($value));
241			$this->set($key, $value);
242			}
243			$this->elements = array_merge($this->elements, $key->all());
244
245			}
246
247			/**
248			* Return the value of a given key and
249			* delete the key
250			*
251			* @param int\|string\|null $key
252			* @param mixed $default
253			* @return mixed
254			*/
255			public function pull($key = null, $default = null)
256			{
257			if (is_null($key)) {
258			$value = $this->all();
259			$this->clear();
260			return $value;
261			}
262			$value = $this->get($key, $default);
263			$this->delete($key);
264			return $value;
265			}
266
267			/**
268			* Push a given value to the end of the array
269			* in a given key
270			*
271			* @param mixed $key
272			* @param mixed $value
273			*/
274			public function push($key, $value = null)
275			{
276			if (is_null($value)) {
277			$this->elements[] = $key;
278			return;
279			}
280			$items = $this->get($key);
281			if (is_array($items) \|\| is_null($items)) {
282			$items[] = $value;
283			$this->set($key, $items);
284			}
285			}
286
287			/**
288			* Set a given key / value pair or pairs
289			*
290			* @param array\|int\|string $keys
291			* @param mixed $value
292			*/
293			public function set($keys, $value = null)
294			{
295			if (is_array($keys)) {
296			foreach ($keys as $key => $value) {
297			$this->set($key, $value);
298			}
299			return;
300			}
301			$items = &$this->elements;
302			foreach (explode('.', $keys) as $key) {
303			if (!isset($items[$key]) \|\| !is_array($items[$key])) {
304			$items[$key] = [];
305			}
306			$items = &$items[$key];
307			}
308			$items = $value;
309			}
310
311			/**
312			* Return the value of a given key or all the values as JSON
313			*
314			* @param mixed $key
315			* @param int $options
316			* @return string
317			*/
318			public function toJson($key = null, $options = 0)
319			{
320			if (is_string($key)) {
321			return json_encode($this->get($key), $options);
322			}
323			$options = $key === null ? 0 : $key;
324			return json_encode($this->elements, $options);
325			}
326
327			}

knut7 / framework

Push — master ( 1785b4...1ac661 )

IteratorDot::get() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like