Docs For Class Zend_Service_Yahoo

Description

Implements interfaces:

license: Zend Framework License version 1.0
copyright: Copyright (c) 2005-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 32)

Direct descendents

Class	Description
Zend_Service_Yahoo_ImageResultSet
Zend_Service_Yahoo_LocalResultSet
Zend_Service_Yahoo_NewsResultSet
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 (DomDocument $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 66)

access: public

int $totalResultsAvailable (line 56)

var: the total number of results available
access: public

mixed $totalResultsReturned (line 61)

access: public

int $_currentItem = 0 (line 51)

var: Current Item
access: protected

DomDocument $_dom (line 41)

var: Yahoo Web Service Return Document
access: protected

DomNodeList $_results (line 36)

var: A DomNodeList of results
access: protected

DOMXpath $_xpath (line 46)

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

Methods

Constructor __construct (line 74)

Parse the search response and retrieve the results for iteration

access: public

Zend_Service_Yahoo_ResultSet __construct (DomDocument $dom)

DomDocument $dom: the ReST fragment for this object

Redefined in descendants as:

Zend_Service_Yahoo_LocalResultSet::__construct()

current (line 104)

Implement SeekableIterator::current

access: public

Zend_Service_Yahoo_Result current ()

Redefined in descendants as:

key (line 116)

Implement SeekableIterator::key

access: public

int key ()

next (line 125)

Implement SeekableIterator::next

access: public

void next ()

rewind (line 136)

Implement SeekableIterator::rewind

access: public

boolean rewind ()

seek (line 150)

Implement SeekableIterator::sek

access: public
throws: Zend_Service_Exception

Zend_Service_Yahoo_Result seek (int $item)

int $item

totalResults (line 93)

Total Number of results returned

return: Total number of results returned
access: public

int totalResults ()

valid (line 168)

Implement SeekableIterator::valid

access: public

boolean valid ([int $item = null])

int $item