Service/Technorati/ResultSet.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: ResultSet.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_Technorati_ResultSet
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.
- Implements
- Children
- \Zend_Service_Technorati_TagsResultSet
- \Zend_Service_Technorati_SearchResultSet
- \Zend_Service_Technorati_CosmosResultSet
- \Zend_Service_Technorati_DailyCountsResultSet
- \Zend_Service_Technorati_TagResultSet
- Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods


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


__sleep() : void
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.


__wakeup() : void
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.


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


getXml() : string
Returns the response document as XML string.
Type | Description |
---|---|
string | the response document converted into XML format |


seek(int $index) : void
Implement SeekableIterator::seek().
Name | Type | Description |
---|---|---|
$index | int |
Exception | Description |
---|---|
\OutOfBoundsException |


totalResults() : int
Number of results returned.
Type | Description |
---|---|
int | total number of results returned |


totalResultsAvailable() : int
Number of available results.
Type | Description |
---|---|
int | total number of available results |