API Documentation

Service/Yahoo/ResultSet.php

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
Yahoo
version
$Id: ResultSet.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_Yahoo_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_Yahoo_ResultSet
jump to top

Implements
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
Yahoo
Properties
$totalResultsAvailable
$totalResultsReturned
$firstResultPosition
$_results
$_dom
$_xpath
$_currentIndex
Methods
__construct
totalResults
current
key
next
rewind
seek
valid

Description

Properties

$_currentIndex
jump to class

int $_currentIndex = '0'

Current Index for SeekableIterator

Details

$_currentIndex
int
visibility
protected
default
0
final
false
static
false

$_dom
jump to class

DOMDocument $_dom = ''

Yahoo Web Service Return Document

Details

$_dom
DOMDocument
visibility
protected
default
final
false
static
false

$_results
jump to class

DOMNodeList $_results = ''

A DOMNodeList of results

Details

$_results
DOMNodeList
visibility
protected
default
final
false
static
false

$_xpath
jump to class

DOMXPath $_xpath = ''

Xpath Object for $this->_dom

Details

$_xpath
DOMXPath
visibility
protected
default
final
false
static
false

$firstResultPosition
jump to class

int $firstResultPosition = ''

The offset in the total result set of this search set

Details

$firstResultPosition
int
visibility
public
default
final
false
static
false

$totalResultsAvailable
jump to class

int $totalResultsAvailable = ''

Total number of results available

Details

$totalResultsAvailable
int
visibility
public
default
final
false
static
false

$totalResultsReturned
jump to class

int $totalResultsReturned = ''

The number of results in this result set

Details

$totalResultsReturned
int
visibility
public
default
final
false
static
false

Methods

__construct
jump to class

__construct( DOMDocument $dom ) : void

Parse the search response and retrieve the results for iteration

Arguments
$dom
DOMDocument
the REST fragment for this object
Details
visibility
public
final
false
static
false

current
jump to class

current( ) : Zend_Service_Yahoo_Result

Implement SeekableIterator::current()

Must be implemented by child classes

Output
Zend_Service_Yahoo_Result
Details
visibility
public
final
false
static
false
throws

key
jump to class

key( ) : int

Implement SeekableIterator::key()

Output
int
Details
visibility
public
final
false
static
false

next
jump to class

next( ) : void

Implement SeekableIterator::next()

Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) : void

Implement SeekableIterator::rewind()

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

Total Number of results returned

Output
int
Total number of results returned
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.