Class Zend_Service_Yahoo_ResultSet

Description

Implements interfaces:

  • SeekableIterator (internal interface)

  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 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
Variable Summary
Method Summary
 Zend_Service_Yahoo_ResultSet __construct ( $dom)
 int key ()
 void next ()
 boolean rewind ()
 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:
current (line 106)

Implement SeekableIterator::current

  • access: public

Implementation of:
SeekableIterator::current

Redefined in descendants as:
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 Thu, 18 Jan 2007 09:58:38 -0800 by phpDocumentor 1.3.1