(PHP 5 >= 5.1.0, PHP 7)
Examples:
Basic usage

This example demonstrates creating a custom SeekableIterator, seeking to a position and handling an invalid position.

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
<?php
class MySeekableIterator implements SeekableIterator {
 
    private $position;
 
    private $array array(
        "first element",
        "second element",
        "third element",
        "fourth element"
    );
 
    /* Method required for SeekableIterator interface */
 
    public function seek($position) {
      if (!isset($this->array[$position])) {
          throw new OutOfBoundsException("invalid seek position ($position)");
      }
 
      $this->position = $position;
    }
 
    /* Methods required for Iterator interface */
     
    public function rewind() {
        $this->position = 0;
    }
 
    public function current() {
        return $this->array[$this->position];
    }
 
    public function key() {
        return $this->position;
    }
 
    public function next() {
        ++$this->position;
    }
 
    public function valid() {
        return isset($this->array[$this->position]);
    }
}
 
try {
 
    $it new MySeekableIterator;
    echo $it->current(), "\n";
     
    $it->seek(2);
    echo $it->current(), "\n";
     
    $it->seek(1);
    echo $it->current(), "\n";
     
    $it->seek(10);
     
catch (OutOfBoundsException $e) {
    echo $e->getMessage();
}
?>

The above example will output something similar to:

first element
third element
second element
invalid seek position (10)
SeekableIterator::seek
  • References/PHP/Function/SPL/SPL/Interfaces/SeekableIterator

(PHP 5 >= 5.1.0, PHP 7) Seeks to a position

2025-01-10 15:47:30