Docs For Class Zend_Service_Yahoo_ResultSet

## Class Zend_Service_Yahoo_ResultSet

Description

Implements interfaces:

- SeekableIterator (internal interface)

- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
- todo: Discussed this with Chuck and other Zenders. Why was SeekableIterator implemented here? Does seek() gain us anything in this context? Why not use just Iterator or ArrayAccess + Iterator?

Located in /Zend/Service/Yahoo/ResultSet.php (line 34)

Direct descendents

Class | Description
--- | ---
Zend_Service_Yahoo_ImageResultSet |
Zend_Service_Yahoo_NewsResultSet |
Zend_Service_Yahoo_LocalResultSet |
Zend_Service_Yahoo_WebResultSet |

Variable Summary
mixed $firstResultPosition
int $totalResultsAvailable
mixed $totalResultsReturned
int $_currentItem
DomDocument $_dom
DomNodeList $_results
DOMXpath $_xpath
Method Summary
Zend_Service_Yahoo_ResultSet __construct ( $dom)
Zend_Service_Yahoo_Result current ()
int key ()
void next ()
boolean rewind ()
Zend_Service_Yahoo_Result seek (int $item)
int totalResults ()
boolean valid ([int $item = null])
Variables
mixed $firstResultPosition (line 68)

- access: public

int $totalResultsAvailable (line 58)

- var: the total number of results available
- access: public

mixed $totalResultsReturned (line 63)

- access: public

int $_currentItem = 0 (line 53)

- var: Current Item
- access: protected

DomDocument $_dom (line 43)

- var: Yahoo Web Service Return Document
- access: protected

DomNodeList $_results (line 38)

- var: A DomNodeList of results
- access: protected

DOMXpath $_xpath (line 48)

- var: Xpath Object for $this->_dom
- access: protected

Methods
Constructor __construct (line 76)

Parse the search response and retrieve the results for iteration

- access: public

Zend_Service_Yahoo_ResultSet __construct ( $dom)

- DomDocument $dom: the ReST fragment for this object

Redefined in descendants as:

- Zend_Service_Yahoo_LocalResultSet::__construct()

current (line 106)

Implement SeekableIterator::current

- access: public

Zend_Service_Yahoo_Result current ()

Implementation of:

SeekableIterator::current

Redefined in descendants as:

- Zend_Service_Yahoo_ImageResultSet::current()
- Zend_Service_Yahoo_NewsResultSet::current()
- Zend_Service_Yahoo_LocalResultSet::current()
- Zend_Service_Yahoo_WebResultSet::current()

key (line 118)

Implement SeekableIterator::key

- access: public

int key ()

Implementation of:

SeekableIterator::key

next (line 127)

Implement SeekableIterator::next

- access: public

void next ()

Implementation of:

SeekableIterator::next

rewind (line 138)

Implement SeekableIterator::rewind

- access: public

boolean rewind ()

Implementation of:

SeekableIterator::rewind

seek (line 152)

Implement SeekableIterator::sek

- access: public
- throws: Zend_Service_Exception

Zend_Service_Yahoo_Result seek (int $item)

- int $item

Implementation of:

SeekableIterator::seek

totalResults (line 95)

Total Number of results returned

- return: Total number of results returned
- access: public

int totalResults ()
valid (line 170)

Implement SeekableIterator::valid

- access: public

boolean valid ([int $item = null])

- int $item

Implementation of:

SeekableIterator::valid

Documentation generated on Sun, 29 Oct 2006 21:27:29 -0600 by phpDocumentor 1.3.0RC6