Collection::parse_config() - Code Metrics - Inspection of "Merge pull request #12 from intraxia/feature/enque..." - intraxia/jaxion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a8d3e3...cc8041 )

by James

created 2017-01-07 22:49 UTC

Collection::parse_config() A

↳ Parent: Collection

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	11
ccs	0
cts	0
cp	0
rs	9.4285
cc	3
eloc	6
nc	3
nop	1
crap	12

<?php
namespace Intraxia\Jaxion\Axolotl;

use Countable;
use Intraxia\Jaxion\Contract\Axolotl\Serializes;
use Iterator;
use LogicException;
use RuntimeException;

/**
 * Class Collection
 *
 * @package Intraxia\Jaxion
 * @subpackage Axolotl
 */
class Collection implements Countable, Iterator, Serializes {
	/**
	 * Collection elements.
	 *
	 * @var array
	 */
	protected $elements = array();

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

	/**
	 * Models registered to the collection.
	 *
	 * @var string
	 */
	protected $model;

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

	/**
	 * Collection constructor.
	 *
	 * @param array $elements
	 * @param array $config
	 */
	public function __construct( array $elements = array(), array $config = array() ) {
		$this->parse_config( $this->config = $config );

		foreach ( $elements as $element ) {
			$this->add( $element );
		}
	}

	/**
	 * Adds a new element to the Collection.
	 *
	 * @param mixed $element
	 *
	 * @throws RuntimeException
	 *
	 * @return $this
	 */
	public function add( $element ) {
		if ( $this->model && is_array( $element ) ) {
			$element = new $this->model( $element );
		}

		if ( $this->model && ! ( $element instanceof $this->model ) ) {
			throw new RuntimeException;
		}

		$this->elements[] = $element;

		return $this;
	}

	/**
	 * Removes an element by index or value.
	 *
	 * @param mixed $index
	 *
	 * @return $this
	 */
	public function remove( $index ) {
		if ( ! is_string( $index ) || ! is_numeric( $index ) || ! isset( $this->elements[ $index ] ) ) {
			foreach ( $this->elements as $key => $element ) {
				if ( $element === $index ) {
					$index = $key;
					break;
				}
			}
		}

		if ( isset( $this->elements[ $index ] ) ) {
			unset( $this->elements[ $index ] );
			$this->elements = array_values( $this->elements );
		}

		return $this;
	}

	/**
	 * Fetches the element at the provided index.
	 *
	 * @param int $index
	 *
	 * @return mixed|null
	 */
	public function at( $index ) {
		return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null;
	}

	/**
	 * Maps over the Collection's elements,
	 *
	 * @param callable $callback
	 *
	 * @return Collection
	 */
	protected function map( callable $callback ) {
		return new Collection( array_map( $callback, $this->elements ), $this->config );
	}

	/**
	 * Filters the Collection's elements.
	 *
	 * @param callable $callback
	 *
	 * @return Collection
	 */
	public function filter( callable $callback ) {
		return new Collection( array_filter( $this->elements, $callback ) );
	}

	/**
	 * Fetches a single element in the Collection by callback.
	 *
	 * @param callable $callback
	 *
	 * @return mixed|null
	 */
	public function find( callable $callback ) {
		foreach ( $this->elements as $element ) {
			if ( call_user_func( $callback, $element ) ) {
				return $element;
			}
		}

		return null;
	}

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

			return $element;
		}, $this->elements);
	}

	/**
	 * 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;
	}

	/**
	 * Count elements of an object.
	 *
	 * @return int
	 */
	public function count() {
		return count( $this->elements );
	}

	/**
	 * Parses the Collection config to set its properties.
	 *
	 * @param array $config
	 *
	 * @throws LogicException
	 */
	protected function parse_config( array $config ) {
		if ( isset( $config['model'] ) ) {
			$model = $config['model'];

			if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) {
				throw new LogicException;
			}

			$this->model = $model;
		}
	}
}


