CKTIS / PHP
IteratorAggregate::getIterator — delegovanie iterácie vo `foreach`
Implementujte `getIterator()`, aby ste určili, ktoré kľúče a hodnoty `foreach` z objektu prečíta. Metóda poskytuje objekt `Traversable`, nie pole.
Verzia: PHP 8.3
Syntax
public function getIterator(): \TraversableV PHP 8.3 je IteratorAggregate::getIterator verejná inštančná metóda bez parametrov. Keď foreach začne prechádzať objekt implementujúci IteratorAggregate, zavolá túto metódu a získava kľúče a hodnoty z vráteného objektu. Na rozdiel od triedy implementujúcej Iterator nemusí kolekcia sama sledovať aktuálnu pozíciu.
Návratový typ \Traversable tohto rozhrania je v PHP 8.3 predbežný. Implementácia môže deklarovať : \Traversable ako v príklade alebo kompatibilný užší návratový typ (kovariancia), napríklad : \Generator. Metóda môže napríklad vrátiť \ArrayIterator alebo pomocou yield poskytovať prvky prostredníctvom objektu \Generator. Pole nie je objekt Traversable, hoci ho foreach dokáže prechádzať a typ iterable ho prijíma. Vrátenie poľa pri deklarovanom type \Traversable vyvolá TypeError.
Žiadne voliteľné rozšírenie nie je potrebné: IteratorAggregate, Traversable a generátory sú súčasťou PHP a ArrayIterator patrí do povinného rozšírenia SPL.
Ak má kolekcia podporovať opakované alebo vnorené prechody, pri každom volaní vytvorte nový iterátor. Vrátenie toho istého generátora môže znemožniť ďalší prechod: po prekročení prvého yield sa generátor nedá vrátiť na začiatok.
Prí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ýsledok
Pass 1: primary = blue accent = orange Pass 2: primary = blue accent = orange
Oba prechody používajú tú istú paletu. Každý cyklus `foreach` však dostane nový generátor, preto vypíše tie isté dve dvojice kľúč–hodnota v rovnakom poradí.
Súvisiace lekcie
- PHP · Lekcia 62 · Pokročilá · Verzia: 2