API Documentation

Service/Technorati/CosmosResultSet.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Technorati  
version
$Id: CosmosResultSet.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Technorati_CosmosResultSet

Represents a Technorati Cosmos query 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.

Extends from
\Zend_Service_Technorati_ResultSet
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Technorati  

Properties

Propertyprotectedinteger  $_inboundBlogs= ''

Number of unique blogs linking this blog

Details
Type
integer
access
protected  
Propertyprotectedinteger  $_inboundLinks= ''

Number of incoming links to this blog

Details
Type
integer
access
protected  
Propertyprotected\Zend_Uri_Http  $_url= ''

Technorati weblog url, if queried URL is a valid weblog.

Details
Type
\Zend_Uri_Http
access
protected  
Propertyprotected\Zend_Service_Technorati_Weblog  $_weblog= ''

Technorati weblog, if queried URL is a valid weblog.

Details
Type
\Zend_Service_Technorati_Weblog
access
protected  

Methods

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

Parses the search response and retrieve 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.

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

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

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
Name Type Description
$dom \DomDocument the ReST fragment for this object
$options array

query options as associative array * @return void

methodpubliccurrent( ) : \Zend_Service_Technorati_CosmosResult

Implements Zend_Service_Technorati_ResultSet::current().

Returns
Type Description
\Zend_Service_Technorati_CosmosResult current result
methodpublicgetInboundBlogs( ) : integer

Returns number of unique blogs linking this blog.

Returns
Type Description
integer the number of inbound blogs
methodpublicgetInboundLinks( ) : integer

Returns number of incoming links to this blog.

Returns
Type Description
integer the number of inbound links
methodpublicgetUrl( ) : \Zend_Uri_Http

Returns the weblog URL.

Returns
Type Description
\Zend_Uri_Http
methodpublicgetWeblog( ) : \Zend_Service_Technorati_Weblog

Returns the weblog.

Returns
Type Description
\Zend_Service_Technorati_Weblog
methodpublicgetXml( ) : string

Returns the response document as XML string.

Inherited from: \Zend_Service_Technorati_ResultSet::getXml()
Returns
Type Description
string the response document converted into XML format
methodpublickey( ) : int

Implements SeekableIterator::key().

Inherited from: \Zend_Service_Technorati_ResultSet::key()
Returns
Type Description
int
methodpublicnext( ) : void

Implements SeekableIterator::next().

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

Implements SeekableIterator::rewind().

Inherited from: \Zend_Service_Technorati_ResultSet::rewind()
Returns
Type Description
bool
methodpublicseek( int $index ) : void

Implement SeekableIterator::seek().

Inherited from: \Zend_Service_Technorati_ResultSet::seek()
Parameters
Name Type Description
$index int
Throws
Exception Description
\OutOfBoundsException
methodpublictotalResults( ) : int

Number of results returned.

Inherited from: \Zend_Service_Technorati_ResultSet::totalResults()
Returns
Type Description
int total number of results returned
methodpublictotalResultsAvailable( ) : int

Number of available results.

Inherited from: \Zend_Service_Technorati_ResultSet::totalResultsAvailable()
Returns
Type Description
int total number of available results
methodpublicvalid( ) : boolean

Implement SeekableIterator::valid().

Inherited from: \Zend_Service_Technorati_ResultSet::valid()
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.