blob: 7728636981851688a528e2ed38c1c0d0661d7c51 (
plain)
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
|
<?php
/** @file seekableiterator.inc
* @ingroup SPL
* @brief class SeekableIterator
* @author Marcus Boerger
* @date 2003 - 2009
*
* SPL - Standard PHP Library
*/
/** @brief seekable iterator
* @author Marcus Boerger
* @version 1.0
* @since PHP 5.0
*
* Turns a normal iterator ino a seekable iterator. When there is a way
* to seek on an iterator LimitIterator can use this to efficiently rewind
* to offset.
*/
interface SeekableIterator extends Iterator
{
/** Seek to an absolute position
*
* \param $index position to seek to
* \return void
*
* The method should throw an exception if it is not possible to seek to
* the given position. Typically this exception should be of type
* OutOfBoundsException.
\code
function seek($index);
$this->rewind();
$position = 0;
while($position < $index && $this->valid()) {
$this->next();
$position++;
}
if (!$this->valid()) {
throw new OutOfBoundsException('Invalid seek position');
}
}
\endcode
*/
function seek($index);
}
?>
|
