Zend_Service_Yahoo_ResultSet Class Reference

Inheritance diagram for Zend_Service_Yahoo_ResultSet:

Public Member Functions
	__construct (DOMDocument $dom)
	totalResults ()
	current ()
	key ()
	next ()
	rewind ()
	seek ($index)
	valid ()
Data Fields
	$totalResultsAvailable
	$totalResultsReturned
	$firstResultPosition
Protected Attributes
	$_results
	$_dom
	$_xpath
	$_currentIndex = 0

---

Detailed Description

Definition at line 32 of file ResultSet.php.

---

Constructor & Destructor Documentation

__construct

(

DOMDocument $

dom

)

Parse the search response and retrieve the results for iteration

Parameters:

DOMDocument

$dom

the REST fragment for this object

Returns:

void

Reimplemented in Zend_Service_Yahoo_LocalResultSet.

Definition at line 90 of file ResultSet.php.

---

Member Function Documentation

current

(

)

Implement SeekableIterator::current()

Must be implemented by child classes

Exceptions:

Zend_Service_Exception

Returns:

Zend_Service_Yahoo_Result

See also:

Zend_Service_Exception

Reimplemented in Zend_Service_Yahoo_LocalResultSet, Zend_Service_Yahoo_ImageResultSet, Zend_Service_Yahoo_NewsResultSet, Zend_Service_Yahoo_VideoResultSet, Zend_Service_Yahoo_WebResultSet, Zend_Service_Yahoo_InlinkDataResultSet, and Zend_Service_Yahoo_PageDataResultSet.

Definition at line 124 of file ResultSet.php.

key

(

)

Implement SeekableIterator::key()

Returns:

int

Definition at line 140 of file ResultSet.php.

next

(

)

Implement SeekableIterator::next()

Returns:

void

Definition at line 151 of file ResultSet.php.

rewind

(

)

Implement SeekableIterator::rewind()

Returns:

void

Definition at line 162 of file ResultSet.php.

seek

(

$

index

)

Implement SeekableIterator::seek()

Parameters:

int

$index

Returns:

void

Exceptions:

OutOfBoundsException

Definition at line 175 of file ResultSet.php.

totalResults

(

)

Total Number of results returned

Returns:

int Total number of results returned

Definition at line 110 of file ResultSet.php.

valid

(

)

Implement SeekableIterator::valid()

Returns:

boolean

Definition at line 191 of file ResultSet.php.

---

Field Documentation

$_currentIndex = 0 [protected]

Definition at line 81 of file ResultSet.php.

$_dom [protected]

Definition at line 67 of file ResultSet.php.

$_results [protected]

Definition at line 60 of file ResultSet.php.

$_xpath [protected]

Definition at line 74 of file ResultSet.php.

$firstResultPosition

Definition at line 53 of file ResultSet.php.

$totalResultsAvailable

Definition at line 39 of file ResultSet.php.

$totalResultsReturned

Definition at line 46 of file ResultSet.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Service/Yahoo/ResultSet.php