Collection::add() - Code Metrics - Inspection of "#1: refactoring and test coverage." - php-kitchen/platform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a92ee2...268555 )

by Dmitry

created 2018-03-06 11:36 UTC

Collection::add() A

↳ Parent: Collection

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace PHPKitchen\Platform\Struct;

use PHPKitchen\Platform\Contract;
use PHPKitchen\Platform\Mixin\Properties;

/**
 * Represents implementation of array based collection.
 *
 * @author Dmitry Kolodko <[email protected]>
 * @since 1.0
 */
class Collection implements Contract\Struct\Collection, Contract\Data\ValueObject {
    use Mixin\StructureOfElementsMethods;
    use Mixin\CountableMethods;
    use Mixin\IteratorMethods;
    use Mixin\JsonSerializableMethods;
    use Properties;

    public function __construct($elements = []) {
        $this->elements = $elements;
    }

    /**
     * Named constructor.
     *
     * @param array|iterable $elements elements of collection.
     *
     * @return Collection new collection of specified elements.
     *
     * @since 1.0
     */
    public static function of($elements): Contract\Struct\Collection {
        return new static($elements);
    }

    /**
     * Add element to the end of the collection.
     *
     * @param mixed $element element to add.
     *
     * @since 1.0
     */
    public function add($element): void {
        $this->elements[] = $element;
    }

    /**
     * Push one or more elements onto the end of collection.
     * Example:
     * ```php
     * $collection->push(1, 2, 3, 4);
     * ```
     *
     * @param array ...$elements elements.
     *
     * @return int the new number of elements in the array.
     *
     * @since 1.0
     */

    public function push(...$elements): int {
        return array_push($this->elements, ...$elements);
    }

    /**
     * Pad collection to the specified length with a value.
     *
     * @param int $size new size of the collection. If size is
     * positive then the collection is padded on the right, if it's negative then
     * on the left. If the absolute value of size is less than or equal to
     * the length of the collection then no padding takes place.
     * @param mixed $value Value to pad if input is less than `size`.
     *
     * @since 1.0
     */
    public function pad(int $size, $value = null): void {
        $this->elements = array_pad($this->elements, $size, $value);
    }

    /**
     * Split collection into chunks of specified size.
     *
     * @param int $size size of each chunk.
     *
     * @return Collection a multidimensional numerically indexed collection, starting with zero,
     * with each dimension containing collection of specified size.
     *
     * @since 1.0
     */
    public function chunkBy(int $size): Contract\Struct\Collection {

        $chunks = array_chunk($this->elements, $size, $keepKeys = false);
        $collections = static::of([]);
        foreach ($chunks as $chunk) {
            $collections->add(static::of($chunk));
        }

        return $collections;
    }

    /**
     * Split collection into chunks of specified size keeping original indexes.
     *
     * @param int $size size of each chunk.
     *
     * @return Collection a multidimensional numerically indexed collection, starting with zero,
     * with each dimension containing collection of specified size and keys equal to original keys
     * of elements.
     *
     * @since 1.0
     */
    public function chunkKeepingKeysBy(int $size): Contract\Struct\Collection {

        $chunks = array_chunk($this->elements, $size, $keepKeys = true);
        $collections = static::of([]);
        foreach ($chunks as $chunk) {
            $collections->add(static::of($chunk));
        }

        return $collections;
    }

    /**
     * Gets keys of the collection.
     *
     * @return Collection collection of the collection keys.
     */
    public function getKeys(): Contract\Struct\Collection {
        return static::of(array_keys($this->elements));
    }

    /**
     * Gets values of the collection.
     *
     * @return Contract\Struct\Collection collection of the collection keys.
     */
    public function getValues(): Contract\Struct\Collection {
        return static::of(array_values($this->elements));
    }

    ///endregion
    ///
    /// region ----------------- ARRAY ACCESS METHODS -----------------

    /**
     * Whether a offset exists
     *
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param mixed $offset An offset to check for.
     *
     * @return boolean true on success or false on failure.
     * The return value will be casted to boolean if non-boolean was returned.
     *
     * @since 1.0
     */
    public function offsetExists($offset) {
        return $this->hasKey($offset);
    }

    /**
     * Offset to retrieve
     *
     * @link http://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param mixed $offset the offset to retrieve.
     *
     * @return mixed Can return all value types.
     *
     * @since 1.0
     */
    public function offsetGet($offset) {
        return $this->elements[$offset] ?? null;
    }

    /**
     * Offset to set
     *
     * @link http://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param mixed $offset The offset to assign the value to.
     * @param mixed $value the value to set.
     *
     * @return void
     *
     * @since 1.0
     */
    public function offsetSet($offset, $value) {
        if ($offset === null) {
            $this->elements[] = $value;
        } else {
            $this->elements[$offset] = $value;
        }
    }

    /**
     * Offset to unset
     *
     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
     *
     * @param mixed $offset the offset to unset.
     *
     * @return void
     *
     * @since 1.0
     */
    public function offsetUnset($offset) {
        unset($this->elements[$offset]);
    }
    /// endregion
}

