-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
BufferedIterator.php
217 lines (189 loc) · 4.82 KB
/
BufferedIterator.php
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Collection\Iterator;
use Cake\Collection\Collection;
use Countable;
use Serializable;
use SplDoublyLinkedList;
/**
* Creates an iterator from another iterator that will keep the results of the inner
* iterator in memory, so that results don't have to be re-calculated.
*/
class BufferedIterator extends Collection implements Countable, Serializable
{
/**
* The in-memory cache containing results from previous iterators
*
* @var \SplDoublyLinkedList
*/
protected $_buffer;
/**
* Points to the next record number that should be fetched
*
* @var int
*/
protected $_index = 0;
/**
* Last record fetched from the inner iterator
*
* @var mixed
*/
protected $_current;
/**
* Last key obtained from the inner iterator
*
* @var mixed
*/
protected $_key;
/**
* Whether or not the internal iterator's rewind method was already
* called
*
* @var bool
*/
protected $_started = false;
/**
* Whether or not the internal iterator has reached its end.
*
* @var bool
*/
protected $_finished = false;
/**
* Maintains an in-memory cache of the results yielded by the internal
* iterator.
*
* @param iterable $items The items to be filtered.
*/
public function __construct(iterable $items)
{
$this->_buffer = new SplDoublyLinkedList();
parent::__construct($items);
}
/**
* Returns the current key in the iterator
*
* @return mixed
*/
public function key()
{
return $this->_key;
}
/**
* Returns the current record in the iterator
*
* @return mixed
*/
public function current()
{
return $this->_current;
}
/**
* Rewinds the collection
*
* @return void
*/
public function rewind(): void
{
if ($this->_index === 0 && !$this->_started) {
$this->_started = true;
parent::rewind();
return;
}
$this->_index = 0;
}
/**
* Returns whether or not the iterator has more elements
*
* @return bool
*/
public function valid(): bool
{
if ($this->_buffer->offsetExists($this->_index)) {
$current = $this->_buffer->offsetGet($this->_index);
$this->_current = $current['value'];
$this->_key = $current['key'];
return true;
}
$valid = parent::valid();
if ($valid) {
$this->_current = parent::current();
$this->_key = parent::key();
$this->_buffer->push([
'key' => $this->_key,
'value' => $this->_current,
]);
}
$this->_finished = !$valid;
return $valid;
}
/**
* Advances the iterator pointer to the next element
*
* @return void
*/
public function next(): void
{
$this->_index++;
// Don't move inner iterator if we have more buffer
if ($this->_buffer->offsetExists($this->_index)) {
return;
}
if (!$this->_finished) {
parent::next();
}
}
/**
* Returns the number or items in this collection
*
* @return int
*/
public function count(): int
{
if (!$this->_started) {
$this->rewind();
}
while ($this->valid()) {
$this->next();
}
return $this->_buffer->count();
}
/**
* Returns a string representation of this object that can be used
* to reconstruct it
*
* @return string
*/
public function serialize(): string
{
if (!$this->_finished) {
$this->count();
}
return serialize($this->_buffer);
}
/**
* Unserializes the passed string and rebuilds the BufferedIterator instance
*
* @param string $collection The serialized buffer iterator
* @return void
*/
public function unserialize($collection): void
{
$this->__construct([]);
$this->_buffer = unserialize($collection);
$this->_started = true;
$this->_finished = true;
}
}