Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / PHP

Iterator::rewind — powrót na początek iteratora

Pętla `foreach` wywołuje `Iterator::rewind()` przed pierwszym sprawdzeniem pozycji za pomocą `valid()`. To, czy metoda ustawi iterator na początku, zależy od implementacji.

Wersja: PHP 8.3

Składnia

public function rewind(): void

Iterator::rewind to publiczna metoda instancji bez parametrów, o typie zwracanym void. Wywołanie $it->rewind() ustawia iterator na pierwszym elemencie, jeśli taki istnieje. Metoda nie zwraca tego elementu. Przy ręcznym przechodzeniu najpierw sprawdź valid(), a dopiero potem odczytaj wartość przez current() lub klucz przez key(). Dla pustego iteratora valid() zwraca false.

Przy rozpoczęciu foreach na obiekcie implementującym Iterator PHP wywołuje rewind() przed pierwszym valid(). Po wykonaniu ciała pętli, o ile iteracja trwa dalej, next() przesuwa iterator, a valid() sprawdza nową pozycję. Zakończenie pętli nie powoduje wywołania rewind(). W przypadku ArrayIterator wcześniejsze ręczne przesunięcie nie zmienia miejsca, od którego wystartuje nowa pętla.

Nie zakładaj, że każdy iterator da się przejść ponownie. Generator::rewind() uruchamia generator do pierwszego yield włącznie; jeśli generator już jest w tym miejscu, nic nie robi, a po przejściu dalej zgłasza Exception. Jeśli chcesz rozpocząć pętlę od aktualnej pozycji iteratora, użyj osłony NoRewindIterator: foreach nadal wywołuje rewind(), ale osłona nie przekazuje wywołania do wewnętrznego iteratora.

Metoda iteratora to nie funkcja rewind($stream), która ustawia pozycję w strumieniu plikowym, ani reset($array), która przestawia wewnętrzny wskaźnik tablicy.

Przykłady

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

Wynik

beta
alpha
a=alpha
b=beta

`next()` najpierw przesuwa iterator na `beta`, a jawne `rewind()` przywraca `alpha`. Kolejne `next()` znów ustawia pozycję na `beta`, ale `foreach` zaczyna od `a=alpha`, bo samo wywołuje `rewind()`.

Powiązane lekcje

  • PHP · Lekcja 61 · Zaawansowany · Wersja: 2
  • PHP · Lekcja 63 · Zaawansowany · Wersja: 2

Źródła