class Braintree_ResourceCollection in Commerce Braintree 7

ResourceCollection is a container object for result data

stores and retrieves search results and aggregate data

example: <code> $result = Braintree_Customer::all();

foreach($result as $transaction) { print_r($transaction->id); } </code>

@package Braintree @subpackage Utility @copyright 2010 Braintree Payment Solutions

Hierarchy

• class \Braintree_ResourceCollection implements \Iterator

File

braintree_php/lib/Braintree/ResourceCollection.php, line 28

class Braintree_ResourceCollection implements Iterator {
  private $_index;
  private $_batchIndex;
  private $_items;
  private $_pageSize;
  private $_pager;

  /**
   * set up the resource collection
   *
   * expects an array of attributes with literal keys
   *
   * @param array $attributes
   * @param array $pagerAttribs
   */
  public function __construct($response, $pager) {
    $this->_pageSize = $response["searchResults"]["pageSize"];
    $this->_ids = $response["searchResults"]["ids"];
    $this->_pager = $pager;
  }

  /**
   * returns the current item when iterating with foreach
   */
  public function current() {
    return $this->_items[$this->_index];
  }

  /**
   * returns the first item in the collection
   *
   * @return mixed
   */
  public function firstItem() {
    $ids = $this->_ids;
    $page = $this
      ->_getPage(array(
      $ids[0],
    ));
    return $page[0];
  }
  public function key() {
    return null;
  }

  /**
   * advances to the next item in the collection when iterating with foreach
   */
  public function next() {
    ++$this->_index;
  }

  /**
   * rewinds thtestIterateOverResultse collection to the first item when iterating with foreach
   */
  public function rewind() {
    $this->_batchIndex = 0;
    $this
      ->_getNextPage();
  }

  /**
   * returns whether the current item is valid when iterating with foreach
   */
  public function valid() {
    if ($this->_index == count($this->_items) && $this->_batchIndex < count($this->_ids)) {
      $this
        ->_getNextPage();
    }
    if ($this->_index < count($this->_items)) {
      return true;
    }
    else {
      return false;
    }
  }
  public function maximumCount() {
    return count($this->_ids);
  }
  private function _getNextPage() {
    if (empty($this->_ids)) {
      $this->_items = array();
    }
    else {
      $this->_items = $this
        ->_getPage(array_slice($this->_ids, $this->_batchIndex, $this->_pageSize));
      $this->_batchIndex += $this->_pageSize;
      $this->_index = 0;
    }
  }

  /**
   * requests the next page of results for the collection
   *
   * @return none
   */
  private function _getPage($ids) {
    $className = $this->_pager['className'];
    $classMethod = $this->_pager['classMethod'];
    $methodArgs = array();
    foreach ($this->_pager['methodArgs'] as $arg) {
      array_push($methodArgs, $arg);
    }
    array_push($methodArgs, $ids);
    return call_user_func_array(array(
      $className,
      $classMethod,
    ), $methodArgs);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Braintree_ResourceCollection::$_batchIndex	private	property
Braintree_ResourceCollection::$_index	private	property
Braintree_ResourceCollection::$_items	private	property
Braintree_ResourceCollection::$_pager	private	property
Braintree_ResourceCollection::$_pageSize	private	property
Braintree_ResourceCollection::current	public	function	returns the current item when iterating with foreach
Braintree_ResourceCollection::firstItem	public	function	returns the first item in the collection
Braintree_ResourceCollection::key	public	function
Braintree_ResourceCollection::maximumCount	public	function
Braintree_ResourceCollection::next	public	function	advances to the next item in the collection when iterating with foreach
Braintree_ResourceCollection::rewind	public	function	rewinds thtestIterateOverResultse collection to the first item when iterating with foreach
Braintree_ResourceCollection::valid	public	function	returns whether the current item is valid when iterating with foreach
Braintree_ResourceCollection::_getNextPage	private	function
Braintree_ResourceCollection::_getPage	private	function	requests the next page of results for the collection
Braintree_ResourceCollection::__construct	public	function	set up the resource collection