Service/Yahoo/ResultSet.php
inherited
Classes
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 [email protected] 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: ResultSet.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_Yahoo_ResultSet
- Implements
- Children
- \Zend_Service_Yahoo_NewsResultSet
- \Zend_Service_Yahoo_ImageResultSet
- \Zend_Service_Yahoo_VideoResultSet
- \Zend_Service_Yahoo_PageDataResultSet
- \Zend_Service_Yahoo_LocalResultSet
- \Zend_Service_Yahoo_InlinkDataResultSet
- \Zend_Service_Yahoo_WebResultSet
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
int $_currentIndex = 0Current Index for SeekableIterator
0Details- Type
- int
int $firstResultPosition = The offset in the total result set of this search set
- Type
- int
int $totalResultsAvailable = Total number of results available
- Type
- int
int $totalResultsReturned = The number of results in this result set
- Type
- int
Methods
__construct(\DOMDocument $dom) : voidParse the search response and retrieve the results for iteration
| Name | Type | Description |
|---|---|---|
| $dom | \DOMDocument | the REST fragment for this object |
current() : \Zend_Service_Yahoo_ResultImplement SeekableIterator::current()
Must be implemented by child classes
| Type | Description |
|---|---|
| \Zend_Service_Yahoo_Result |
| Exception | Description |
|---|---|
| \Zend_Service_Exception |
key() : intImplement SeekableIterator::key()
| Type | Description |
|---|---|
| int |
next() : voidImplement SeekableIterator::next()
rewind() : voidImplement SeekableIterator::rewind()
seek(int $index) : voidImplement SeekableIterator::seek()
| Name | Type | Description |
|---|---|---|
| $index | int |
| Exception | Description |
|---|---|
| \OutOfBoundsException |
totalResults() : intTotal Number of results returned
| Type | Description |
|---|---|
| int | Total number of results returned |
valid() : booleanImplement SeekableIterator::valid()
| Type | Description |
|---|---|
| boolean |