CKTIS / PHP
Iterator::key — Získanie kľúča aktuálneho prvku
Zistite, ako získať kľúč aktuálneho prvku bez posunu iterátora a ako PHP tento kľúč priraďuje v cykle `foreach`.
Verzia: PHP 8.3
Syntax
public function key(): mixed
$iterator->key();Iterator::key je verejná inštančná metóda bez parametrov. Volaním $iterator->key() získate kľúč na aktuálnej pozícii bez posunu iterátora. current() vráti hodnotu na rovnakej pozícii, next() posunie iterátor ďalej a rewind() ho vráti na začiatok.
V cykle foreach ($iterator as $key => $value) PHP na začiatku zavolá rewind() a pred každým priechodom skontroluje pozíciu pomocou valid(). Na platnej pozícii načíta hodnotu cez current() a kľúč cez key(). Po bežnom dokončení tela cyklu zavolá next(). Pri ručnom prechádzaní kontrolujte valid() namiesto samotného kľúča: 0 môže byť platný kľúč.
Návratový typ mixed neobmedzuje kľúče na int a string: napríklad MultipleIterator::key() vracia pole. ArrayIterator::key() má užšiu signatúru: string|int|null. Príručka rozhrania pri zlyhaní uvádza null a E_NOTICE, ale nepredpokladajte, že sa každá implementácia na neplatnej pozícii zachová rovnako. V PHP 8.3 vo vlastnej implementácii deklarujte public function key(): mixed alebo kompatibilný užší návratový typ, aby ste predišli upozorneniu na zastaranú signatúru.
Nezamieňajte túto metódu s globálnou funkciou \key($array), ktorá zisťuje kľúč podľa interného ukazovateľa poľa. Odovzdávanie objektu tejto funkcii je od PHP 8.1 označené ako zastarané.
Prí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ýsledok
0, 0 tree 0 => oak tree => pine
Príklad používa `\ArrayIterator` z knižnice SPL. Obe volania vrátia `0`; až `next()` posunie iterátor na `tree`. Cyklus `foreach` začne od začiatku a vypíše obe dvojice.
Súvisiace lekcie
- PHP · Lekcia 61 · Pokročilá · Verzia: 2
- PHP · Lekcia 63 · Pokročilá · Verzia: 2