CKTIS / PHP
Iterator::rewind — ramener un itérateur au début
Une boucle `foreach` appelle `Iterator::rewind()` avant le premier appel à `valid()`. Selon l’implémentation, cet appel peut ou non ramener l’itérateur au début.
Version : PHP 8.3
Syntaxe
public function rewind(): voidIterator::rewind est une méthode d’instance publique, sans paramètre et de type de retour void. L’appel $it->rewind() place l’itérateur sur son premier élément, s’il existe. La méthode ne renvoie pas cet élément. Lors d’un parcours manuel, vérifiez valid() avant de lire la valeur avec current() ou la clé avec key(). Si l’itérateur est vide, valid() renvoie false.
Quand foreach commence à parcourir un objet qui implémente Iterator, PHP appelle rewind() avant le premier appel à valid(). Après le corps de la boucle, si le parcours continue, next() fait avancer l’itérateur et valid() vérifie la nouvelle position. La fin de la boucle ne déclenche pas d’appel à rewind(). Avec ArrayIterator, avancer manuellement au préalable ne change pas le point de départ d’une nouvelle boucle.
Ne supposez pas que tout itérateur peut être parcouru à nouveau. Generator::rewind() exécute le générateur jusqu’au premier yield inclus. Si le générateur s’y trouve déjà, l’appel ne fait rien ; s’il l’a dépassé, il lance une Exception. Pour démarrer une boucle à la position courante, enveloppez l’itérateur dans NoRewindIterator : foreach appelle toujours rewind(), mais l’enveloppe ne transmet pas l’appel à l’itérateur interne.
Cette méthode est distincte de rewind($stream), qui repositionne un flux de fichier, et de reset($array), qui réinitialise le pointeur interne d’un tableau.
Exemples
<?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";
}
Résultat
beta alpha a=alpha b=beta
`next()` avance d’abord jusqu’à `beta`, puis l’appel explicite à `rewind()` ramène l’itérateur sur `alpha`. Un autre `next()` revient à `beta`, mais `foreach` commence par `a=alpha` parce qu’il appelle lui-même `rewind()`.
Leçons associées
- PHP · Leçon 61 · Avancé · Version : 2
- PHP · Leçon 63 · Avancé · Version : 2