CKTIS / PHP
Iterator::rewind — een iterator terugzetten naar het begin
Een `foreach`-lus roept `Iterator::rewind()` aan vóór de eerste controle met `valid()`. Of die aanroep de iterator terugzet naar het begin, hangt af van de implementatie.
Versie: PHP 8.3
Syntax
public function rewind(): voidIterator::rewind is een publieke instantiemethode zonder parameters en met retourtype void. Met $it->rewind() zet je de iterator op het eerste element, als dat bestaat. De methode geeft dat element niet terug. Controleer bij handmatige iteratie eerst valid() voordat je de waarde leest met current() of de sleutel met key(). Bij een lege iterator geeft valid() false terug.
Als foreach begint op een object dat Iterator implementeert, roept PHP rewind() aan vóór de eerste controle met valid(). Gaat de lus na de lusbody verder, dan verplaatst next() de iterator en controleert valid() de nieuwe positie. Aan het einde van de lus wordt rewind() niet aangeroepen. Bij ArrayIterator verandert handmatig vooruitgaan vooraf niet waar een nieuwe lus begint.
Ga er niet van uit dat je elke iterator opnieuw kunt doorlopen. Generator::rewind() voert de generator uit tot en met de eerste yield. Staat de generator daar al, dan gebeurt er niets; is hij al verder, dan wordt een Exception geworpen. Wil je een lus op de huidige positie laten beginnen, verpak de iterator dan in NoRewindIterator: foreach roept nog steeds rewind() aan, maar de wrapper geeft de aanroep niet door aan de binnenste iterator.
Verwar de iteratormethode niet met rewind($stream), dat de positie in een bestandsstream wijzigt, of met reset($array), dat de interne aanwijzer van een array terugzet.
Voorbeelden
<?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";
}
Resultaat
beta alpha a=alpha b=beta
`next()` gaat eerst naar `beta`, en de expliciete aanroep van `rewind()` zet de iterator terug op `alpha`. Nog een `next()` gaat weer naar `beta`, maar `foreach` begint met `a=alpha` omdat het zelf `rewind()` aanroept.
Gerelateerde lessen
- PHP · Les 61 · Gevorderd · Versie: 2
- PHP · Les 63 · Gevorderd · Versie: 2