Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / PHP

IteratorAggregate::getIterator — delegování iterace ve `foreach`

Implementujte `getIterator()`, abyste určili, které klíče a hodnoty `foreach` z objektu přečte. Metoda poskytuje objekt `Traversable`, nikoli pole.

Verze: PHP 8.3

Syntaxe

public function getIterator(): \Traversable

V PHP 8.3 je IteratorAggregate::getIterator veřejná instanční metoda bez parametrů. Když foreach začne procházet objekt implementující IteratorAggregate, zavolá tuto metodu a získává klíče a hodnoty z vráceného objektu. Na rozdíl od třídy implementující Iterator nemusí kolekce sama sledovat aktuální pozici.

Návratový typ \Traversable tohoto rozhraní je v PHP 8.3 předběžný. Implementace může deklarovat : \Traversable jako v příkladu nebo kompatibilní užší návratový typ (kovariance), například : \Generator. Metoda může například vrátit \ArrayIterator nebo pomocí yield poskytovat prvky prostřednictvím objektu \Generator. Pole není objekt Traversable, přestože ho foreach umí procházet a typ iterable ho přijímá. Vrácení pole při deklarovaném typu \Traversable vyvolá TypeError.

Žádné volitelné rozšíření není potřeba: IteratorAggregate, Traversable a generátory jsou součástí PHP a ArrayIterator patří do povinného rozšíření SPL.

Má-li kolekce podporovat opakované nebo vnořené průchody, vytvořte při každém volání nový iterátor. Vrácení stejného generátoru může znemožnit další průchod: jakmile generátor postoupí za první yield, nelze ho vrátit na začátek.

Příklady

<?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";
    }
}

Výsledek

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

Oba průchody používají stejnou paletu. Každá smyčka `foreach` ale získá nový generátor, takže vypíše stejné dvě dvojice klíč–hodnota ve stejném pořadí.

Související lekce

  • PHP · Lekce 62 · Pokročilá · Verze: 2

Zdroje