ArrayObject::getIterator

(PHP 5, PHP 7, PHP 8)

ArrayObject::getIterator — Создаёт новый итератор из экземпляра класса ArrayObject

Описание

public ArrayObject::getIterator(): Iterator

Метод создаёт новый итератор для перебора элементов массива, который объект ArrayObject хранит внутренне. Метод возвращает или итератор по умолчанию — ArrayIterator, или итератор, который определили в конструкторе класса объекта массива. Итератор, который возвращается методом, реализует интерфейс Iterator.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Метод возвращает итератор из объекта ArrayObject.

Примеры

Пример #1 Пример создания итератора методом ArrayObject::getIterator()

<?php

$array = [
    '1' => 'one',
    '2' => 'two',
    '3' => 'three',
];

$arrayobject = new ArrayObject($array);

$iterator = $arrayobject->getIterator();

while ($iterator->valid()) {
    echo $iterator->key() . ' => ' . $iterator->current() . "\n";

    $iterator->next();
}

?>

Результат выполнения приведённого примера:

1 => one
2 => two
3 => three