Collection::validate_index() - Code Metrics - Inspection of "Add Dictionary" - intraxia/jaxion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by James

created 2017-07-09 15:45 UTC

Collection::validate_index() A

↳ Parent: Collection

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

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

<?php
namespace Intraxia\Jaxion\Axolotl;

use Intraxia\Jaxion\Contract\Axolotl\Collection as CollectionContract;
use Intraxia\Jaxion\Contract\Axolotl\Serializes;
use InvalidArgumentException;
use OutOfBoundsException;
use OutOfRangeException;

/**
 * Class Collection
 *
 * @package Intraxia\Jaxion
 * @subpackage Axolotl
 */
class Collection implements CollectionContract {

	/**
	 * Collection elements.
	 *
	 * @var array
	 */
	protected $elements = array();

	/**
	 * Collection type to enforce.
	 *
	 * @var Type
	 */
	private $type;

	/**
	 * Where Collection is in loop.
	 *
	 * @var int
	 */
	protected $position = 0;

	/**
	 * Collection constructor.
	 *
	 * @param string $type
	 * @param array  $elements
	 */
	public function __construct( $type, array $elements = array() ) {
		$this->type = new Type( $type );

		if ( $this->type->is_model() ) {
			foreach ( $elements as $idx => $element ) {
				if ( is_array( $element ) ) {
					$elements[ $idx ] = $this->type->create_model( $element );
				}
			}
		}

		if ( $elements ) {
			$this->type->validate_elements( $elements );
		}

		$this->elements = $elements;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return string
	 */
	public function get_type() {
		return $this->type->get_type();
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param mixed $element
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function add( $element ) {
		if ( $this->type->is_model() && is_array( $element ) ) {
			$element = $this->type->create_model( $element );
		}

		$this->type->validate_element( $element );

		$elements   = $this->elements;
		$elements[] = $element;

		$collection = new static( $this->get_type() );
		$collection->set_from_trusted( $elements );

		return $collection;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return Collection
	 */
	public function clear() {
		return new static( $this->get_type() );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return bool
	 */
	public function contains( $condition ) {
		return (bool) $this->find( $condition );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return mixed
	 */
	public function find( $condition ) {
		$index = $this->find_index( $condition );

		return -1 === $index ? false : $this->elements[ $index ];
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return int
	 */
	public function find_index( $condition ) {
		$index = -1;

		for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) {
			if ( call_user_func( $condition, ($this->at( $i ) ) ) ) {
				$index = $i;
				break;
			}
		}

		return $index;
	}

	/**
	 * Fetches the element at the provided index.
	 *
	 * @param int $index Index to get element from.
	 *
	 * @return mixed
	 *
	 * @throws OutOfRangeException
	 */
	public function at( $index ) {
		$this->validate_index( $index );

		return $this->elements[ $index ];
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  int $index Index to check for existence.
	 *
	 * @return bool
	 *
	 * @throws InvalidArgumentException
	 */
	public function index_exists( $index ) {
		if ( ! is_int( $index ) ) {
			throw new InvalidArgumentException( 'Index must be an integer' );
		}

		if ( $index < 0 ) {
			throw new InvalidArgumentException( 'Index must be a non-negative integer' );
		}

		return $index < $this->count();
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return mixed
	 */
	public function filter( $condition ) {
		$elements = array();

		foreach ( $this->elements as $element ) {
			if ( call_user_func( $condition, $element ) ) {
				$elements[] = $element;
			}
		}

		return $this->new_from_trusted( $elements );
	}
	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return mixed
	 */
	public function find_last( $condition ) {
		$index = $this->find_last_index( $condition );

		return -1 === $index ? null : $this->elements[ $index ];
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition
	 * @return int
	 */
	public function find_last_index( $condition ) {
		$index = -1;

		for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) {
			if ( call_user_func( $condition, $this->elements[ $i ] ) ) {
				$index = $i;
				break;
			}
		}

		return $index;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  int $start Begining index to slice from.
	 * @param  int $end   End index to slice to.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function slice( $start, $end ) {
		if ( $start < 0 || ! is_int( $start ) ) {
			throw new InvalidArgumentException( 'Start must be a non-negative integer' );
		}

		if ( $end < 0 || ! is_int( $end ) ) {
			throw new InvalidArgumentException( 'End must be a positive integer' );
		}

		if ( $start > $end ) {
			throw new InvalidArgumentException( 'End must be greater than start' );
		}

		if ( $end > $this->count() + 1 ) {
			throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' );
		}

		$length = $end - $start + 1;

		return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param int   $index     Index to start at.
	 * @param mixed $element Element to insert.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 * @throws OutOfRangeException
	 */
	public function insert( $index, $element ) {
		$this->validate_index( $index );
		$this->type->validate_element( $element );

		$a = array_slice( $this->elements, 0, $index );
		$b = array_slice( $this->elements, $index, count( $this->elements ) );

		$a[] = $element;

		return $this->new_from_trusted( array_merge( $a, $b ) );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param int   $index    Index to start insertion at.
	 * @param array $elements Elements in insert.
	 *
	 * @return Collection
	 *
	 * @throws OutOfRangeException
	 */
	public function insert_range( $index, array $elements ) {
		$this->validate_index( $index );
		$this->type->validate_elements( $elements );

		if ( $index < 0 ) {
			$index = $this->count() + $index + 1;
		}

		return $this->new_from_trusted(
			array_merge(
				array_slice( $this->elements, 0, $index ),
				$elements,
				array_slice( $this->elements, $index, count( $this->elements ) )
			)
		);
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  callable $condition Condition to satisfy.
	 *
	 * @return Collection
	 */
	public function without( $condition ) {
		$inverse = function ( $element ) use ( $condition ) {
			return ! call_user_func( $condition, $element );
		};

		return $this->filter( $inverse );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  int $index Index to remove.
	 *
	 * @return Collection
	 *
	 * @throws OutOfRangeException
	 */
	public function remove_at( $index ) {
		$this->validate_index( $index );

		$elements = $this->elements;

		return $this->new_from_trusted(
			array_merge(
				array_slice( $elements, 0, $index ),
				array_slice( $elements, $index + 1, count( $elements ) )
			)
		);
	}
	/**
	 * {@inheritdoc}
	 *
	 * @return Collection
	 */
	public function reverse() {
		return $this->new_from_trusted(
			array_reverse( $this->elements )
		);
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $callback Sort callback.
	 *
	 * @return Collection
	 */
	public function sort( $callback ) {
		$elements = $this->elements;
		usort( $elements, $callback );
		return $this->new_from_trusted( $elements );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return array
	 */
	public function to_array() {
		return $this->elements;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $callable Reducer function.
	 *
	 * @param null     $initial  Initial reducer value.
	 *
	 * @return mixed
	 */
	public function reduce( $callable, $initial = null ) {
		return array_reduce( $this->elements, $callable, $initial );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $condition Condition callback.
	 *
	 * @return bool
	 */
	public function every( $condition ) {
		$response = true;

		foreach ( $this->elements as $element ) {
			$result = call_user_func( $condition, $element );

			if ( false === $result ) {
				$response = false;
				break;
			}
		}

		return $response;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  int $num Number of elements to drop.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function drop( $num ) {
		if ( $num > $this->count() ) {
			$num = $this->count();
		}

		return $this->slice( $num, $this->count() );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param int $num Number of elements to drop.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function drop_right( $num ) {
		return $num !== $this->count()
			? $this->slice( 0, $this->count() - $num - 1 )
			: $this->clear();
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $condition Condition callback.
	 *
	 * @return Collection
	 */
	public function drop_while( $condition ) {
		$count = $this->count_while_true( $condition );
		return $count ? $this->drop( $count ) : $this;
	}
	/**
	 * {@inheritdoc}
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function tail() {
		return $this->slice( 1, $this->count() );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  int $num Number of elements to take.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function take( $num ) {
		return $this->slice( 0, $num - 1 );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param int $num Number of elements to take.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function take_right( $num ) {
		return $this->slice( $this->count() - $num, $this->count() );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $condition Callback function.
	 *
	 * @return Collection
	 */
	public function take_while( $condition ) {
		$count = $this->count_while_true( $condition );

		return $count ? $this->take( $count ) : $this->clear();
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $callable Callback function.
	 */
	public function each( $callable ) {
		foreach ( $this->elements as $element ) {
			call_user_func( $callable, $element );
		}
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $callable Callback function.
	 *
	 * @return Collection
	 */
	public function map( $callable ) {
		$elements = array();
		$type = null;
		foreach ( $this->elements as $element ) {
			$result = call_user_func( $callable, $element );

			if ( null === $type ) {
				$type = gettype( $result );

				if ( 'object' === $type ) {
					$type = get_class( $result );
				}
			}

			$elements[] = $result;
		}

		return $this->new_from_trusted( $elements, $type ? : $this->get_type() );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param callable $callable Reducer function.
	 * @param null     $initial  Initial value.
	 *
	 * @return mixed
	 */
	public function reduce_right( $callable, $initial = null ) {
		return array_reduce(
			array_reverse( $this->elements ),
			$callable,
			$initial
		);
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return Collection
	 */
	public function shuffle() {
		$elements = $this->elements;
		shuffle( $elements );

		return $this->new_from_trusted( $elements );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param array|Collection $elements Array of elements to merge.
	 *
	 * @return Collection
	 *
	 * @throws InvalidArgumentException
	 */
	public function merge( $elements ) {
		if ( $elements instanceof static ) {
			$elements = $elements->to_array();
		}

		if ( ! is_array( $elements ) ) {
			throw new InvalidArgumentException( 'Merge must be given array or Collection' );
		}

		$this->type->validate_elements( $elements );

		return $this->new_from_trusted(
			array_merge( $this->elements, $elements )
		);
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return mixed
	 *
	 * @throws OutOfBoundsException
	 */
	public function first() {
		if ( empty( $this->elements ) ) {
			throw new OutOfBoundsException( 'Cannot get first element of empty Collection' );
		}

		return reset( $this->elements );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return mixed
	 *
	 * @throws OutOfBoundsException
	 */
	public function last() {
		if ( empty( $this->elements ) ) {
			throw new OutOfBoundsException( 'Cannot get last element of empty Collection' );
		}

		return end( $this->elements );
	}

	/**
	 * {@inheritdoc}
	 *
	 * @return int
	 */
	public function count() {
		return count( $this->elements );
	}

	/**
	 * {@inheritDoc}
	 *
	 * @return array
	 */
	public function serialize() {
		return $this->map(function( $element ) {
			if ( $element instanceof Serializes ) {
				return $element->serialize();
			}

			return $element;
		} )->to_array();
	}

	/**
	 * Return the current element.
	 *
	 * @return mixed
	 */
	public function current() {
		return $this->at( $this->position );
	}

	/**
	 * Move forward to next element.
	 */
	public function next() {
		$this->position ++;
	}

	/**
	 * Return the key of the current element.
	 *
	 * @return mixed
	 */
	public function key() {
		return $this->position;
	}

	/**
	 * Checks if current position is valid.
	 *
	 * @return bool
	 */
	public function valid() {
		return isset( $this->elements[ $this->position ] );
	}

	/**
	 * Rewind the Iterator to the first element.
	 */
	public function rewind() {
		$this->position = 0;
	}

	/**
	 * Creates a new instance of the Collection
	 * from a trusted set of elements.
	 *
	 * @param array      $elements Array of elements to pass into new collection.
	 * @param null|mixed $type
	 *
	 * @return static
	 */
	protected function new_from_trusted( array $elements, $type = null ) {
		$collection = new static( null !== $type ? $type : $this->get_type() );
		$collection->set_from_trusted( $elements );

		return $collection;
	}

	/**
	 * Sets the elements without validating them.
	 *
	 * @param array $elements Pre-validated elements to set.
	 */
	protected function set_from_trusted( array $elements ) {
		$this->elements = $elements;
	}

	/**
	 * Number of elements true for the condition.
	 *
	 * @param callable $condition Condition to check.
	 * @return int
	 */
	protected function count_while_true( $condition ) {
		$count = 0;

		foreach ( $this->elements as $element ) {
			if ( ! $condition($element) ) {
				break;
			}
			$count++;
		}

		return $count;
	}

	/**
	 * Validates a number to be used as an index.
	 *
	 * @param  integer $index The number to be validated as an index.
	 *
	 * @throws OutOfRangeException
	 */
	protected function validate_index( $index ) {
		$exists = $this->index_exists( $index );

		if ( ! $exists ) {
			throw new OutOfRangeException( 'Index out of bounds of collection' );
		}
	}
}


1		<?php
2		namespace Intraxia\Jaxion\Axolotl;
3
4		use Intraxia\Jaxion\Contract\Axolotl\Collection as CollectionContract;
5		use Intraxia\Jaxion\Contract\Axolotl\Serializes;
6		use InvalidArgumentException;
7		use OutOfBoundsException;
8		use OutOfRangeException;
9
10		/**
11		* Class Collection
12		*
13		* @package Intraxia\Jaxion
14		* @subpackage Axolotl
15		*/
16		class Collection implements CollectionContract {
17
18		/**
19		* Collection elements.
20		*
21		* @var array
22		*/
23		protected $elements = array();
24
25		/**
26		* Collection type to enforce.
27		*
28		* @var Type
29		*/
30		private $type;
31
32		/**
33		* Where Collection is in loop.
34		*
35		* @var int
36		*/
37		protected $position = 0;
38
39		/**
40		* Collection constructor.
41		*
42		* @param string $type
43		* @param array $elements
44		*/
45	162	public function __construct( $type, array $elements = array() ) {
46	162	$this->type = new Type( $type );
47
48	159	if ( $this->type->is_model() ) {
49	33	foreach ( $elements as $idx => $element ) {
50	27	if ( is_array( $element ) ) {
51	9	$elements[ $idx ] = $this->type->create_model( $element );
52	6	}
53	22	}
54	22	}
55
56	159	if ( $elements ) {
57	90	$this->type->validate_elements( $elements );
58	60	}
59
60	159	$this->elements = $elements;
61	159	}
62
63		/**
64		* {@inheritdoc}
65		*
66		* @return string
67		*/
68	81	public function get_type() {
69	81	return $this->type->get_type();
70		}
71
72		/**
73		* {@inheritdoc}
74		*
75		* @param mixed $element
76		*
77		* @return Collection
78		*
79		* @throws InvalidArgumentException
80		*/
81	51	public function add( $element ) {
82	51	if ( $this->type->is_model() && is_array( $element ) ) {
83	3	$element = $this->type->create_model( $element );
84	2	}
85
86	51	$this->type->validate_element( $element );
87
88	45	$elements = $this->elements;
89	45	$elements[] = $element;
90
91	45	$collection = new static( $this->get_type() );
92	45	$collection->set_from_trusted( $elements );
93
94	45	return $collection;
95		}
96
97		/**
98		* {@inheritdoc}
99		*
100		* @return Collection
101		*/
102	3	public function clear() {
103	3	return new static( $this->get_type() );
104		}
105
106		/**
107		* {@inheritdoc}
108		*
109		* @param callable $condition Condition to satisfy.
110		*
111		* @return bool
112		*/
113	6	public function contains( $condition ) {
114	6	return (bool) $this->find( $condition );
115		}
116
117		/**
118		* {@inheritdoc}
119		*
120		* @param callable $condition Condition to satisfy.
121		*
122		* @return mixed
123		*/
124	6	public function find( $condition ) {
125	6	$index = $this->find_index( $condition );
126
127	6	return -1 === $index ? false : $this->elements[ $index ];
128		}
129
130		/**
131		* {@inheritdoc}
132		*
133		* @param callable $condition Condition to satisfy.
134		*
135		* @return int
136		*/
137	12	public function find_index( $condition ) {
138	12	$index = -1;
139
140	12	for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) {
141	12	if ( call_user_func( $condition, ($this->at( $i ) ) ) ) {
142	6	$index = $i;
143	6	break;
144		}
145	4	}
146
147	12	return $index;
148		}
149
150		/**
151		* Fetches the element at the provided index.
152		*
153		* @param int $index Index to get element from.
154		*
155		* @return mixed
156		*
157		* @throws OutOfRangeException
158		*/
159	51	public function at( $index ) {
160	51	$this->validate_index( $index );
161
162	42	return $this->elements[ $index ];
163		}
164
165		/**
166		* {@inheritdoc}
167		*
168		* @param int $index Index to check for existence.
169		*
170		* @return bool
171		*
172		* @throws InvalidArgumentException
173		*/
174	51	public function index_exists( $index ) {
175	51	if ( ! is_int( $index ) ) {
176	3	throw new InvalidArgumentException( 'Index must be an integer' );
177		}
178
179	48	if ( $index < 0 ) {
180	3	throw new InvalidArgumentException( 'Index must be a non-negative integer' );
181		}
182
183	45	return $index < $this->count();
184		}
185
186		/**
187		* {@inheritdoc}
188		*
189		* @param callable $condition Condition to satisfy.
190		*
191		* @return mixed
192		*/
193	3	public function filter( $condition ) {
194	3	$elements = array();
195
196	3	foreach ( $this->elements as $element ) {
197	3	if ( call_user_func( $condition, $element ) ) {
198	3	$elements[] = $element;
199	2	}
200	2	}
201
202	3	return $this->new_from_trusted( $elements );
203		}
204		/**
205		* {@inheritdoc}
206		*
207		* @param callable $condition Condition to satisfy.
208		*
209		* @return mixed
210		*/
211		public function find_last( $condition ) {
212		$index = $this->find_last_index( $condition );
213
214		return -1 === $index ? null : $this->elements[ $index ];
215		}
216
217		/**
218		* {@inheritdoc}
219		*
220		* @param callable $condition
221		* @return int
222		*/
223	6	public function find_last_index( $condition ) {
224	6	$index = -1;
225
226	6	for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) {
227	6	if ( call_user_func( $condition, $this->elements[ $i ] ) ) {
228	3	$index = $i;
229	3	break;
230		}
231	2	}
232
233	6	return $index;
234		}
235
236		/**
237		* {@inheritdoc}
238		*
239		* @param int $start Begining index to slice from.
240		* @param int $end End index to slice to.
241		*
242		* @return Collection
243		*
244		* @throws InvalidArgumentException
245		*/
246	27	public function slice( $start, $end ) {
247	27	if ( $start < 0 \|\| ! is_int( $start ) ) {
248		throw new InvalidArgumentException( 'Start must be a non-negative integer' );
249		}
250
251	27	if ( $end < 0 \|\| ! is_int( $end ) ) {
252		throw new InvalidArgumentException( 'End must be a positive integer' );
253		}
254
255	27	if ( $start > $end ) {
256		throw new InvalidArgumentException( 'End must be greater than start' );
257		}
258
259	27	if ( $end > $this->count() + 1 ) {
260		throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' );
261		}
262
263	27	$length = $end - $start + 1;
264
265	27	return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) );
266		}
267
268		/**
269		* {@inheritdoc}
270		*
271		* @param int $index Index to start at.
272		* @param mixed $element Element to insert.
273		*
274		* @return Collection
275		*
276		* @throws InvalidArgumentException
277		* @throws OutOfRangeException
278		*/
279		public function insert( $index, $element ) {
280		$this->validate_index( $index );
281		$this->type->validate_element( $element );
282
283		$a = array_slice( $this->elements, 0, $index );
284		$b = array_slice( $this->elements, $index, count( $this->elements ) );
285
286		$a[] = $element;
287
288		return $this->new_from_trusted( array_merge( $a, $b ) );
289		}
290
291		/**
292		* {@inheritdoc}
293		*
294		* @param int $index Index to start insertion at.
295		* @param array $elements Elements in insert.
296		*
297		* @return Collection
298		*
299		* @throws OutOfRangeException
300		*/
301		public function insert_range( $index, array $elements ) {
302		$this->validate_index( $index );
303		$this->type->validate_elements( $elements );
304
305		if ( $index < 0 ) {
306		$index = $this->count() + $index + 1;
307		}
308
309		return $this->new_from_trusted(
310		array_merge(
311		array_slice( $this->elements, 0, $index ),
312		$elements,
313		array_slice( $this->elements, $index, count( $this->elements ) )
314		)
315		);
316		}
317
318		/**
319		* {@inheritdoc}
320		*
321		* @param callable $condition Condition to satisfy.
322		*
323		* @return Collection
324		*/
325		public function without( $condition ) {
326		$inverse = function ( $element ) use ( $condition ) {
327		return ! call_user_func( $condition, $element );
328		};
329
330		return $this->filter( $inverse );
331		}
332
333		/**
334		* {@inheritdoc}
335		*
336		* @param int $index Index to remove.
337		*
338		* @return Collection
339		*
340		* @throws OutOfRangeException
341		*/
342		public function remove_at( $index ) {
343		$this->validate_index( $index );
344
345		$elements = $this->elements;
346
347		return $this->new_from_trusted(
348		array_merge(
349		array_slice( $elements, 0, $index ),
350		array_slice( $elements, $index + 1, count( $elements ) )
351		)
352		);
353		}
354		/**
355		* {@inheritdoc}
356		*
357		* @return Collection
358		*/
359		public function reverse() {
360		return $this->new_from_trusted(
361		array_reverse( $this->elements )
362		);
363		}
364
365		/**
366		* {@inheritdoc}
367		*
368		* @param callable $callback Sort callback.
369		*
370		* @return Collection
371		*/
372		public function sort( $callback ) {
373		$elements = $this->elements;
374		usort( $elements, $callback );
375		return $this->new_from_trusted( $elements );
376		}
377
378		/**
379		* {@inheritdoc}
380		*
381		* @return array
382		*/
383	9	public function to_array() {
384	9	return $this->elements;
385		}
386
387		/**
388		* {@inheritdoc}
389		*
390		* @param callable $callable Reducer function.
391		*
392		* @param null $initial Initial reducer value.
393		*
394		* @return mixed
395		*/
396		public function reduce( $callable, $initial = null ) {
397		return array_reduce( $this->elements, $callable, $initial );
398		}
399
400		/**
401		* {@inheritdoc}
402		*
403		* @param callable $condition Condition callback.
404		*
405		* @return bool
406		*/
407	6	public function every( $condition ) {
408	6	$response = true;
409
410	6	foreach ( $this->elements as $element ) {
411	6	$result = call_user_func( $condition, $element );
412
413	6	if ( false === $result ) {
414	3	$response = false;
415	3	break;
416		}
417	4	}
418
419	6	return $response;
420		}
421
422		/**
423		* {@inheritdoc}
424		*
425		* @param int $num Number of elements to drop.
426		*
427		* @return Collection
428		*
429		* @throws InvalidArgumentException
430		*/
431	18	public function drop( $num ) {
432	18	if ( $num > $this->count() ) {
433	3	$num = $this->count();
434	2	}
435
436	18	return $this->slice( $num, $this->count() );
437		}
438
439		/**
440		* {@inheritdoc}
441		*
442		* @param int $num Number of elements to drop.
443		*
444		* @return Collection
445		*
446		* @throws InvalidArgumentException
447		*/
448	9	public function drop_right( $num ) {
449	9	return $num !== $this->count()
450	9	? $this->slice( 0, $this->count() - $num - 1 )
451	9	: $this->clear();
452		}
453
454		/**
455		* {@inheritdoc}
456		*
457		* @param callable $condition Condition callback.
458		*
459		* @return Collection
460		*/
461	9	public function drop_while( $condition ) {
462	9	$count = $this->count_while_true( $condition );
463	9	return $count ? $this->drop( $count ) : $this;
464		}
465		/**
466		* {@inheritdoc}
467		*
468		* @return Collection
469		*
470		* @throws InvalidArgumentException
471		*/
472		public function tail() {
473		return $this->slice( 1, $this->count() );
474		}
475
476		/**
477		* {@inheritdoc}
478		*
479		* @param int $num Number of elements to take.
480		*
481		* @return Collection
482		*
483		* @throws InvalidArgumentException
484		*/
485		public function take( $num ) {
486		return $this->slice( 0, $num - 1 );
487		}
488
489		/**
490		* {@inheritdoc}
491		*
492		* @param int $num Number of elements to take.
493		*
494		* @return Collection
495		*
496		* @throws InvalidArgumentException
497		*/
498		public function take_right( $num ) {
499		return $this->slice( $this->count() - $num, $this->count() );
500		}
501
502		/**
503		* {@inheritdoc}
504		*
505		* @param callable $condition Callback function.
506		*
507		* @return Collection
508		*/
509		public function take_while( $condition ) {
510		$count = $this->count_while_true( $condition );
511
512		return $count ? $this->take( $count ) : $this->clear();
513		}
514
515		/**
516		* {@inheritdoc}
517		*
518		* @param callable $callable Callback function.
519		*/
520	3	public function each( $callable ) {
521	3	foreach ( $this->elements as $element ) {
522	3	call_user_func( $callable, $element );
523	2	}
524	3	}
525
526		/**
527		* {@inheritdoc}
528		*
529		* @param callable $callable Callback function.
530		*
531		* @return Collection
532		*/
533	9	public function map( $callable ) {
534	9	$elements = array();
535	9	$type = null;
536	9	foreach ( $this->elements as $element ) {
537	6	$result = call_user_func( $callable, $element );
538
539	6	if ( null === $type ) {
540	6	$type = gettype( $result );
541
542	6	if ( 'object' === $type ) {
543		$type = get_class( $result );
544		}
545	4	}
546
547	6	$elements[] = $result;
548	6	}
549
550	9	return $this->new_from_trusted( $elements, $type ? : $this->get_type() );
551		}
552
553		/**
554		* {@inheritdoc}
555		*
556		* @param callable $callable Reducer function.
557		* @param null $initial Initial value.
558		*
559		* @return mixed
560		*/
561		public function reduce_right( $callable, $initial = null ) {
562		return array_reduce(
563		array_reverse( $this->elements ),
564		$callable,
565		$initial
566		);
567		}
568
569		/**
570		* {@inheritdoc}
571		*
572		* @return Collection
573		*/
574		public function shuffle() {
575		$elements = $this->elements;
576		shuffle( $elements );
577
578		return $this->new_from_trusted( $elements );
579		}
580
581		/**
582		* {@inheritdoc}
583		*
584		* @param array\|Collection $elements Array of elements to merge.
585		*
586		* @return Collection
587		*
588		* @throws InvalidArgumentException
589		*/
590		public function merge( $elements ) {
591		if ( $elements instanceof static ) {
592		$elements = $elements->to_array();
593		}
594
595		if ( ! is_array( $elements ) ) {
596		throw new InvalidArgumentException( 'Merge must be given array or Collection' );
597		}
598
599		$this->type->validate_elements( $elements );
600
601		return $this->new_from_trusted(
602		array_merge( $this->elements, $elements )
603		);
604		}
605
606		/**
607		* {@inheritdoc}
608		*
609		* @return mixed
610		*
611		* @throws OutOfBoundsException
612		*/
613		public function first() {
614		if ( empty( $this->elements ) ) {
615		throw new OutOfBoundsException( 'Cannot get first element of empty Collection' );
616		}
617
618		return reset( $this->elements );
619		}
620
621		/**
622		* {@inheritdoc}
623		*
624		* @return mixed
625		*
626		* @throws OutOfBoundsException
627		*/
628		public function last() {
629		if ( empty( $this->elements ) ) {
630		throw new OutOfBoundsException( 'Cannot get last element of empty Collection' );
631		}
632
633		return end( $this->elements );
634		}
635
636		/**
637		* {@inheritdoc}
638		*
639		* @return int
640		*/
641	99	public function count() {
642	99	return count( $this->elements );
643		}
644
645		/**
646		* {@inheritDoc}
647		*
648		* @return array
649		*/
650		public function serialize() {
651	9	return $this->map(function( $element ) {
652	6	if ( $element instanceof Serializes ) {
653	3	return $element->serialize();
654		}
655
656	3	return $element;
657	9	} )->to_array();
658		}
659
660		/**
661		* Return the current element.
662		*
663		* @return mixed
664		*/
665	3	public function current() {
666	3	return $this->at( $this->position );
667		}
668
669		/**
670		* Move forward to next element.
671		*/
672	3	public function next() {
673	3	$this->position ++;
674	3	}
675
676		/**
677		* Return the key of the current element.
678		*
679		* @return mixed
680		*/
681	3	public function key() {
682	3	return $this->position;
683		}
684
685		/**
686		* Checks if current position is valid.
687		*
688		* @return bool
689		*/
690	3	public function valid() {
691	3	return isset( $this->elements[ $this->position ] );
692		}
693
694		/**
695		* Rewind the Iterator to the first element.
696		*/
697	3	public function rewind() {
698	3	$this->position = 0;
699	3	}
700
701		/**
702		* Creates a new instance of the Collection
703		* from a trusted set of elements.
704		*
705		* @param array $elements Array of elements to pass into new collection.
706		* @param null\|mixed $type
707		*
708		* @return static
709		*/
710	39	protected function new_from_trusted( array $elements, $type = null ) {
711	39	$collection = new static( null !== $type ? $type : $this->get_type() );
712	39	$collection->set_from_trusted( $elements );
713
714	39	return $collection;
715		}
716
717		/**
718		* Sets the elements without validating them.
719		*
720		* @param array $elements Pre-validated elements to set.
721		*/
722	84	protected function set_from_trusted( array $elements ) {
723	84	$this->elements = $elements;
724	84	}
725
726		/**
727		* Number of elements true for the condition.
728		*
729		* @param callable $condition Condition to check.
730		* @return int
731		*/
732	9	protected function count_while_true( $condition ) {
733	9	$count = 0;
734
735	9	foreach ( $this->elements as $element ) {
736	9	if ( ! $condition($element) ) {
737	6	break;
738		}
739	6	$count++;
740	6	}
741
742	9	return $count;
743		}
744
745		/**
746		* Validates a number to be used as an index.
747		*
748		* @param integer $index The number to be validated as an index.
749		*
750		* @throws OutOfRangeException
751		*/
752	51	protected function validate_index( $index ) {
753	51	$exists = $this->index_exists( $index );
754
755	45	if ( ! $exists ) {
756	3	throw new OutOfRangeException( 'Index out of bounds of collection' );
757		}
758	42	}
759		}
760

intraxia / jaxion

Pull Request — master (#16)

Collection::validate_index() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like