blitze\sitemaker\model\base_collection

Complexity

Total Complexity

17

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

93.48%

Importance

Changes	3
Bugs	0	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	get_entities()	0	4	1
A	clear()	0	4	1
A	rewind()	0	4	1
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	count()	0	4	1
A	offsetSet()	0	17	3
A	offsetUnset()	0	21	3
A	offsetGet()	0	4	2
A	offsetExists()	0	4	1

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\model;

abstract class base_collection implements \Iterator, \Countable, \ArrayAccess
{
	protected $entities = array();

	protected $entity_class;

	/**
	 * Get the entities stored in the collection
	 */
	public function get_entities()
	{
		return $this->entities;
	}

	/**
	 * Clear the collection
	 */
	public function clear()
	{
		$this->entities = array();
	}

	/**
	 * Reset the collection (implementation required by Iterator Interface)
	 */
	public function rewind()
	{
		reset($this->entities);
	}

	/**
	 * Get the current entity in the collection (implementation required by Iterator Interface)
	 *
	 * @return mixed
	 */
	public function current()
	{
		return current($this->entities);
	}

	/**
	 * Get the next entity in the collection (implementation required by Iterator Interface)
	 *
	 * @return mixed
	 */
	public function next()
	{
		return next($this->entities);
	}

	/**
	 * Get the key of the current entity in the collection (implementation required by Iterator Interface)
	 *
	 * @return mixed
	 */
	public function key()
	{
		return key($this->entities);
	}

	/**
	 * Check if there’re more entities in the collection (implementation required by Iterator Interface)
	 *
	 * @return bool
	 */
	public function valid()
	{
		return ($this->current() !== false);
	}

	/**
	 * Count the number of entities in the collection (implementation required by Countable Interface)
	 *
	 * @return mixed
	 */
	public function count()
	{
		return count($this->entities);
	}

	/**
	 * Add an entity to the collection (implementation required by ArrayAccess interface)
	 *
	 * @param mixed $key
	 * @param mixed $entity
	 * @return bool
	 * @throws \blitze\sitemaker\exception\invalid_argument
	 */
	public function offsetSet($key, $entity)
	{
		if ($entity instanceof $this->entity_class)
		{
			if (!isset($key))
			{
				$this->entities[] = $entity;
			}
			else
			{
				$this->entities[$key] = $entity;
			}
			return true;
		}

		throw new \blitze\sitemaker\exception\invalid_argument(array('entity', 'INVALID_ENTITY'));
	}

	/**
	 * Remove an entity from the collection (implementation required by ArrayAccess interface)
	 *
	 * @param mixed $key
	 * @return bool
	 */
	public function offsetUnset($key)
	{
		if ($key instanceof $this->entity_class)
		{
			$this->entities = array_filter(
				$this->entities,
				function ($v) use ($key)
				{
					return $v !== $key;
				}
			);
			return true;
		}

		if (isset($this->entities[$key]))
		{
			unset($this->entities[$key]);
			return true;
		}
		return false;
	}

	/**
	 * Get the specified entity in the collection (implementation required by ArrayAccess interface)
	 *
	 * @param mixed $key
	 * @return null
	 */
	public function offsetGet($key)
	{
		return isset($this->entities[$key]) ? $this->entities[$key] : null;
	}

	/**
	 * Check if the specified entity exists in the collection (implementation required by ArrayAccess interface)
	 *
	 * @param mixed $key
	 * @return bool
	 */
	public function offsetExists($key)
	{
		return isset($this->entities[$key]);
	}
}