path: root/framework/Collections/TList.php

<?php
/**
 * TList, TListIterator classes
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.pradosoft.com/
 * @copyright Copyright &copy; 2005 PradoSoft
 * @license http://www.pradosoft.com/license/
 * @version $Revision: $  $Date: $
 * @package System.Collections
 */

/**
 * TList class
 *
 * TList implements an integer-indexed collection class.
 *
 * You can access, append, insert, remove an item by using
 * {@link itemAt}, {@link add}, {@link addAt}, {@link remove}, and {@link removeAt}.
 * To get the number of the items in the list, use {@link getCount}.
 * TList can also be used like a regular array as follows,
 * <code>
 * $list[]=$item;  // append at the end
 * $list[$index]=$item; // $index must be between 0 and $list->Count
 * unset($list[$index]); // remove the item at $index
 * if(isset($list[$index])) // if the list has an item at $index
 * foreach($list as $index=>$item) // traverse each item in the list
 * </code>
 * Note, count($list) will always return 1. You should use {@link getCount()}
 * to determine the number of items in the list.
 *
 * To extend TList by doing additional operations with each added or removed item,
 * you can override {@link addedItem} and {@link removedItem}.
 * You can also override {@link canAddItem} and {@link canRemoveItem} to
 * control whether to add or remove a particular item.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @version $Revision: $  $Date: $
 * @package System.Collections
 * @since 3.0
 */
class TList extends TComponent implements IteratorAggregate,ArrayAccess
{
	/**
	 * internal data storage
	 * @var array
	 */
	private $_d=array();
	/**
	 * number of items
	 * @var integer
	 */
	private $_c=0;

	/**
	 * Constructor.
	 * Initializes the list with an array or an iterable object.
	 * @param array|Iterator the intial data. Default is null, meaning no initialization.
	 * @throws TInvalidDataTypeException If data is not null and neither an array nor an iterator.
	 */
	public function __construct($data=null)
	{
		parent::__construct();
		if($data!==null)
			$this->copyFrom($data);
	}

	/**
	 * Returns an iterator for traversing the items in the list.
	 * This method is required by the interface IteratorAggregate.
	 * @return Iterator an iterator for traversing the items in the list.
	 */
	public function getIterator()
	{
		return new TListIterator($this->_d);
	}

	/**
	 * @return integer the number of items in the list
	 */
	public function getCount()
	{
		return $this->_c;
	}

	/**
	 * Returns the item at the specified offset.
	 * This method is exactly the same as {@link offsetGet}.
	 * @param integer the index of the item
	 * @return mixed the item at the index
	 * @throws TIndexOutOfRangeException if the index is out of the range
	 */
	public function itemAt($index)
	{
		if(isset($this->_d[$index]))
			return $this->_d[$index];
		else
			throw new TIndexOutOfRangeException('list_index_invalid',$index);
	}

	/**
	 * Appends an item at the end of the list.
	 * @param mixed new item
	 * @throws TInvalidOperationException If the item is not allowed to be added
	 */
	public function add($item)
	{
		if($this->canAddItem($item))
		{
			$this->_d[$this->_c++]=$item;
			$this->addedItem($item);
		}
		else
			throw new TInvalidOperationException('list_addition_disallowed');
	}

	/**
	 * Inserts an item at the specified position.
	 * Original item at the position and the next items
	 * will be moved one step towards the end.
	 * @param integer the speicified position.
	 * @param mixed new item
	 * @throws TIndexOutOfRangeException If the index specified exceeds the bound
	 * @throws TInvalidOperationException If the item is not allowed to be added
	 */
	public function addAt($index,$item)
	{
		if($this->canAddItem($item))
		{
			if($index===$this->_c)
				$this->add($item);
			else if($index>=0 && $index<$this->_c)
			{
				array_splice($this->_d,$index,0,array($item));
				$this->_c++;
				$this->addedItem($item);
			}
			else
				throw new TIndexOutOfRangeException('list_index_invalid',$index);
		}
		else
			throw new TInvalidOperationException('list_addition_disallowed');

	}

	/**
	 * Removes an item from the list.
	 * The list will first search for the item.
	 * The first item found will be removed from the list.
	 * @param mixed the item to be removed.
	 * @throws TInvalidOperationException If the item cannot be removed
	 * @throws TInvalidDataValueException If the item does not exist
	 */
	public function remove($item)
	{
		if(($index=$this->indexOf($item))>=0)
		{
			if($this->canRemoveItem($item))
				$this->removeAt($index);
			else
				throw new TInvalidOperationException('list_item_unremovable');
		}
		else
			throw new TInvalidDataValueException('list_item_inexistent');
	}

	/**
	 * Removes an item at the specified position.
	 * @param integer the index of the item to be removed.
	 * @return mixed the removed item.
	 * @throws TOutOfRangeException If the index specified exceeds the bound
	 * @throws TInvalidOperationException If the item cannot be removed
	 */
	public function removeAt($index)
	{
		if(isset($this->_d[$index]))
		{
			$item=$this->_d[$index];
			if($this->canRemoveItem($item))
			{
				if($index===$this->_c-1)
					unset($this->_d[$index]);
				else
					array_splice($this->_d,$index,1);
				$this->_c--;
				$this->removedItem($item);
				return $item;
			}
			else
				throw new TInvalidOperationException('list_item_unremovable');
		}
		else
			throw new TIndexOutOfRangeException('list_index_invalid',$index);
	}

	/**
	 * Removes all items in the list.
	 */
	public function clear()
	{
		for($i=$this->_c-1;$i>=0;--$i)
			$this->removeAt($i);
	}

