Service/Yahoo/WebResultSet.php

Show:

inherited

Classes
- \Zend_Service_Yahoo_WebResultSet

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: Yahoo
Version: $Id: WebResultSet.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Service_Yahoo_WebResultSet
jump to top

Package: Zend\Service\Yahoo

Parent(s): \Zend_Service_Yahoo_ResultSet
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

int $_currentIndex = 0

inherited

Current Index for SeekableIterator

Inherited from: \Zend_Service_Yahoo_ResultSet::$$_currentIndex

Default value0Details

Type: int
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$_currentIndex

\DOMDocument $_dom

inherited

Yahoo Web Service Return Document

Inherited from: \Zend_Service_Yahoo_ResultSet::$$_dom

Details

Type: \DOMDocument
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$_dom

string $_namespace = 'urn:yahoo:srch'

Web result set namespace

Default value'urn:yahoo:srch'Details

Type: string

\DOMNodeList $_results

inherited

A DOMNodeList of results

Inherited from: \Zend_Service_Yahoo_ResultSet::$$_results

Details

Type: \DOMNodeList
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$_results

\DOMXPath $_xpath

inherited

Xpath Object for $this->_dom

Inherited from: \Zend_Service_Yahoo_ResultSet::$$_xpath

Details

Type: \DOMXPath
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$_xpath

int $firstResultPosition

inherited

The offset in the total result set of this search set

Inherited from: \Zend_Service_Yahoo_ResultSet::$$firstResultPosition

Details

Type: int
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$firstResultPosition

int $totalResultsAvailable

inherited

Total number of results available

Inherited from: \Zend_Service_Yahoo_ResultSet::$$totalResultsAvailable

Details

Type: int
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$totalResultsAvailable

int $totalResultsReturned

inherited

The number of results in this result set

Inherited from: \Zend_Service_Yahoo_ResultSet::$$totalResultsReturned

Details

Type: int
Inherited_from: \Zend_Service_Yahoo_ResultSet::$$totalResultsReturned

Methods

__construct(\DOMDocument $dom) : void

inherited

Parse the search response and retrieve the results for iteration

Inherited from: \Zend_Service_Yahoo_ResultSet::__construct()

Parameters

Name	Type	Description
$dom	\DOMDocument	the REST fragment for this object

current() : \Zend_Service_Yahoo_WebResult

Overrides Zend_Service_Yahoo_ResultSet::current()

Must be implemented by child classes

Returns

Type	Description
\Zend_Service_Yahoo_WebResult

Throws

Exception	Description
\Zend_Service_Exception

key() : int

inherited

Implement SeekableIterator::key()

Inherited from: \Zend_Service_Yahoo_ResultSet::key()

Returns

Type	Description
int

next() : void

inherited

Implement SeekableIterator::next()

Inherited from: \Zend_Service_Yahoo_ResultSet::next()

rewind() : void

inherited

Implement SeekableIterator::rewind()

Inherited from: \Zend_Service_Yahoo_ResultSet::rewind()

seek(int $index) : void

inherited

Implement SeekableIterator::seek()

Inherited from: \Zend_Service_Yahoo_ResultSet::seek()

Parameters

Name	Type	Description
$index	int

Throws

Exception	Description
\OutOfBoundsException

totalResults() : int

inherited

Total Number of results returned

Inherited from: \Zend_Service_Yahoo_ResultSet::totalResults()

Returns

Type	Description
int	Total number of results returned

valid() : boolean

inherited

Implement SeekableIterator::valid()

Inherited from: \Zend_Service_Yahoo_ResultSet::valid()

Returns

Type	Description
boolean