class Braintree_Collection in Commerce Braintree 7

Generic Collection class

Based on Generic Collection class from: {@link http://codeutopia.net/code/library/CU/Collection.php}

@package Braintree @subpackage Utility

Hierarchy

• class \Braintree_Collection implements \Countable, \IteratorAggregate, \ArrayAccess

File

braintree_php/lib/Braintree/Collection.php, line 21

class Braintree_Collection implements Countable, IteratorAggregate, ArrayAccess {

  /**
   *
   * @var array $_collection collection storage
   */
  protected $_collection = array();

  /**
   * Add a value into the collection
   * @param string $value
   */
  public function add($value) {
    $this->_collection[] = $value;
  }

  /**
   * Set index's value
   * @param integer $index
   * @param mixed $value
   * @throws OutOfRangeException
   */
  public function set($index, $value) {
    if ($index >= $this
      ->count()) {
      throw new OutOfRangeException('Index out of range');
    }
    $this->_collection[$index] = $value;
  }

  /**
   * Remove a value from the collection
   * @param integer $index index to remove
   * @throws OutOfRangeException if index is out of range
   */
  public function remove($index) {
    if ($index >= $this
      ->count()) {
      throw new OutOfRangeException('Index out of range');
    }
    array_splice($this->_collection, $index, 1);
  }

  /**
   * Return value at index
   * @param integer $index
   * @return mixed
   * @throws OutOfRangeException
   */
  public function get($index) {
    if ($index >= $this
      ->count()) {
      throw new OutOfRangeException('Index out of range');
    }
    return $this->_collection[$index];
  }

  /**
   * Determine if index exists
   * @param integer $index
   * @return boolean
   */
  public function exists($index) {
    if ($index >= $this
      ->count()) {
      return false;
    }
    return true;
  }

  /**
   * Return count of items in collection
   * Implements countable
   * @return integer
   */
  public function count() {
    return count($this->_collection);
  }

  /**
   * Return an iterator
   * Implements IteratorAggregate
   * @return ArrayIterator
   */
  public function getIterator() {
    return new ArrayIterator($this->_collection);
  }

  /**
   * Set offset to value
   * Implements ArrayAccess
   * @see set
   * @param integer $offset
   * @param mixed $value
   */
  public function offsetSet($offset, $value) {
    $this
      ->set($offset, $value);
  }

  /**
   * Unset offset
   * Implements ArrayAccess
   * @see remove
   * @param integer $offset
   */
  public function offsetUnset($offset) {
    $this
      ->remove($offset);
  }

  /**
   * get an offset's value
   * Implements ArrayAccess
   * @see get
   * @param integer $offset
   * @return mixed
   */
  public function offsetGet($offset) {
    return $this
      ->get($offset);
  }

  /**
   * Determine if offset exists
   * Implements ArrayAccess
   * @see exists
   * @param integer $offset
   * @return boolean
   */
  public function offsetExists($offset) {
    return $this
      ->exists($offset);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Braintree_Collection::$_collection	protected	property
Braintree_Collection::add	public	function	Add a value into the collection
Braintree_Collection::count	public	function	Return count of items in collection Implements countable
Braintree_Collection::exists	public	function	Determine if index exists
Braintree_Collection::get	public	function	Return value at index
Braintree_Collection::getIterator	public	function	Return an iterator Implements IteratorAggregate
Braintree_Collection::offsetExists	public	function	Determine if offset exists Implements ArrayAccess
Braintree_Collection::offsetGet	public	function	get an offset's value Implements ArrayAccess
Braintree_Collection::offsetSet	public	function	Set offset to value Implements ArrayAccess
Braintree_Collection::offsetUnset	public	function	Unset offset Implements ArrayAccess
Braintree_Collection::remove	public	function	Remove a value from the collection
Braintree_Collection::set	public	function	Set index's value