	/**
	 * @param mixed the item
	 * @return boolean whether the list contains the item
	 */
	public function contains($item)
	{
		return $this->indexOf($item)>=0;
	}

	/**
	 * @param mixed the item
	 * @return integer the index of the item in the list (0 based), -1 if not found.
	 */
	public function indexOf($item)
	{
		if(($index=array_search($item,$this->_d,true))===false)
			return -1;
		else
			return $index;
	}

	/**
	 * @return array the list of items in array
	 */
	public function toArray()
	{
		return $this->_d;
	}

	/**
	 * Copies iterable data into the list.
	 * Note, existing data in the list will be cleared first.
	 * @param mixed the data to be copied from, must be an array or object implementing Traversable
	 * @throws TInvalidDataTypeException If data is neither an array nor a Traversable.
	 */
	public function copyFrom($data)
	{
		if(is_array($data) || ($data instanceof Traversable))
		{
			if($this->_c>0)
				$this->clear();
			foreach($data as $item)
				$this->add($item);
		}
		else
			throw new TInvalidDataTypeException('list_data_not_iterable');
	}

	/**
	 * Merges iterable data into the map.
	 * New data will be appended to the end of the existing data.
	 * @param mixed the data to be merged with, must be an array or object implementing Traversable
	 * @throws TInvalidDataTypeException If data is neither an array nor an iterator.
	 */
	public function mergeWith($data)
	{
		if(is_array($data) || ($data instanceof Traversable))
		{
			foreach($data as $item)
				$this->add($item);
		}
		else
			throw new TInvalidDataTypeException('list_data_not_iterable');
	}

	/**
	 * Returns whether there is an item at the specified offset.
	 * This method is required by the interface ArrayAccess.
	 * @param integer the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
		return isset($this->_d[$offset]);
	}

	/**
	 * Returns the item at the specified offset.
	 * This method is required by the interface ArrayAccess.
	 * @param integer the offset to retrieve item.
	 * @return mixed the item at the offset
	 * @throws TIndexOutOfRangeException if the offset is invalid
	 */
	public function offsetGet($offset)
	{
		if(isset($this->_d[$offset]))
			return $this->_d[$offset];
		else
			throw new TIndexOutOfRangeException('list_index_invalid',$offset);
	}

	/**
	 * Sets the item at the specified offset.
	 * This method is required by the interface ArrayAccess.
	 * @param integer the offset to set item
	 * @param mixed the item value
	 * @throws TOutOfRangeException If the index specified exceeds the bound
	 */
	public function offsetSet($offset,$item)
	{
		if($offset===null || $offset===$this->_c)
			$this->add($item);
		else
		{
			$this->removeAt($offset);
			$this->addAt($offset,$item);
		}
	}

	/**
	 * Unsets the item at the specified offset.
	 * This method is required by the interface ArrayAccess.
	 * @param integer the offset to unset item
	 * @throws TOutOfRangeException If the index specified exceeds the bound
	 */
	public function offsetUnset($offset)
	{
		$this->removeAt($offset);
	}

	/**
	 * This method is invoked after an item is successfully added to the list.
	 * You can override this method to provide customized processing of the addition.
	 * @param mixed the newly added item
	 */
	protected function addedItem($item)
	{
	}

	/**
	 * This method is invoked after an item is successfully removed from the list.
	 * You can override this method to provide customized processing of the removal.
	 * @param mixed the removed item
	 */
	protected function removedItem($item)
	{
	}

	/**
	 * This method is invoked before adding an item to the list.
	 * If it returns true, the item will be added to the list, otherwise not.
	 * You can override this method to decide whether a specific can be added.
	 * @param mixed item to be added
	 * @return boolean whether the item can be added to the list
	 */
	protected function canAddItem($item)
	{
		return true;
	}

	/**
	 * This method is invoked before removing an item from the list.
	 * If it returns true, the item will be removed from the list, otherwise not.
	 * You can override this method to decide whether a specific can be removed.
	 * @param mixed item to be removed
	 * @return boolean whether the item can be removed to the list
	 */
	protected function canRemoveItem($item)
	{
		return true;
	}
}


/**
 * TListIterator class
 *
 * TListIterator implements Iterator interface.
 *
 * TListIterator is used by TList. It allows TList to return a new iterator
 * for traversing the items in the list.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @version $Revision: $  $Date: $
 * @package System.Collections
 * @since 3.0
 */
class TListIterator implements Iterator
{
	/**
	 * @var array the data to be iterated through
	 */
	private $_d;
	/**
	 * @var integer index of the current item
	 */
	private $_i;

	/**
	 * Constructor.
	 * @param array the data to be iterated through
	 */
	public function __construct(&$data)
	{
		$this->_d=&$data;
		$this->_i=0;
	}

	/**
	 * Rewinds internal array pointer.
	 * This method is required by the interface Iterator.
	 */
	public function rewind()
	{
		$this->_i=0;
	}

	/**
	 * Returns the key of the current array item.
	 * This method is required by the interface Iterator.
	 * @return integer the key of the current array item
	 */
	public function key()
	{
		return $this->_i;
	}

	/**
	 * Returns the current array item.
	 * This method is required by the interface Iterator.
	 * @return mixed the current array item
	 */
	public function current()
	{
		return $this->_d[$this->_i];
	}

	/**
	 * Moves the internal pointer to the next array item.
	 * This method is required by the interface Iterator.
	 */
	public function next()
	{
		$this->_i++;
	}

	/**
	 * Returns whether there is an item at current position.
	 * This method is required by the interface Iterator.
	 * @return boolean
	 */
	public function valid()
	{
		return isset($this->_d[$this->_i]);
	}
}

?>