BaseTrait::keys() - Code Metrics - Inspection of "php-docs" - hiqdev/php-collection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7bcfa7...7f7fda )

by Andrii

created 2018-12-15 18:01 UTC

BaseTrait::keys() A

↳ Parent: BaseTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * Collection library for PHP.
 *
 * @link      https://github.com/hiqdev/php-collection
 * @package   php-collection
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\php\collection;

use ArrayIterator;

/**
 * Base Trait.
 * Provides methods for iterfaces:
 * - ArrayAccess: offsetExists, offsetGet, offsetSet, offsetUnset
 * - IteratorAggregate: getIterator
 * - yii\base\Arrayable: fields, extraFields, toArray
 *
 * @author Andrii Vasyliev <[email protected]>
 */
trait BaseTrait
{
    /**
     * @var array default items
     */
    protected static $_defaults = [];

    /**
     * @var array items
     */
    protected $_items = [];

    /**
     * Straight put an item.
     * @param string $name  item name
     * @param array  $value item value
     */
    public function putItem($name, $value = null)
    {
        if (is_null($name) || is_int($name)) {
            $this->_items[] = $value;
        } else {
            $this->_items[$name] = $value;
        }
    }

    /**
     * Get raw item.
     * @param string $name item name
     * @return mixed item value
     */
    public function rawItem($name, $default = null)
    {
        return isset($this->_items[$name]) ? $this->_items[$name] : $default;
    }

    /**
     * Adds an item. Doesn't touch if already exists.
     * @param string       $name  item name
     * @param array        $value item value
     * @param string|array $where where to put, @see setItem
     * @return $this for chaining
     */
    public function addItem($name, $value = null, $where = '')
    {
        if (!$this->hasItem($name)) {
            $this->setItem($name, $value, $where);
        }

        return $this;
    }

    /**
     * Sets an item. Silently resets if already exists and mov.
     * @param string       $name  item name
     * @param array        $value item value
     * @param string|array $where where to put, can be empty, first, last and array of before and after
     */
    public function setItem($name, $value = null, $where = '')
    {
        if ($name === null || $where === '') {
            $this->putItem($name, $value);
        } else {
            $this->setItems([$name => $value], $where);
        }
    }

    /**
     * Returns item by name.
     * @param string $name item name
     * @param mixed $default default value
     * @return mixed item value or default
     */
    public function getItem($name, $default = null)
    {
        return isset($this->_items[$name]) ? $this->_items[$name] : $default;
    }

    /**
     * Check collection has the item.
     * @param string $name item name
     * @return bool whether item exist
     */
    public function hasItem($name)
    {
        return array_key_exists($name, $this->_items);
    }

    public function mergeItem($name, array $value)
    {
        if (!is_null($name)) {
            $this->_items[$name] = ArrayHelper::merge($this->_items[$name], $value);
        }
    }

    /**
     * Check is item set.
     * @param string $name item name
     * @return bool whether item is set
     */
    public function issetItem($name)
    {
        return isset($this->_items[$name]);
    }

    /**
     * Delete an item.
     * @param $name
     */
    public function unsetItem($name)
    {
        unset($this->_items[$name]);
    }

    /**
     * Get specified items as array.
     * @param mixed $keys specification
     * @return array list of items
     */
    public function getItems($keys = null)
    {
        return ArrayHelper::getItems($this->_items, $keys);
    }

    /**
     * Straight put items.
     * @param array $items list of items
     * @see setItem
     */
    public function putItems(array $items)
    {
        foreach ($items as $k => $v) {
            $this->putItem($k, $v);
        }
    }

    /**
     * Adds items to specified place.
     * @param array $items list of items
     * @param mixed $where
     * @see setItem()
     */
    public function setItems($items, $where = '')
    {
        if (empty($items)) {
            return;
        }
        if (empty($where)) {
            $this->putItems($items);
        } elseif ($where === 'last') {
            $this->_items = ArrayHelper::insertLast($this->_items, $items);
        } elseif ($where === 'first') {
            $this->_items = ArrayHelper::insertFirst($this->_items, $items);
        } else {
            $this->_items = ArrayHelper::insertInside($this->_items, $items, $where);
        }
    }

