Service/Technorati/TagsResultSet.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Technorati  
Version
$Id: TagsResultSet.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Technorati_TagsResultSet

Package: Zend\Service\Technorati
Represents a Technorati TopTags or BlogPostTags queries 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.

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

>VPropertyprotectedint $_currentIndex = 0
inherited
Current Item
Inherited from: \Zend_Service_Technorati_ResultSet::$$_currentIndex
Default value0Details
Type
int
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_currentIndex  
>VPropertyprotected\DomDocument $_dom
inherited
Technorati API response document
Inherited from: \Zend_Service_Technorati_ResultSet::$$_dom
Details
Type
\DomDocument
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_dom  
>VPropertyprotected\DomNodeList $_results
inherited
A DomNodeList of results
Inherited from: \Zend_Service_Technorati_ResultSet::$$_results
Details
Type
\DomNodeList
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_results  
>VPropertyprotectedint $_totalResultsAvailable
inherited
The total number of results available
Inherited from: \Zend_Service_Technorati_ResultSet::$$_totalResultsAvailable
Details
Type
int
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_totalResultsAvailable  
>VPropertyprotectedint $_totalResultsReturned
inherited
The number of results in this result set
Inherited from: \Zend_Service_Technorati_ResultSet::$$_totalResultsReturned
Details
Type
int
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_totalResultsReturned  
>VPropertyprotectedstring $_xml
inherited
XML string representation for $this->_dom
Inherited from: \Zend_Service_Technorati_ResultSet::$$_xml
Details
Type
string
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_xml  
>VPropertyprotected\DOMXpath $_xpath
inherited
Object for $this->_dom
Inherited from: \Zend_Service_Technorati_ResultSet::$$_xpath
Details
Type
\DOMXpath
Access
protected  
Inherited_from
\Zend_Service_Technorati_ResultSet::$$_xpath  

Methods

methodpublic__construct(\DomDocument $dom,  $options = array()) : void

Constructs a new object object from DOM Document.

Parameters
NameTypeDescription
$dom\DomDocument

the ReST fragment for this object

$options
methodpublic__sleep() : void
inherited

Overwrites 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.

methodpublic__wakeup() : void
inherited

Overwrites 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.

methodprotected_init(\DomDocument $dom, array $options = array()) : void
inherited

Initializes 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.

Parameters
NameTypeDescription
$dom\DomDocument

the ReST fragment for this object

$optionsarray

query options as associative array * @return void

methodpubliccurrent() : \Zend_Service_Technorati_TagsResult

Implements Zend_Service_Technorati_ResultSet::current().

Returns
TypeDescription
\Zend_Service_Technorati_TagsResultcurrent result
methodpublicgetXml() : string
inherited

Returns the response document as XML string.

Inherited from: \Zend_Service_Technorati_ResultSet::getXml()
Returns
TypeDescription
stringthe response document converted into XML format
methodpublickey() : int
inherited

Implements SeekableIterator::key().

Inherited from: \Zend_Service_Technorati_ResultSet::key()
Returns
TypeDescription
int
methodpublicnext() : void
inherited

Implements SeekableIterator::next().

Inherited from: \Zend_Service_Technorati_ResultSet::next()
methodpublicrewind() : bool
inherited

Implements SeekableIterator::rewind().

Inherited from: \Zend_Service_Technorati_ResultSet::rewind()
Returns
TypeDescription
bool
methodpublicseek(int $index) : void
inherited

Implement SeekableIterator::seek().

Inherited from: \Zend_Service_Technorati_ResultSet::seek()
Parameters
NameTypeDescription
$indexint
Throws
ExceptionDescription
\OutOfBoundsException
methodpublictotalResults() : int
inherited

Number of results returned.

Inherited from: \Zend_Service_Technorati_ResultSet::totalResults()
Returns
TypeDescription
inttotal number of results returned
methodpublictotalResultsAvailable() : int
inherited

Number of available results.

Inherited from: \Zend_Service_Technorati_ResultSet::totalResultsAvailable()
Returns
TypeDescription
inttotal number of available results
methodpublicvalid() : boolean
inherited

Implement SeekableIterator::valid().

Inherited from: \Zend_Service_Technorati_ResultSet::valid()
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.