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

CKTIS / PHP

Iterator::rewind — volver al inicio de un iterador

`foreach` llama a `Iterator::rewind()` antes de la primera comprobación con `valid()`. Que la llamada sitúe el iterador al principio depende de la implementación.

Versión: PHP 8.3

Sintaxis

public function rewind(): void

Iterator::rewind es un método de instancia público sin parámetros y con tipo de retorno void. La llamada $it->rewind() coloca el iterador en su primer elemento, si existe. El método no devuelve ese elemento. En un recorrido manual, comprueba valid() antes de leer el valor con current() o la clave con key(). Si el iterador está vacío, valid() devuelve false.

Cuando foreach empieza a recorrer un objeto que implementa Iterator, PHP llama a rewind() antes de la primera comprobación con valid(). Tras ejecutar el cuerpo del bucle, si el recorrido continúa, next() avanza el iterador y valid() comprueba la nueva posición. Al terminar el bucle no se llama a rewind(). Con ArrayIterator, avanzar manualmente antes del bucle no cambia el punto de partida de un nuevo recorrido.

No des por hecho que todos los iteradores se pueden recorrer de nuevo. Generator::rewind() ejecuta el generador hasta el primer yield, incluido. Si el generador ya está ahí, no hace nada; si ha avanzado más allá, lanza una Exception. Para iniciar un bucle en la posición actual del iterador, envuélvelo en NoRewindIterator: foreach sigue llamando a rewind(), pero el envoltorio no reenvía la llamada al iterador interno.

Este método no es rewind($stream), que reposiciona un flujo de archivo, ni reset($array), que restablece el puntero interno de un array.

Ejemplos

<?php
$items = new ArrayIterator(['a' => 'alpha', 'b' => 'beta']);

$items->next();
echo $items->current(), "\n";

$items->rewind();
echo $items->current(), "\n";

$items->next();
foreach ($items as $key => $value) {
    echo $key, '=', $value, "\n";
}

Resultado

beta
alpha
a=alpha
b=beta

`next()` avanza primero a `beta`, y la llamada explícita a `rewind()` vuelve a `alpha`. Otro `next()` avanza de nuevo a `beta`, pero `foreach` empieza por `a=alpha` porque llama a `rewind()` por su cuenta.

Lecciones relacionadas

  • PHP · Lección 61 · Avanzado · Versión: 2
  • PHP · Lección 63 · Avanzado · Versión: 2

Fuentes