CKTIS / PHP
Iterator::key — Získání klíče aktuálního prvku
Zjistěte, jak získat klíč aktuálního prvku bez posunu iterátoru a jak PHP tento klíč přiřazuje v cyklu `foreach`.
Verze: PHP 8.3
Syntaxe
public function key(): mixed
$iterator->key();Iterator::key je veřejná instanční metoda bez parametrů. Voláním $iterator->key() získáte klíč na aktuální pozici, aniž by se iterátor posunul. current() vrací hodnotu na téže pozici, next() posune iterátor dál a rewind() ho vrátí na začátek.
V cyklu foreach ($iterator as $key => $value) PHP na začátku zavolá rewind() a před každým průchodem ověří pozici pomocí valid(). Na platné pozici získá hodnotu přes current() a klíč přes key(). Po běžném dokončení těla cyklu zavolá next(). Při ručním procházení kontrolujte valid() místo samotného klíče: 0 může být platný klíč.
Návratový typ mixed neomezuje klíče na int a string: například MultipleIterator::key() vrací pole. ArrayIterator::key() má užší signaturu: string|int|null. Příručka rozhraní uvádí při selhání null a E_NOTICE, ale nepředpokládejte, že se každá implementace na neplatné pozici zachová stejně. V PHP 8.3 ve vlastní implementaci deklarujte public function key(): mixed nebo kompatibilní užší návratový typ, abyste předešli upozornění na zastaralou signaturu.
Nezaměňujte tuto metodu s globální funkcí \key($array), která zjišťuje klíč podle interního ukazatele pole. Předávání objektu této funkci je od PHP 8.1 označeno jako zastaralé.
Příklady
<?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";
}
Výsledek
0, 0 tree 0 => oak tree => pine
Příklad používá `\ArrayIterator` z knihovny SPL. Obě volání vrátí `0`; teprve `next()` posune iterátor na `tree`. Cyklus `foreach` začne znovu od začátku a vypíše obě dvojice.
Související lekce
- PHP · Lekce 61 · Pokročilá · Verze: 2
- PHP · Lekce 63 · Pokročilá · Verze: 2