API Documentation

Service/Technorati/ResultSet.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Technorati
version
$Id: ResultSet.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_Technorati_ResultSet

Description

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.

Zend_Service_Technorati_ResultSet
jump to top

Implements
abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Technorati
Properties
$_totalResultsAvailable
$_totalResultsReturned
$_results
$_dom
$_xpath
$_xml
$_currentIndex
Methods
__construct
_init
totalResults
totalResultsAvailable
key
next
rewind
seek
valid
getXml
__sleep
__wakeup

Description

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.

Properties

$_currentIndex
jump to class

int $_currentIndex = '0'

Current Item

Details

$_currentIndex
int
visibility
protected
default
0
final
false
static
false
access
protected

$_dom
jump to class

DomDocument $_dom = ''

Technorati API response document

Details

$_dom
DomDocument
visibility
protected
default
final
false
static
false
access
protected

$_results
jump to class

DomNodeList $_results = ''

A DomNodeList of results

Details

$_results
DomNodeList
visibility
protected
default
final
false
static
false
access
protected

$_totalResultsAvailable
jump to class

int $_totalResultsAvailable = ''

The total number of results available

Details

$_totalResultsAvailable
int
visibility
protected
default
final
false
static
false
access
protected

$_totalResultsReturned
jump to class

int $_totalResultsReturned = ''

The number of results in this result set

Details

$_totalResultsReturned
int
visibility
protected
default
final
false
static
false
access
protected

$_xml
jump to class

string $_xml = ''

XML string representation for $this->_dom

Details

$_xml
string
visibility
protected
default
final
false
static
false
access
protected

$_xpath
jump to class

DOMXpath $_xpath = ''

Object for $this->_dom

Details

$_xpath
DOMXpath
visibility
protected
default
final
false
static
false
access
protected

Methods

__construct
jump to class

__construct( DomDocument $dom, array $options = array ) :

Parses the search response and retrieves the results for iteration.

Arguments
$dom
DomDocument
the ReST fragment for this object
$options
array
query options as associative array
Details
visibility
public
final
false
static
false

__sleep
jump to class

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

Details
visibility
public
final
false
static
false

__wakeup
jump to class

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

Details
visibility
public
final
false
static
false

_init
jump to class

_init( DomDocument $dom, array $options = array ) :

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.

Arguments
$dom
DomDocument
the ReST fragment for this object
$options
array
query options as associative array * @return void
Details
visibility
protected
final
false
static
false

getXml
jump to class

getXml( ) : string

Returns the response document as XML string.

Output
string
the response document converted into XML format
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : int

Implements SeekableIterator::key().

Output
int
Details
visibility
public
final
false
static
false

next
jump to class

next( ) : void

Implements SeekableIterator::next().

Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) : bool

Implements SeekableIterator::rewind().

Output
bool
Details
visibility
public
final
false
static
false

seek
jump to class

seek( int $index ) : void

Implement SeekableIterator::seek().

Arguments
$index
int
Details
visibility
public
final
false
static
false
throws

totalResults
jump to class

totalResults( ) : int

Number of results returned.

Output
int
total number of results returned
Details
visibility
public
final
false
static
false

totalResultsAvailable
jump to class

totalResultsAvailable( ) : int

Number of available results.

Output
int
total number of available results
Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : boolean

Implement SeekableIterator::valid().

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.