Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / PHP

IteratorAggregate::getIterator — delegowanie iteracji w `foreach`

Zaimplementuj metodę `getIterator()`, aby określić, jakie klucze i wartości `foreach` odczyta z obiektu. Metoda zwraca obiekt `Traversable`, a nie tablicę.

Wersja: PHP 8.3

Składnia

public function getIterator(): \Traversable

W PHP 8.3 IteratorAggregate::getIterator to publiczna metoda instancji bez parametrów. Gdy foreach rozpoczyna iterację po obiekcie implementującym IteratorAggregate, wywołuje tę metodę i pobiera klucze oraz wartości ze zwróconego obiektu. W odróżnieniu od klasy implementującej Iterator kolekcja nie musi sama przechowywać bieżącej pozycji.

W PHP 8.3 typ zwracany \Traversable w interfejsie jest jeszcze tymczasowy. Implementacja może zadeklarować : \Traversable jak w przykładzie albo zgodny, węższy typ zwracany (kowariancja), np. : \Generator. Metoda może zwrócić na przykład \ArrayIterator albo, jeśli używa yield, udostępnić elementy jako \Generator. Tablica nie jest obiektem Traversable, choć foreach obsługuje tablice, a typ iterable je dopuszcza. Zwrócenie tablicy przy zadeklarowanym typie \Traversable powoduje TypeError.

Nie potrzeba opcjonalnych rozszerzeń: IteratorAggregate, Traversable i generatory są wbudowane, a ArrayIterator należy do obowiązkowego rozszerzenia SPL.

Jeśli kolekcja ma obsługiwać wielokrotne lub zagnieżdżone przebiegi, twórz nowy iterator przy każdym wywołaniu. Zwrócenie tego samego generatora może uniemożliwić kolejny przebieg: generatora, który minął pierwsze yield, nie da się przewinąć do początku.

Przykłady

<?php

final class ColorPalette implements \IteratorAggregate
{
    public function getIterator(): \Traversable
    {
        yield 'primary' => 'blue';
        yield 'accent' => 'orange';
    }
}

$palette = new ColorPalette();

for ($pass = 1; $pass <= 2; $pass++) {
    echo "Pass {$pass}:\n";
    foreach ($palette as $role => $color) {
        echo "{$role} = {$color}\n";
    }
}

Wynik

Pass 1:
primary = blue
accent = orange
Pass 2:
primary = blue
accent = orange

Oba przebiegi używają tej samej palety. Każda pętla `foreach` otrzymuje jednak nowy generator, dzięki czemu wypisuje te same dwie pary klucz–wartość w tej samej kolejności.

Powiązane lekcje

  • PHP · Lekcja 62 · Zaawansowany · Wersja: 2

Źródła