API Documentation

Service/Yahoo/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
Yahoo  
version
$Id: ResultSet.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Yahoo_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
Yahoo  

Properties

Propertyprotectedint  $_currentIndex= '0'

Current Index for SeekableIterator

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

Yahoo Web Service Return Document

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

A DOMNodeList of results

Details
Type
\DOMNodeList
Propertyprotected\DOMXPath  $_xpath= ''

Xpath Object for $this->_dom

Details
Type
\DOMXPath
Propertypublicint  $firstResultPosition= ''

The offset in the total result set of this search set

Details
Type
int
Propertypublicint  $totalResultsAvailable= ''

Total number of results available

Details
Type
int
Propertypublicint  $totalResultsReturned= ''

The number of results in this result set

Details
Type
int

Methods

methodpublic__construct( \DOMDocument $dom ) : void

Parse the search response and retrieve the results for iteration

Parameters
Name Type Description
$dom \DOMDocument the REST fragment for this object
methodpubliccurrent( ) : \Zend_Service_Yahoo_Result

Implement SeekableIterator::current()

Must be implemented by child classes

Returns
Type Description
\Zend_Service_Yahoo_Result
Throws
Exception Description
\Zend_Service_Exception
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
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.