Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Service_Technorati_ResultSet Class Reference

Public Member Functions

 __construct (DomDocument $dom, $options=array())
 Parses the search response and retrieves the results for iteration.
 
 totalResults ()
 Number of results returned.
 
 totalResultsAvailable ()
 Number of available results.
 
 key ()
 Implements SeekableIterator::current().
 
 next ()
 Implements SeekableIterator::next().
 
 rewind ()
 Implements SeekableIterator::rewind().
 
 seek ($index)
 Implement SeekableIterator::seek().
 
 valid ()
 Implement SeekableIterator::valid().
 
 getXml ()
 Returns the response document as XML string.
 
 __sleep ()
 Overwrites standard __sleep method to make this object serializable.
 
 __wakeup ()
 Overwrites standard __wakeup method to make this object unserializable.
 

Protected Member Functions

 _init (DomDocument $dom, $options=array())
 Initializes this object from a DomDocument response.
 

Protected Attributes

 $_totalResultsAvailable
 
 $_totalResultsReturned
 
 $_results
 
 $_dom
 
 $_xpath
 
 $_xml
 
 $_currentIndex = 0
 

Constructor & Destructor Documentation

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

Parses the search response and retrieves the results for iteration.

Parameters
DomDocument$domthe ReST fragment for this object
array$optionsquery options as associative array

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
__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
_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$domthe ReST fragment for this object
array$optionsquery options as associative array *
Returns
void
getXml ( )

Returns the response document as XML string.

Returns
string the response document converted into XML format
key ( )

Implements SeekableIterator::current().

Returns
void
Exceptions
Zend_Service_ExceptionImplements SeekableIterator::key().
Returns
int
next ( )

Implements SeekableIterator::next().

Returns
void
rewind ( )

Implements SeekableIterator::rewind().

Returns
bool
seek (   $index)

Implement SeekableIterator::seek().

Parameters
int$index
Returns
void
Exceptions
OutOfBoundsException
totalResults ( )

Number of results returned.

Returns
int total number of results returned
totalResultsAvailable ( )

Number of available results.

Returns
int total number of available results
valid ( )

Implement SeekableIterator::valid().

Returns
boolean

Member Data Documentation

$_currentIndex = 0
protected
$_dom
protected
$_results
protected
$_totalResultsAvailable
protected
$_totalResultsReturned
protected
$_xml
protected
$_xpath
protected