API Documentation

Zend/Service/Technorati/ResultSet.php

Show: inherited
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: ResultSet.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedint  $_currentIndex= '0'

Current Item

Default value0Details
Type
int
Access
protected  
Propertyprotected\DomDocument  $_dom= ''

Technorati API response document

Details
Type
\DomDocument
Access
protected  
Propertyprotected\DomNodeList  $_results= ''

A DomNodeList of results

Details
Type
\DomNodeList
Access
protected  
Propertyprotectedint  $_totalResultsAvailable= ''

The total number of results available

Details
Type
int
Access
protected  
Propertyprotectedint  $_totalResultsReturned= ''

The number of results in this result set

Details
Type
int
Access
protected  
Propertyprotectedstring  $_xml= ''

XML string representation for $this->_dom

Details
Type
string
Access
protected  
Propertyprotected\DOMXpath  $_xpath= ''

Object for $this->_dom

Details
Type
\DOMXpath
Access
protected  

Methods

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

Parses 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

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

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

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

Parameters
Name Type Description
$dom \DomDocument

the ReST fragment for this object

$options array

query options as associative array * @return void

methodpublicgetXml( ) : string

Returns the response document as XML string.

Returns
Type Description
string the response document converted into XML format
methodpublickey( ) : int

Implements SeekableIterator::key().

Returns
Type Description
int
methodpublicnext( ) : void

Implements SeekableIterator::next().

methodpublicrewind( ) : bool

Implements SeekableIterator::rewind().

Returns
Type Description
bool
methodpublicseek( int $index ) : void

Implement SeekableIterator::seek().

Parameters
Name Type Description
$index int
Throws
Exception Description
\OutOfBoundsException
methodpublictotalResults( ) : int

Number of results returned.

Returns
Type Description
int total number of results returned
methodpublictotalResultsAvailable( ) : int

Number of available results.

Returns
Type Description
int total number of available results
methodpublicvalid( ) : boolean

Implement SeekableIterator::valid().

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.