1		<?php
2		namespace Intraxia\Jaxion\Axolotl;
3
4		use Countable;
5		use Intraxia\Jaxion\Contract\Axolotl\Serializes;
6		use Iterator;
7		use LogicException;
8		use RuntimeException;
9
10		/**
11		* Class Collection
12		*
13		* @package Intraxia\Jaxion
14		* @subpackage Axolotl
15		*/
16		class Collection implements Countable, Iterator, Serializes {
17		/**
18		* Collection elements.
19		*
20		* @var array
21		*/
22		protected $elements = array();
23
24		/**
25		* Collection configuration.
26		*
27		* @var array
28		*/
29		protected $config = array();
30
31		/**
32		* Models registered to the collection.
33		*
34		* @var string
35		*/
36		protected $model;
37
38		/**
39		* Where Collection is in loop.
40		*
41		* @var int
42		*/
43		protected $position = 0;
44
45		/**
46		* Collection constructor.
47		*
48		* @param array $elements
49		* @param array $config
50		*/
51	60	public function __construct( array $elements = array(), array $config = array() ) {
52	60	$this->parse_config( $this->config = $config );
53
54	57	foreach ( $elements as $element ) {
55	24	$this->add( $element );
56	57	}
57	57	}
58
59		/**
60		* Adds a new element to the Collection.
61		*
62		* @param mixed $element
63		*
64		* @throws RuntimeException
65		*
66		* @return $this
67		*/
68	27	public function add( $element ) {
69	27	if ( $this->model && is_array( $element ) ) {
70	9	$element = new $this->model( $element );
71	9	}
72
73	27	if ( $this->model && ! ( $element instanceof $this->model ) ) {
74	3	throw new RuntimeException;
75		}
76
77	24	$this->elements[] = $element;
78
79	24	return $this;
80		}
81
82		/**
83		* Removes an element by index or value.
84		*
85		* @param mixed $index
86		*
87		* @return $this
88		*/
89		public function remove( $index ) {
90		if ( ! is_string( $index ) \|\| ! is_numeric( $index ) \|\| ! isset( $this->elements[ $index ] ) ) {
91		foreach ( $this->elements as $key => $element ) {
92		if ( $element === $index ) {
93		$index = $key;
94		break;
95		}
96		}
97		}
98
99		if ( isset( $this->elements[ $index ] ) ) {
100		unset( $this->elements[ $index ] );
101		$this->elements = array_values( $this->elements );
102		}
103
104		return $this;
105		}
106
107		/**
108		* Fetches the element at the provided index.
109		*
110		* @param int $index
111		*
112		* @return mixed\|null
113		*/
114	12	public function at( $index ) {
115	12	return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null;
116		}
117
118		/**
119		* Maps over the Collection's elements,
120		*
121		* @param callable $callback
122		*
123		* @return Collection
124		*/
125		protected function map( callable $callback ) {
126		return new Collection( array_map( $callback, $this->elements ), $this->config );
127		}
128
129		/**
130		* Filters the Collection's elements.
131		*
132		* @param callable $callback
133		*
134		* @return Collection
135		*/
136		public function filter( callable $callback ) {
137		return new Collection( array_filter( $this->elements, $callback ) );
138		}
139
140		/**
141		* Fetches a single element in the Collection by callback.
142		*
143		* @param callable $callback
144		*
145		* @return mixed\|null
146	9	*/
147	6	public function find( callable $callback ) {
148	3	foreach ( $this->elements as $element ) {
149		if ( call_user_func( $callback, $element ) ) {
150		return $element;
151	3	}
152	9	}
153
154		return null;
155		}
156
157		/**
158		* {@inheritDoc}
159		*
160	3	* @return array
161	3	*/
162		public function serialize() {
163		return array_map(function( $element ) {
164		if ( $element instanceof Serializes ) {
165		return $element->serialize();
166		}
167	3
168	3	return $element;
169	3	}, $this->elements);
170		}
171
172		/**
173		* Return the current element.
174		*
175		* @return mixed
176	3	*/
177	3	public function current() {
178		return $this->at( $this->position );
179		}
180
181		/**
182		* Move forward to next element.
183		*/
184		public function next() {
185	3	$this->position ++;
186	3	}
187
188		/**
189		* Return the key of the current element.
190		*
191		* @return mixed
192	3	*/
193	3	public function key() {
194	3	return $this->position;
195		}
196
197		/**
198		* Checks if current position is valid.
199		*
200		* @return bool
201	6	*/
202	6	public function valid() {
203		return isset( $this->elements[ $this->position ] );
204		}
205
206		/**
207		* Rewind the Iterator to the first element.
208		*/
209		public function rewind() {
210		$this->position = 0;
211		}
212	60
213	60	/**
214	15	* Count elements of an object.
215		*
216	15	* @return int
217	3	*/
218		public function count() {
219		return count( $this->elements );
220	12	}
221	12
222	57	/**
223		* Parses the Collection config to set its properties.
224		*
225		* @param array $config
226		*
227		* @throws LogicException
228		*/
229		protected function parse_config( array $config ) {
230		if ( isset( $config['model'] ) ) {
231		$model = $config['model'];
232
233		if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) {
234		throw new LogicException;
235		}
236
237		$this->model = $model;
238		}
239		}
240		}
241

intraxia / jaxion

Push — master ( a8d3e3...cc8041 )

Collection::parse_config() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like