    /**
     * Adds items to specified place.
     * Does not touch those items that already exists.
     * @param array        $items array of items
     * @param string|array $where where to add. See [[setItem()]]
     * @return $this for chaining
     * @see setItem()
     */
    public function addItems(array $items, $where = '')
    {
        foreach (array_keys($items) as $k) {
            if (!is_int($k) && $this->hasItem($k)) {
                unset($items[$k]);
            }
        }
        if (!empty($items)) {
            $this->setItems($items, $where);
        }

        return $this;
    }

    public function mergeItems(array $items)
    {
        $this->_items = ArrayHelper::merge($this->_items, $items);
    }

    /**
     * Unset specified items.
     * @param mixed $keys specification
     * @return array list of items
     */
    public function unsetItems($keys = null)
    {
        if (is_null($keys)) {
            $this->_items = [];
        } elseif (is_scalar($keys)) {
            unset($this->_items[$keys]);
        } else {
            foreach ($keys as $k) {
                unset($this->_items[$k]);
            }
        }
    }

    public function resetItems(array $items)
    {
        $this->_items = $items;
    }

    /**
     * Get keys.
     * @return array for chaining
     */
    public function keys()
    {
        return array_keys($this->_items);
    }

    /**
     * The default implementation of this method returns [[attributes()]] indexed by the same attribute names.
     * @return array the list of field names or field definitions
     * @see toArray()
     */
    public function fields()
    {
        $fields = $this->keys();

        return array_combine($fields, $fields);
    }

    /**
     * Returns number of items in the collection.
     * @return int
     */
    public function count()
    {
        return count($this->_items);
    }

    /**
     * Returns the element at the specified offset.
     * This method is required by the SPL interface `ArrayAccess`.
     * It is implicitly called when you use something like `$value = $collection[$offset];`.
     * @param mixed $offset the offset to retrieve element
     * @return mixed the element at the offset, null if no element is found at the offset
     */
    public function offsetGet($offset)
    {
        return $this->getItem($offset);
    }

    /**
     * Sets the element at the specified offset.
     * This method is required by the SPL interface `ArrayAccess`.
     * It is implicitly called when you use something like `$collection[$offset] = $value;`.
     * @param int   $offset the offset to set element
     * @param mixed $value  the element value
     */
    public function offsetSet($offset, $value)
    {
        $this->setItem($offset, $value);
    }

    /**
     * Returns whether there is an element at the specified offset.
     * This method is required by the SPL interface `ArrayAccess`.
     * It is implicitly called when you use something like `isset($collection[$offset])`.
     * @param mixed $offset the offset to check on
     * @return bool
     */
    public function offsetExists($offset)
    {
        return $this->hasItem($offset);
    }

    /**
     * Sets the element value at the specified offset to null.
     * This method is required by the SPL interface ArrayAccess.
     * It is implicitly called when you use something like `unset($collection[$offset])`.
     * @param mixed $offset the offset to unset element
     */
    public function offsetUnset($offset)
    {
        $this->unsetItem($offset);
    }

    /**
     * Method for IteratorAggregate interface.
     * Enables foreach'ing the object.
     * @return ArrayIterator
     */
    public function getIterator()
    {
        return new ArrayIterator($this->_items);
    }
}


