Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / PHP

IteratorAggregate::getIterator — delegar el recorrido con `foreach`

Implementa `getIterator()` para decidir qué claves y valores lee `foreach` de un objeto. El método proporciona un objeto `Traversable`, no un array.

Versión: PHP 8.3

Sintaxis

public function getIterator(): \Traversable

En PHP 8.3, IteratorAggregate::getIterator es un método público de instancia sin parámetros. Cuando foreach empieza a recorrer un objeto que implementa IteratorAggregate, llama a este método y obtiene las claves y los valores del objeto devuelto. A diferencia de una clase que implementa Iterator, la colección no tiene que llevar por sí misma el control de la posición actual.

En PHP 8.3, el tipo de retorno \Traversable de la interfaz es provisional. Una implementación puede declarar : \Traversable, como en el ejemplo, o un tipo de retorno compatible más específico (covarianza), como : \Generator. El método puede devolver, por ejemplo, un \ArrayIterator o usar yield para producir elementos mediante un \Generator. Un array no es un objeto Traversable, aunque foreach pueda recorrer arrays y el tipo iterable los acepte. Devolver un array con el tipo declarado \Traversable provoca un TypeError.

No se necesita ninguna extensión opcional: IteratorAggregate, Traversable y los generadores están integrados en PHP, y ArrayIterator forma parte de la extensión obligatoria SPL.

Si la colección debe admitir recorridos repetidos o anidados, crea un iterador nuevo en cada llamada. Devolver el mismo generador puede impedir un recorrido posterior: un generador no puede volver al inicio una vez que ha pasado de su primer yield.

Ejemplos

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

Resultado

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

Los dos recorridos usan la misma paleta. Sin embargo, cada `foreach` recibe un generador nuevo y, por eso, imprime los mismos dos pares clave-valor en el mismo orden.

Lecciones relacionadas

  • PHP · Lección 62 · Avanzado · Versión: 2

Fuentes