CKTIS / PHP
Iterator::rewind — návrat iterátoru na začátek
Smyčka `foreach` volá `Iterator::rewind()` před první kontrolou pomocí `valid()`. Zda volání nastaví iterátor na začátek, závisí na implementaci.
Verze: PHP 8.3
Syntaxe
public function rewind(): voidIterator::rewind je veřejná instanční metoda bez parametrů s návratovým typem void. Volání $it->rewind() nastaví iterátor na první prvek, pokud existuje. Metoda tento prvek nevrací. Při ručním průchodu nejprve zkontrolujte valid() a až poté čtěte hodnotu pomocí current() nebo klíč pomocí key(). U prázdného iterátoru vrací valid() hodnotu false.
Když foreach začne procházet objekt implementující Iterator, PHP zavolá rewind() před první kontrolou pomocí valid(). Pokud průchod po provedení těla smyčky pokračuje, next() posune iterátor a valid() ověří novou pozici. Ukončení smyčky nevolá rewind(). U ArrayIterator předchozí ruční posun nemění místo, kde začne nová smyčka.
Nepředpokládejte, že každý iterátor lze projít znovu. Generator::rewind() spustí generátor až po první yield včetně. Pokud už je generátor na tomto místě, volání nic neudělá; pokud pokročil dál, vyvolá výjimku Exception. Má-li smyčka začít na aktuální pozici, zabalte iterátor do NoRewindIterator: foreach sice zavolá rewind(), ale obal volání vnitřnímu iterátoru nepředá.
Tato metoda není totéž co rewind($stream), která mění pozici v souborovém proudu, ani reset($array), která nastavuje vnitřní ukazatel pole zpět na začátek.
Příklady
<?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";
}
Výsledek
beta alpha a=alpha b=beta
`next()` nejprve posune iterátor na `beta` a výslovné volání `rewind()` jej vrátí na `alpha`. Další `next()` jej zase posune na `beta`, ale `foreach` začne výpisem `a=alpha`, protože samo volá `rewind()`.
Související lekce
- PHP · Lekce 61 · Pokročilá · Verze: 2
- PHP · Lekce 63 · Pokročilá · Verze: 2