1		<?php
2		/**
3		* Collection library for PHP.
4		*
5		* @link https://github.com/hiqdev/php-collection
6		* @package php-collection
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\php\collection;
12
13		use ArrayIterator;
14
15		/**
16		* Base Trait.
17		* Provides methods for iterfaces:
18		* - ArrayAccess: offsetExists, offsetGet, offsetSet, offsetUnset
19		* - IteratorAggregate: getIterator
20		* - yii\base\Arrayable: fields, extraFields, toArray
21		*
22		* @author Andrii Vasyliev <[email protected]>
23		*/
24		trait BaseTrait
25		{
26		/**
27		* @var array default items
28		*/
29		protected static $_defaults = [];
30
31		/**
32		* @var array items
33		*/
34		protected $_items = [];
35
36		/**
37		* Straight put an item.
38		* @param string $name item name
39		* @param array $value item value
40		*/
41	4	public function putItem($name, $value = null)
42		{
43	4	if (is_null($name) \|\| is_int($name)) {
44		$this->_items[] = $value;
45		} else {
46	4	$this->_items[$name] = $value;
47		}
48	4	}
49
50		/**
51		* Get raw item.
52		* @param string $name item name
53		* @return mixed item value
54		*/
55		public function rawItem($name, $default = null)
56		{
57		return isset($this->_items[$name]) ? $this->_items[$name] : $default;
58		}
59
60		/**
61		* Adds an item. Doesn't touch if already exists.
62		* @param string $name item name
63		* @param array $value item value
64		* @param string\|array $where where to put, @see setItem
65		* @return $this for chaining
66		*/
67		public function addItem($name, $value = null, $where = '')
68		{
69		if (!$this->hasItem($name)) {
70		$this->setItem($name, $value, $where);
71		}
72
73		return $this;
74		}
75
76		/**
77		* Sets an item. Silently resets if already exists and mov.
78		* @param string $name item name
79		* @param array $value item value
80		* @param string\|array $where where to put, can be empty, first, last and array of before and after
81		*/
82	8	public function setItem($name, $value = null, $where = '')
83		{
84	8	if ($name === null \|\| $where === '') {
85	4	$this->putItem($name, $value);
86		} else {
87	4	$this->setItems([$name => $value], $where);
88		}
89	8	}
90
91		/**
92		* Returns item by name.
93		* @param string $name item name
94		* @param mixed $default default value
95		* @return mixed item value or default
96		*/
97	5	public function getItem($name, $default = null)
98		{
99	5	return isset($this->_items[$name]) ? $this->_items[$name] : $default;
100		}
101
102		/**
103		* Check collection has the item.
104		* @param string $name item name
105		* @return bool whether item exist
106		*/
107	10	public function hasItem($name)
108		{
109	10	return array_key_exists($name, $this->_items);
110		}
111
112		public function mergeItem($name, array $value)
113		{
114		if (!is_null($name)) {
115		$this->_items[$name] = ArrayHelper::merge($this->_items[$name], $value);
116		}
117		}
118
119		/**
120		* Check is item set.
121		* @param string $name item name
122		* @return bool whether item is set
123		*/
124	1	public function issetItem($name)
125		{
126	1	return isset($this->_items[$name]);
127		}
128
129		/**
130		* Delete an item.
131		* @param $name
132		*/
133	2	public function unsetItem($name)
134		{
135	2	unset($this->_items[$name]);
136	2	}
137
138		/**
139		* Get specified items as array.
140		* @param mixed $keys specification
141		* @return array list of items
142		*/
143	2	public function getItems($keys = null)
144		{
145	2	return ArrayHelper::getItems($this->_items, $keys);
146		}
147
148		/**
149		* Straight put items.
150		* @param array $items list of items
151		* @see setItem
152		*/
153		public function putItems(array $items)
154		{
155		foreach ($items as $k => $v) {
156		$this->putItem($k, $v);
157		}
158		}
159
160		/**
161		* Adds items to specified place.
162		* @param array $items list of items
163		* @param mixed $where
164		* @see setItem()
165		*/
166	4	public function setItems($items, $where = '')
167		{
168	4	if (empty($items)) {
169		return;
170		}
171	4	if (empty($where)) {
172		$this->putItems($items);
173	4	} elseif ($where === 'last') {
174	2	$this->_items = ArrayHelper::insertLast($this->_items, $items);
175	2	} elseif ($where === 'first') {
176	2	$this->_items = ArrayHelper::insertFirst($this->_items, $items);
177		} else {
178		$this->_items = ArrayHelper::insertInside($this->_items, $items, $where);
179		}
180	4	}
181
182		/**
183		* Adds items to specified place.
184		* Does not touch those items that already exists.
185		* @param array $items array of items
186		* @param string\|array $where where to add. See [[setItem()]]
187		* @return $this for chaining
188		* @see setItem()
189		*/
190		public function addItems(array $items, $where = '')
191		{
192		foreach (array_keys($items) as $k) {
193		if (!is_int($k) && $this->hasItem($k)) {
194		unset($items[$k]);
195		}
196		}
197		if (!empty($items)) {
198		$this->setItems($items, $where);
199		}
200
201		return $this;
202		}
203
204		public function mergeItems(array $items)
205		{
206		$this->_items = ArrayHelper::merge($this->_items, $items);
207		}
208
209		/**
210		* Unset specified items.
211		* @param mixed $keys specification
212		* @return array list of items
213		*/
214	2	public function unsetItems($keys = null)
215		{
216	2	if (is_null($keys)) {
217	1	$this->_items = [];
218	1	} elseif (is_scalar($keys)) {
219	1	unset($this->_items[$keys]);
220		} else {
221	1	foreach ($keys as $k) {
222	1	unset($this->_items[$k]);
223		}
224		}
225	2	}
226
227	1	public function resetItems(array $items)
228		{
229	1	$this->_items = $items;
230	1	}
231
232		/**
233		* Get keys.
234		* @return array for chaining
235		*/
236	9	public function keys()
237		{
238	9	return array_keys($this->_items);
239		}
240
241		/**
242		* The default implementation of this method returns [[attributes()]] indexed by the same attribute names.
243		* @return array the list of field names or field definitions
244		* @see toArray()
245		*/
246		public function fields()
247		{
248		$fields = $this->keys();
249
250		return array_combine($fields, $fields);
251		}
252
253		/**
254		* Returns number of items in the collection.
255		* @return int
256		*/
257		public function count()
258		{
259		return count($this->_items);
260		}
261
262		/**
263		* Returns the element at the specified offset.
264		* This method is required by the SPL interface `ArrayAccess`.
265		* It is implicitly called when you use something like `$value = $collection[$offset];`.
266		* @param mixed $offset the offset to retrieve element
267		* @return mixed the element at the offset, null if no element is found at the offset
268		*/
269		public function offsetGet($offset)
270		{
271		return $this->getItem($offset);
272		}
273
274		/**
275		* Sets the element at the specified offset.
276		* This method is required by the SPL interface `ArrayAccess`.
277		* It is implicitly called when you use something like `$collection[$offset] = $value;`.
278		* @param int $offset the offset to set element
279		* @param mixed $value the element value
280		*/
281		public function offsetSet($offset, $value)
282		{
283		$this->setItem($offset, $value);
284		}
285
286		/**
287		* Returns whether there is an element at the specified offset.
288		* This method is required by the SPL interface `ArrayAccess`.
289		* It is implicitly called when you use something like `isset($collection[$offset])`.
290		* @param mixed $offset the offset to check on
291		* @return bool
292		*/
293		public function offsetExists($offset)
294		{
295		return $this->hasItem($offset);
296		}
297
298		/**
299		* Sets the element value at the specified offset to null.
300		* This method is required by the SPL interface ArrayAccess.
301		* It is implicitly called when you use something like `unset($collection[$offset])`.
302		* @param mixed $offset the offset to unset element
303		*/
304		public function offsetUnset($offset)
305		{
306		$this->unsetItem($offset);
307		}
308
309		/**
310		* Method for IteratorAggregate interface.
311		* Enables foreach'ing the object.
312		* @return ArrayIterator
313		*/
314	1	public function getIterator()
315		{
316	1	return new ArrayIterator($this->_items);
317		}
318		}
319

hiqdev / php-collection

Push — master ( 7bcfa7...7f7fda )

BaseTrait::keys() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like