API Documentation

Service/Amazon/ResultSet.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Amazon  
version
$Id: ResultSet.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Amazon_ResultSet

Implements
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Amazon  

Properties

Propertyprotectedint  $_currentIndex= '0'

Current index for SeekableIterator

Default value0Details
Type
int
Propertyprotected\DOMDocument  $_dom= ''

Amazon Web Service Return Document

Details
Type
\DOMDocument
Propertyprotected\DOMNodeList  $_results= 'null'

A DOMNodeList of <Item> elements

Default valuenullDetails
Type
\DOMNodeList
Propertyprotected\DOMXPath  $_xpath= ''

XPath Object for $this->_dom

Details
Type
\DOMXPath

Methods

methodpublic__construct( \DOMDocument $dom ) : void

Create an instance of Zend_Service_Amazon_ResultSet and create the necessary data objects

Parameters
Name Type Description
$dom \DOMDocument
methodpubliccurrent( ) : \Zend_Service_Amazon_Item

Implement SeekableIterator::current()

Returns
Type Description
\Zend_Service_Amazon_Item
methodpublickey( ) : int

Implement SeekableIterator::key()

Returns
Type Description
int
methodpublicnext( ) : void

Implement SeekableIterator::next()

methodpublicrewind( ) : void

Implement SeekableIterator::rewind()

methodpublicseek( int $index ) : void

Implement SeekableIterator::seek()

Parameters
Name Type Description
$index int
Throws
Exception Description
\OutOfBoundsException
methodpublictotalPages( ) : int

Total Number of pages returned

Returns
Type Description
int Total number of pages returned
methodpublictotalResults( ) : int

Total Number of results returned

Returns
Type Description
int Total number of results returned
methodpublicvalid( ) : boolean

Implement SeekableIterator::valid()

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.