Service/Technorati/ResultSet.php
Show:
inherited
inherited
Classes
Zend Framework
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Service
- Subpackage
- Technorati
- Version
- $Id$
\Zend_Service_Technorati_ResultSet
Package: Zend_Service\Technorati
This is the most essential result set.
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(\DomDocument $dom, array $options = array()) : voidParses the search response and retrieves the results for iteration.
Parameters
| 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.
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.
Restores object status before serialization.
Converts XML string into a DomDocument object and creates a valid
DOMXpath instance for given DocDocument.
getXml() : stringReturns the response document as XML string.
Returns
| Type | Description |
|---|---|
| string | the response document converted into XML format |
key() : intImplements SeekableIterator::key().
Returns
| Type | Description |
|---|---|
| int |
next() : voidImplements SeekableIterator::next().
rewind() : boolImplements SeekableIterator::rewind().
Returns
| Type | Description |
|---|---|
| bool |
seek(int $index) : voidImplement SeekableIterator::seek().
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $index | int |
| Exception | Description |
|---|---|
| \OutOfBoundsException |
totalResults() : intNumber of results returned.
Returns
| Type | Description |
|---|---|
| int | total number of results returned |
totalResultsAvailable() : intNumber of available results.
Returns
| Type | Description |
|---|---|
| int | total number of available results |
valid() : booleanImplement SeekableIterator::valid().
Returns
| Type | Description |
|---|---|
| boolean |