CKTIS / PHP
Iterator::rewind — einen Iterator an den Anfang zurücksetzen
`foreach` ruft `Iterator::rewind()` vor der ersten Prüfung mit `valid()` auf. Ob der Aufruf den Iterator an den Anfang zurücksetzt, hängt von der Implementierung ab.
Version: PHP 8.3
Syntax
public function rewind(): voidIterator::rewind ist eine öffentliche Instanzmethode ohne Parameter mit dem Rückgabetyp void. $it->rewind() setzt den Iterator auf das erste Element, sofern eines vorhanden ist. Die Methode gibt dieses Element nicht zurück. Prüfe bei manueller Iteration zuerst valid(), bevor du den Wert mit current() oder den Schlüssel mit key() liest. Bei einem leeren Iterator liefert valid() den Wert false.
Wenn foreach für ein Objekt startet, das Iterator implementiert, ruft PHP rewind() vor der ersten Prüfung mit valid() auf. Wird die Schleife nach dem Schleifenrumpf fortgesetzt, rückt next() den Iterator weiter, und valid() prüft die neue Position. Das Schleifenende löst keinen Aufruf von rewind() aus. Bei ArrayIterator ändert vorheriges manuelles Weiterrücken nicht den Startpunkt einer neuen Schleife.
Gehe nicht davon aus, dass sich jeder Iterator erneut durchlaufen lässt. Generator::rewind() führt den Generator bis einschließlich des ersten yield aus. Steht er bereits dort, passiert nichts; ist er darüber hinausgelangt, wird eine Exception ausgelöst. Soll eine Schleife an der aktuellen Position beginnen, umschließe den Iterator mit NoRewindIterator: foreach ruft weiterhin rewind() auf, doch der Aufruf wird nicht an den inneren Iterator weitergegeben.
Die Iteratormethode ist weder rewind($stream), das die Position in einem Dateistream ändert, noch reset($array), das den internen Zeiger eines Arrays zurücksetzt.
Beispiele
<?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";
}
Ergebnis
beta alpha a=alpha b=beta
`next()` rückt zunächst zu `beta` vor, und der ausdrückliche Aufruf von `rewind()` setzt die Position auf `alpha` zurück. Ein weiteres `next()` rückt wieder zu `beta` vor, doch `foreach` beginnt mit `a=alpha`, weil es selbst `rewind()` aufruft.
Zugehörige Lektionen
- PHP · Lektion 61 · Fortgeschritten · Version: 2
- PHP · Lektion 63 · Fortgeschritten · Version: 2