1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?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
* @package Zend_Service
* @subpackage Yahoo
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: ResultSet.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
/**
* @category Zend
* @package Zend_Service
* @subpackage Yahoo
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Service_Yahoo_ResultSet implements SeekableIterator
{
/**
* Total number of results available
*
* @var int
*/
public $totalResultsAvailable;
/**
* The number of results in this result set
*
* @var int
*/
public $totalResultsReturned;
/**
* The offset in the total result set of this search set
*
* @var int
*/
public $firstResultPosition;
/**
* A DOMNodeList of results
*
* @var DOMNodeList
*/
protected $_results;
/**
* Yahoo Web Service Return Document
*
* @var DOMDocument
*/
protected $_dom;
/**
* Xpath Object for $this->_dom
*
* @var DOMXPath
*/
protected $_xpath;
/**
* Current Index for SeekableIterator
*
* @var int
*/
protected $_currentIndex = 0;
/**
* Parse the search response and retrieve the results for iteration
*
* @param DOMDocument $dom the REST fragment for this object
* @return void
*/
public function __construct(DOMDocument $dom)
{
$this->totalResultsAvailable = (int) $dom->documentElement->getAttribute('totalResultsAvailable');
$this->totalResultsReturned = (int) $dom->documentElement->getAttribute('totalResultsReturned');
$this->firstResultPosition = (int) $dom->documentElement->getAttribute('firstResultPosition');
$this->_dom = $dom;
$this->_xpath = new DOMXPath($dom);
$this->_xpath->registerNamespace('yh', $this->_namespace);
$this->_results = $this->_xpath->query('//yh:Result');
}
/**
* Total Number of results returned
*
* @return int Total number of results returned
*/
public function totalResults()
{
return $this->totalResultsReturned;
}
/**
* Implement SeekableIterator::current()
*
* Must be implemented by child classes
*
* @throws Zend_Service_Exception
* @return Zend_Service_Yahoo_Result
*/
public function current()
{
/**
* @see Zend_Service_Exception
*/
require_once 'Zend/Service/Exception.php';
throw new Zend_Service_Exception('Zend_Service_Yahoo_ResultSet::current() must be implemented by child '
. 'classes');
}
/**
* Implement SeekableIterator::key()
*
* @return int
*/
public function key()
{
return $this->_currentIndex;
}
/**
* Implement SeekableIterator::next()
*
* @return void
*/
public function next()
{
$this->_currentIndex += 1;
}
/**
* Implement SeekableIterator::rewind()
*
* @return void
*/
public function rewind()
{
$this->_currentIndex = 0;
}
/**
* Implement SeekableIterator::seek()
*
* @param int $index
* @return void
* @throws OutOfBoundsException
*/
public function seek($index)
{
$indexInt = (int) $index;
if ($indexInt >= 0 && $indexInt < $this->_results->length) {
$this->_currentIndex = $indexInt;
} else {
throw new OutOfBoundsException("Illegal index '$index'");
}
}
/**
* Implement SeekableIterator::valid()
*
* @return boolean
*/
public function valid()
{
return $this->_currentIndex < $this->_results->length;
}
}
|
