Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / PHP

Iterator::rewind — riportare un iteratore all’inizio

Un ciclo `foreach` chiama `Iterator::rewind()` prima del primo controllo con `valid()`. A seconda dell’implementazione, la chiamata può riportare o meno l’iteratore all’inizio.

Versione: PHP 8.3

Sintassi

public function rewind(): void

Iterator::rewind è un metodo di istanza pubblico senza parametri e con tipo di ritorno void. La chiamata $it->rewind() posiziona l’iteratore sul primo elemento, se presente. Il metodo non restituisce quell’elemento. Nell’iterazione manuale, controlla valid() prima di leggere il valore con current() o la chiave con key(). Se l’iteratore è vuoto, valid() restituisce false.

Quando foreach inizia a scorrere un oggetto che implementa Iterator, PHP chiama rewind() prima del primo controllo con valid(). Dopo il corpo del ciclo, se l’iterazione prosegue, next() fa avanzare l’iteratore e valid() verifica la nuova posizione. La fine del ciclo non provoca una chiamata a rewind(). Con ArrayIterator, avanzare manualmente prima del ciclo non cambia il punto di partenza di un nuovo ciclo.

Non dare per scontato che ogni iteratore possa essere percorso di nuovo. Generator::rewind() esegue il generatore fino al primo yield incluso. Se il generatore è già lì, non fa nulla; se è andato oltre, lancia un’Exception. Per iniziare un ciclo dalla posizione corrente dell’iteratore, avvolgilo in NoRewindIterator: foreach chiama comunque rewind(), ma l’involucro non inoltra la chiamata all’iteratore interno.

Questo metodo è distinto da rewind($stream), che riposiziona un flusso di file, e da reset($array), che reimposta il puntatore interno di un array.

Esempi

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

Risultato

beta
alpha
a=alpha
b=beta

`next()` avanza prima a `beta`, poi la chiamata esplicita a `rewind()` torna ad `alpha`. Un altro `next()` avanza di nuovo a `beta`, ma `foreach` inizia da `a=alpha` perché chiama `rewind()` automaticamente.

Lezioni correlate

  • PHP · Lezione 61 · Avanzato · Versione: 2
  • PHP · Lezione 63 · Avanzato · Versione: 2

Fonti