Service/Technorati/TagResultSet.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Service
- Subpackage
- Technorati
- Version
- $Id: TagResultSet.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_Technorati_TagResultSet
The scope of this class is to be extended by a query-specific child result set class, and it should never be used to initialize a standalone object.
Each of the specific result sets represents a collection of query-specific Zend_Service_Technorati_Result objects.
- Parent(s)
- \Zend_Service_Technorati_ResultSet
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties

int $_currentIndex = 00Details- Type
- int
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_currentIndex

\DomDocument $_dom- Type
- \DomDocument
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_dom

\DomNodeList $_results- Type
- \DomNodeList
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_results

int $_totalResultsAvailable- Type
- int
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_totalResultsAvailable

int $_totalResultsReturned- Type
- int
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_totalResultsReturned

string $_xml- Type
- string
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_xml

\DOMXpath $_xpath- Type
- \DOMXpath
- Access
- protected
- Inherited_from
- \Zend_Service_Technorati_ResultSet::$$_xpath
Methods

__construct(\DomDocument $dom, array $options = array()) : voidParses the search response and retrieve the results for iteration.
| Name | Type | Description |
|---|---|---|
| $dom | \DomDocument | the ReST fragment for this object |
| $options | array | query options as associative array |

__sleep() : voidOverwrites standard __sleep method to make this object serializable.
Inherited from: \Zend_Service_Technorati_ResultSet::__sleep()DomDocument and DOMXpath objects cannot be serialized. This method converts them back to an XML string.

__wakeup() : voidOverwrites standard __wakeup method to make this object unserializable.
Inherited from: \Zend_Service_Technorati_ResultSet::__wakeup()Restores object status before serialization. Converts XML string into a DomDocument object and creates a valid DOMXpath instance for given DocDocument.

_init(\DomDocument $dom, array $options = array()) : voidInitializes this object from a DomDocument response.
Inherited from: \Zend_Service_Technorati_ResultSet::_init()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.
| Name | Type | Description |
|---|---|---|
| $dom | \DomDocument | the ReST fragment for this object |
| $options | array | query options as associative array * @return void |

current() : \Zend_Service_Technorati_TagResultImplements Zend_Service_Technorati_ResultSet::current().
| Type | Description |
|---|---|
| \Zend_Service_Technorati_TagResult | current result |

getXml() : stringReturns the response document as XML string.
Inherited from: \Zend_Service_Technorati_ResultSet::getXml()| Type | Description |
|---|---|
| string | the response document converted into XML format |

key() : intImplements SeekableIterator::key().
Inherited from: \Zend_Service_Technorati_ResultSet::key()| Type | Description |
|---|---|
| int |

next() : voidImplements SeekableIterator::next().
Inherited from: \Zend_Service_Technorati_ResultSet::next()
rewind() : boolImplements SeekableIterator::rewind().
Inherited from: \Zend_Service_Technorati_ResultSet::rewind()| Type | Description |
|---|---|
| bool |

seek(int $index) : voidImplement SeekableIterator::seek().
Inherited from: \Zend_Service_Technorati_ResultSet::seek()| Name | Type | Description |
|---|---|---|
| $index | int |
| Exception | Description |
|---|---|
| \OutOfBoundsException |

totalResults() : intNumber of results returned.
Inherited from: \Zend_Service_Technorati_ResultSet::totalResults()| Type | Description |
|---|---|
| int | total number of results returned |

totalResultsAvailable() : intNumber of available results.
Inherited from: \Zend_Service_Technorati_ResultSet::totalResultsAvailable()| Type | Description |
|---|---|
| int | total number of available results |

valid() : booleanImplement SeekableIterator::valid().
Inherited from: \Zend_Service_Technorati_ResultSet::valid()| Type | Description |
|---|---|
| boolean |