silverstripe-framework/model/ArrayList.php

<?php
/**
 * A list object that wraps around an array of objects or arrays.
 *
 * @package    sapphire
 * @subpackage model
 */
class ArrayList extends ViewableData implements SS_List {

	/**
	 * @var array
	 */
	protected $array;

	public function __construct(array $array = array()) {
		$this->array = $array;
		parent::__construct();
	}

	public function count() {
		return count($this->array);
	}

	public function exists() {
		return (bool) count($this);
	}

	public function getIterator() {
		return new ArrayIterator($this->array);
	}

	public function toArray() {
		return $this->array;
	}

	public function toNestedArray() {
		$result = array();

		foreach ($this->array as $item) {
			if (is_object($item)) {
				if (method_exists($item, 'toMap')) {
					$result[] = $item->toMap();
				} else {
					$result[] = (array) $item;
				}
			} else {
				$result[] = $item;
			}
		}

		return $result;
	}

	public function getRange($offset, $length) {
		return new ArrayList(array_slice($this->array, $offset, $length));
	}

	public function add($item) {
		$this->push($item);
	}

	public function remove($item) {
		foreach ($this->array as $key => $value) {
			if ($item === $value) unset($this->array[$key]);
		}
	}

	/**
	 * Replaces an item in this list with another item.
	 *
	 * @param array|object $item
	 * @param array|object $with
	 */
	public function replace($item, $with) {
		foreach ($this->array as $key => $candidate) {
			if ($candidate === $item) {
				$this->array[$key] = $with;
				return;
			}
		}
	}

	/**
	 * Merges with another array or list by pushing all the items in it onto the
	 * end of this list.
	 *
	 * @param array|object $with
	 */
	public function merge($with) {
		foreach ($with as $item) $this->push($item);
	}

	/**
	 * Removes items from this list which have a duplicate value for a certain
	 * field. This is especially useful when combining lists.
	 *
	 * @param string $field
	 */
	public function removeDuplicates($field = 'ID') {
		$seen = array();

		foreach ($this->array as $key => $item) {
			$value = $this->extract($item, $field);

			if (array_key_exists($value, $seen)) {
				unset($this->array[$key]);
			}

			$seen[$value] = true;
		}
	}

	/**
	 * Pushes an item onto the end of this list.
	 *
	 * @param array|object $item
	 */
	public function push($item) {
		$this->array[] = $item;
	}

	/**
	 * Pops the last element off the end of the list and returns it.
	 *
	 * @return array|object
	 */
	public function pop() {
		return array_pop($this->array);
	}

	/**
	 * Unshifts an item onto the beginning of the list.
	 *
	 * @param array|object $item
	 */
	public function unshift($item) {
		array_unshift($this->array, $item);
	}

	/**
	 * Shifts the item off the beginning of the list and returns it.
	 *
	 * @return array|object
	 */
	public function shift() {
		return array_shift($this->array);
	}

	public function first() {
		return reset($this->array);
	}

	public function last() {
		return end($this->array);
	}

	public function map($keyfield, $titlefield) {
		$map = array();
		foreach ($this->array as $item) {
			$map[$this->extract($item, $keyfield)] = $this->extract($item, $titlefield);
		}
		return $map;
	}

	public function find($key, $value) {
		foreach ($this->array as $item) {
			if ($this->extract($item, $key) == $value) return $item;
		}
	}

	public function column($field = 'ID') {
		$result = array();
		foreach ($this->array as $item) {
			$result[] = $this->extract($item, $field);
		}
		return $result;
	}

	public function canSortBy($by) {
		return true;
	}

	public function sort($by, $dir = 'ASC') {
		$sorts = array();
		$dir   = strtoupper($dir) == 'DESC' ? SORT_DESC : SORT_ASC;

		foreach ($this->array as $item) {
			$sorts[] = $this->extract($item, $by);
		}

		array_multisort($sorts, $dir, $this->array);
	}

	public function offsetExists($offset) {
		return array_key_exists($offset, $this->array);
	}

	public function offsetGet($offset) {
		if ($this->offsetExists($offset)) return $this->array[$offset];
	}

	public function offsetSet($offset, $value) {
		$this->array[$offset] = $value;
	}

	public function offsetUnset($offset) {
		unset($this->array[$offset]);
	}

	/**
	 * Extracts a value from an item in the list, where the item is either an
	 * object or array.
	 *
	 * @param  array|object $item
	 * @param  string $key
	 * @return mixed
	 */
	protected function extract($item, $key) {
		if (is_object($item)) {
			return $item->$key;
		} else {
			if (array_key_exists($key, $item)) return $item[$key];
		}
	}

}