CKTIS / PHP
IteratorAggregate::getIterator — delegare l’iterazione con `foreach`
Implementa `getIterator()` per stabilire quali chiavi e valori `foreach` legge da un oggetto. Il metodo fornisce un oggetto `Traversable`, non un array.
Versione: PHP 8.3
Sintassi
public function getIterator(): \TraversableIn PHP 8.3, IteratorAggregate::getIterator è un metodo pubblico di istanza senza parametri. Quando foreach inizia a scorrere un oggetto che implementa IteratorAggregate, chiama questo metodo e legge le chiavi e i valori dall’oggetto restituito. A differenza di una classe che implementa Iterator, la collezione non deve gestire direttamente la posizione corrente.
In PHP 8.3 il tipo di ritorno \Traversable dell’interfaccia è provvisorio. Un’implementazione può dichiarare : \Traversable come nell’esempio oppure un tipo di ritorno compatibile più specifico (covarianza), come : \Generator. Il metodo può restituire, ad esempio, un \ArrayIterator oppure usare yield per fornire gli elementi tramite un \Generator. Un array non è un oggetto Traversable, anche se foreach può scorrere gli array e il tipo iterable li accetta. Restituire un array con il tipo dichiarato \Traversable causa un TypeError.
Non serve alcuna estensione facoltativa: IteratorAggregate, Traversable e i generatori sono integrati in PHP, mentre ArrayIterator fa parte dell’estensione obbligatoria SPL.
Se la collezione deve supportare iterazioni ripetute o annidate, crea un nuovo iteratore a ogni chiamata. Restituire lo stesso generatore può impedire un passaggio successivo: un generatore non può tornare all’inizio dopo aver superato il primo yield.
Esempi
<?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";
}
}
Risultato
Pass 1: primary = blue accent = orange Pass 2: primary = blue accent = orange
Entrambi i passaggi usano la stessa palette. Ogni `foreach` riceve però un nuovo generatore e quindi stampa le stesse due coppie chiave-valore nello stesso ordine.
Lezioni correlate
- PHP · Lezione 62 · Avanzato · Versione: 2