PHP Manual»Встроенные интерфейсы и классы»Iterator

Интерфейс Iterator

(PHP 5, PHP 7, PHP 8)

Интерфейс для внешних итераторов или объектов, которые умеют итерироваться сами, внутренне.

interface Iterator extends Traversable {

/* Методы */

public function current(): mixed

public function key(): mixed

public function next(): void

public function rewind(): void

public function valid(): bool

}

Встроенные средства языка включают ряд итераторов для повседневных задач: итераторы SPL-библиотеки.

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

Следующий пример показывает порядок вызова методов при обходе итератора конструкцией foreach.

<?php

class myIterator implements Iterator
{
    private $position = 0;

    private $array = array(
        "firstelement",
        "secondelement",
        "lastelement",
    );

    public function __construct()
    {
        $this->position = 0;
    }

    public function rewind(): void
    {
        var_dump(__METHOD__);
        $this->position = 0;
    }

    #[\ReturnTypeWillChange]
    public function current()
    {
        var_dump(__METHOD__);
        return $this->array[$this->position];
    }

    #[\ReturnTypeWillChange]
    public function key()
    {
        var_dump(__METHOD__);
        return $this->position;
    }

    public function next(): void
    {
        var_dump(__METHOD__);
        ++$this->position;
    }

    public function valid(): bool
    {
        var_dump(__METHOD__);
        return isset($this->array[$this->position]);
    }
}

$it = new myIterator;

foreach ($it as $key => $value) {
    var_dump($key, $value);
    echo "\n";
}

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

string(18) "myIterator::rewind"
string(17) "myIterator::valid"
string(19) "myIterator::current"
string(15) "myIterator::key"
int(0)
string(12) "firstelement"

string(16) "myIterator::next"
string(17) "myIterator::valid"
string(19) "myIterator::current"
string(15) "myIterator::key"
int(1)
string(13) "secondelement"

string(16) "myIterator::next"
string(17) "myIterator::valid"
string(19) "myIterator::current"
string(15) "myIterator::key"
int(2)
string(11) "lastelement"

string(16) "myIterator::next"
string(17) "myIterator::valid"

Смотрите также раздел Итераторы объектов.

Содержание

Iterator::current — Возврат текущего элемента
Iterator::key — Возвращает ключ текущего элемента
Iterator::next — Переходит к следующему элементу
Iterator::rewind — Отматывает итератор на первый элемент
Iterator::valid — Проверяет корректность текущей позиции