CKTIS / PHP
Iterator::key — klucz bieżącego elementu
Odczytaj klucz bieżącego elementu bez przesuwania iteratora i sprawdź, jak ten klucz trafia do zmiennej w pętli `foreach`.
Wersja: PHP 8.3
Składnia
public function key(): mixed
$iterator->key();Iterator::key to publiczna metoda instancji bez parametrów. Wywołanie $iterator->key() zwraca klucz bieżącego elementu bez zmiany pozycji iteratora. current() zwraca wartość tego elementu, next() przesuwa iterator dalej, a rewind() ustawia go z powrotem na początku.
W pętli foreach ($iterator as $key => $value) PHP najpierw wywołuje rewind(), a przed każdym obiegiem sprawdza valid(). Na prawidłowej pozycji pobiera wartość przez current() i klucz przez key(). Po zwykłym zakończeniu obiegu wywołuje next(). Przy ręcznym przechodzeniu sprawdzaj valid() zamiast testować klucz: 0 może być prawidłowym kluczem.
Typ zwracany mixed nie ogranicza kluczy do int i string: na przykład MultipleIterator::key() zwraca tablicę. Sygnatura ArrayIterator::key() jest węższa: string|int|null. Podręcznik interfejsu opisuje null i E_NOTICE w razie niepowodzenia, ale nie zakładaj, że każda implementacja tak reaguje na nieprawidłową pozycję. W PHP 8.3 we własnej implementacji zadeklaruj public function key(): mixed lub zgodny, węższy typ zwracany, aby uniknąć komunikatu o przestarzałej sygnaturze.
Nie myl metody z globalną funkcją \key($array), która zwraca klucz elementu wskazywanego przez wewnętrzny wskaźnik tablicy. Przekazywanie obiektu do tej funkcji jest przestarzałe od PHP 8.1.
Przykłady
<?php
$iterator = new \ArrayIterator([0 => 'oak', 'tree' => 'pine']);
$iterator->rewind();
if ($iterator->valid()) {
echo $iterator->key(), ', ', $iterator->key(), "\n";
}
$iterator->next();
if ($iterator->valid()) {
echo $iterator->key(), "\n";
}
foreach ($iterator as $key => $value) {
echo $key, ' => ', $value, "\n";
}
Wynik
0, 0 tree 0 => oak tree => pine
Przykład używa `\ArrayIterator` z SPL. Dwa odczyty zwracają `0`; dopiero `next()` przesuwa iterator do klucza `tree`. Pętla `foreach` zaczyna od początku i wypisuje obie pary.
Powiązane lekcje
- PHP · Lekcja 61 · Zaawansowany · Wersja: 2
- PHP · Lekcja 63 · Zaawansowany · Wersja: 2