Intraxia\Jaxion\Axolotl\Collection

Complexity

Total Complexity

32

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

71.67%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
B	add()	0	13	5
B	remove()	0	17	7
A	at()	0	3	2
A	map()	0	3	1
A	filter()	0	3	1
A	key()	0	3	1
A	find()	0	9	3
A	serialize()	0	9	2
A	current()	0	3	1
A	next()	0	3	1
A	valid()	0	3	1
A	rewind()	0	3	1
A	count()	0	3	1
A	parse_config()	0	11	3

<?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;
		}
	}
}