Интерфейс SeekableIterator

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Введение

Итератор Seekable.

Обзор интерфейса

interface SeekableIterator extends Iterator {
/* Методы */
public function seek(int $offset): void
/* Наследуемые методы */
public function Iterator::current(): mixed
public function Iterator::key(): mixed
public function Iterator::next(): void
public function Iterator::rewind(): void
public function Iterator::valid(): bool
}

Примеры

Пример #1 Простое использование

Этот пример показывает как создаётся пользовательский итератор SeekableIterator, который ищет и обрабатывает недопустимую позицию.

<?php

class MySeekableIterator implements SeekableIterator
{
    private $position;

    private $array = array(
        "первый элемент",
        "второй элемент",
        "третий элемент",
        "четвёртый элемент"
    );

    /* Метод, который требует интерфейс SeekableIterator */

    public function seek($position)
    {
      if (!isset($this->array[$position])) {
          throw new OutOfBoundsException("Недопустимая позиция ($position)");
      }

      $this->position = $position;
    }

    /*  Методы, которые требует интерфейс Iterator */

    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();
}

?>

Вывод приведённого примера будет похож на:

первый элемент
третий элемент
второй элемент
Недопустимая позиция (10)

Содержание

  • SeekableIterator::seek — Сдвигает указатель итератора на заданную позицию