Zend_Service_Technorati_ResultSet Class Reference

Inheritance diagram for Zend_Service_Technorati_ResultSet:

Public Member Functions
	__construct (DomDocument $dom, $options=array())
	totalResults ()
	totalResultsAvailable ()
	key ()
	next ()
	rewind ()
	seek ($index)
	valid ()
	getXml ()
	__sleep ()
	__wakeup ()
Protected Member Functions
	_init (DomDocument $dom, $options=array())
Protected Attributes
	$_totalResultsAvailable
	$_totalResultsReturned
	$_results
	$_dom
	$_xpath
	$_xml
	$_currentIndex = 0

---

Detailed Description

Definition at line 45 of file ResultSet.php.

---

Constructor & Destructor Documentation

__construct	(	DomDocument $	dom,
		$	options = array()
	)

Parses the search response and retrieves the results for iteration.

Parameters:

DomDocument	$dom	the ReST fragment for this object
array	$options	query options as associative array

Reimplemented in Zend_Service_Technorati_CosmosResultSet, Zend_Service_Technorati_DailyCountsResultSet, Zend_Service_Technorati_TagResultSet, Zend_Service_Technorati_SearchResultSet, and Zend_Service_Technorati_TagsResultSet.

Definition at line 118 of file ResultSet.php.

Here is the call graph for this function:

---

Member Function Documentation

__sleep

(

)

Overwrites standard __sleep method to make this object serializable.

DomDocument and DOMXpath objects cannot be serialized. This method converts them back to an XML string.

Returns:

void

Definition at line 268 of file ResultSet.php.

Here is the call graph for this function:

__wakeup

(

)

Overwrites standard __wakeup method to make this object unserializable.

Restores object status before serialization. Converts XML string into a DomDocument object and creates a valid DOMXpath instance for given DocDocument.

Returns:

void

Definition at line 283 of file ResultSet.php.

Here is the call graph for this function:

_init	(	DomDocument $	dom,
		$	options = array()
	)		[protected]

Initializes this object from a DomDocument response.

Because __construct and __wakeup shares some common executions, it's useful to group them in a single initialization method. This method is called once each time a new instance is created or a serialized object is unserialized.

Parameters:

DomDocument	$dom	the ReST fragment for this object
array	$options	query options as associative array *

Returns:

void

Definition at line 154 of file ResultSet.php.

Here is the caller graph for this function:

getXml

(

)

Returns the response document as XML string.

Returns:

string the response document converted into XML format

Definition at line 255 of file ResultSet.php.

Here is the caller graph for this function:

key

(

)

Implements SeekableIterator::current().

Returns:

void

Exceptions:

Zend_Service_Exception

Implements SeekableIterator::key().

Returns:

int

Definition at line 197 of file ResultSet.php.

next

(

)

Implements SeekableIterator::next().

Returns:

void

Definition at line 207 of file ResultSet.php.

rewind

(

)

Implements SeekableIterator::rewind().

Returns:

bool

Definition at line 217 of file ResultSet.php.

seek

(

$

index

)

Implement SeekableIterator::seek().

Parameters:

int

$index

Returns:

void

Exceptions:

OutOfBoundsException

Definition at line 230 of file ResultSet.php.

totalResults

(

)

Number of results returned.

Returns:

int total number of results returned

Definition at line 167 of file ResultSet.php.

totalResultsAvailable

(

)

Number of available results.

Returns:

int total number of available results

Definition at line 178 of file ResultSet.php.

valid

(

)

Implement SeekableIterator::valid().

Returns:

boolean

Definition at line 245 of file ResultSet.php.

---

Field Documentation

$_currentIndex = 0 [protected]

Definition at line 109 of file ResultSet.php.

$_dom [protected]

Definition at line 85 of file ResultSet.php.

$_results [protected]

Definition at line 77 of file ResultSet.php.

$_totalResultsAvailable [protected]

Definition at line 53 of file ResultSet.php.

$_totalResultsReturned [protected]

Definition at line 61 of file ResultSet.php.

$_xml [protected]

Definition at line 101 of file ResultSet.php.

$_xpath [protected]

Definition at line 93 of file ResultSet.php.

---

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

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