1		<?php
2
3		namespace PHPKitchen\Platform\Struct;
4
5		use PHPKitchen\Platform\Contract;
6		use PHPKitchen\Platform\Mixin\Properties;
7
8		/**
9		* Represents implementation of array based collection.
10		*
11		* @author Dmitry Kolodko <[email protected]>
12		* @since 1.0
13		*/
14		class Collection implements Contract\Struct\Collection, Contract\Data\ValueObject {
15		use Mixin\StructureOfElementsMethods;
16		use Mixin\CountableMethods;
17		use Mixin\IteratorMethods;
18		use Mixin\JsonSerializableMethods;
19		use Properties;
20
21		public function __construct($elements = []) {
22		$this->elements = $elements;
23		}
24
25		/**
26		* Named constructor.
27		*
28		* @param array\|iterable $elements elements of collection.
29		*
30		* @return Collection new collection of specified elements.
31		*
32		* @since 1.0
33		*/
34		public static function of($elements): Contract\Struct\Collection {
35		return new static($elements);
36		}
37
38		/**
39		* Add element to the end of the collection.
40		*
41		* @param mixed $element element to add.
42		*
43		* @since 1.0
44		*/
45		public function add($element): void {
46		$this->elements[] = $element;
47		}
48
49		/**
50		* Push one or more elements onto the end of collection.
51		* Example:
52		* ```php
53		* $collection->push(1, 2, 3, 4);
54		* ```
55		*
56		* @param array ...$elements elements.
57		*
58		* @return int the new number of elements in the array.
59		*
60		* @since 1.0
61		*/
		0 ignored issues – show Documentation introduced 2018-03-06 11:40 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$elements` a bit more specific; maybe use `array[]`. Loading history...
62		public function push(...$elements): int {
63		return array_push($this->elements, ...$elements);
64		}
65
66		/**
67		* Pad collection to the specified length with a value.
68		*
69		* @param int $size new size of the collection. If size is
70		* positive then the collection is padded on the right, if it's negative then
71		* on the left. If the absolute value of size is less than or equal to
72		* the length of the collection then no padding takes place.
73		* @param mixed $value Value to pad if input is less than `size`.
74		*
75		* @since 1.0
76		*/
77		public function pad(int $size, $value = null): void {
78		$this->elements = array_pad($this->elements, $size, $value);
79		}
80
81		/**
82		* Split collection into chunks of specified size.
83		*
84		* @param int $size size of each chunk.
85		*
86		* @return Collection a multidimensional numerically indexed collection, starting with zero,
87		* with each dimension containing collection of specified size.
88		*
89		* @since 1.0
90		*/
91	View Code Duplication	public function chunkBy(int $size): Contract\Struct\Collection {
		0 ignored issues – show Duplication introduced 2018-03-06 11:40 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		$chunks = array_chunk($this->elements, $size, $keepKeys = false);
93		$collections = static::of([]);
94		foreach ($chunks as $chunk) {
95		$collections->add(static::of($chunk));
96		}
97
98		return $collections;
99		}
100
101		/**
102		* Split collection into chunks of specified size keeping original indexes.
103		*
104		* @param int $size size of each chunk.
105		*
106		* @return Collection a multidimensional numerically indexed collection, starting with zero,
107		* with each dimension containing collection of specified size and keys equal to original keys
108		* of elements.
109		*
110		* @since 1.0
111		*/
112	View Code Duplication	public function chunkKeepingKeysBy(int $size): Contract\Struct\Collection {
		0 ignored issues – show Duplication introduced 2018-03-06 11:40 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113		$chunks = array_chunk($this->elements, $size, $keepKeys = true);
114		$collections = static::of([]);
115		foreach ($chunks as $chunk) {
116		$collections->add(static::of($chunk));
117		}
118
119		return $collections;
120		}
121
122		/**
123		* Gets keys of the collection.
124		*
125		* @return Collection collection of the collection keys.
126		*/
127		public function getKeys(): Contract\Struct\Collection {
128		return static::of(array_keys($this->elements));
129		}
130
131		/**
132		* Gets values of the collection.
133		*
134		* @return Contract\Struct\Collection collection of the collection keys.
135		*/
136		public function getValues(): Contract\Struct\Collection {
137		return static::of(array_values($this->elements));
138		}
139
140		///endregion
141		///
142		/// region ----------------- ARRAY ACCESS METHODS -----------------
143
144		/**
145		* Whether a offset exists
146		*
147		* @link http://php.net/manual/en/arrayaccess.offsetexists.php
148		*
149		* @param mixed $offset An offset to check for.
150		*
151		* @return boolean true on success or false on failure.
152		* The return value will be casted to boolean if non-boolean was returned.
153		*
154		* @since 1.0
155		*/
156		public function offsetExists($offset) {
157		return $this->hasKey($offset);
158		}
159
160		/**
161		* Offset to retrieve
162		*
163		* @link http://php.net/manual/en/arrayaccess.offsetget.php
164		*
165		* @param mixed $offset the offset to retrieve.
166		*
167		* @return mixed Can return all value types.
168		*
169		* @since 1.0
170		*/
171		public function offsetGet($offset) {
172		return $this->elements[$offset] ?? null;
173		}
174
175		/**
176		* Offset to set
177		*
178		* @link http://php.net/manual/en/arrayaccess.offsetset.php
179		*
180		* @param mixed $offset The offset to assign the value to.
181		* @param mixed $value the value to set.
182		*
183		* @return void
184		*
185		* @since 1.0
186		*/
187		public function offsetSet($offset, $value) {
188		if ($offset === null) {
189		$this->elements[] = $value;
190		} else {
191		$this->elements[$offset] = $value;
192		}
193		}
194
195		/**
196		* Offset to unset
197		*
198		* @link http://php.net/manual/en/arrayaccess.offsetunset.php
199		*
200		* @param mixed $offset the offset to unset.
201		*
202		* @return void
203		*
204		* @since 1.0
205		*/
206		public function offsetUnset($offset) {
207		unset($this->elements[$offset]);
208		}
209		/// endregion
210		}

php-kitchen / platform

Push — master ( a92ee2...268555 )

Collection::add() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like