API Documentation

Zend/Service/Yahoo/ResultSet.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Yahoo  
Version
$Id: ResultSet.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Yahoo_ResultSet

Package: Zend\Service\Yahoo

Implements
Children
\Zend_Service_Yahoo_NewsResultSet
\Zend_Service_Yahoo_ImageResultSet
\Zend_Service_Yahoo_VideoResultSet
\Zend_Service_Yahoo_PageDataResultSet
\Zend_Service_Yahoo_LocalResultSet
\Zend_Service_Yahoo_InlinkDataResultSet
\Zend_Service_Yahoo_WebResultSet
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

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.15.1.