Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / PHP

Iterator::key — Branje ključa trenutnega elementa

Preberite ključ trenutnega elementa, ne da bi premaknili iterator, in poglejte, kako PHP ta ključ dodeli v zanki `foreach`.

Različica: PHP 8.3

Sintaksa

public function key(): mixed

$iterator->key();

Iterator::key je javna metoda primerka brez parametrov. Z $iterator->key() preberete ključ na trenutnem položaju, ne da bi premaknili iterator. current() prebere vrednost na istem položaju, next() premakne iterator naprej, rewind() pa ga vrne na začetek.

V zanki foreach ($iterator as $key => $value) PHP na začetku pokliče rewind() in pred vsako ponovitvijo preveri položaj z valid(). Na veljavnem položaju prebere vrednost z current() in ključ z key(). Po običajnem zaključku telesa zanke pokliče next(). Pri ročnem prehodu uporabite valid(), namesto da preverjate ključ: 0 je lahko veljaven ključ.

Povratni tip mixed ključev ne omejuje na int in string: metoda MultipleIterator::key() na primer vrne polje. ArrayIterator::key() ima ožji podpis: string|int|null. Priročnik za vmesnik ob neuspehu navaja null in E_NOTICE, vendar ne predpostavljajte, da se vsaka implementacija tako odzove na neveljaven položaj. V PHP 8.3 v svoji implementaciji deklarirajte public function key(): mixed ali združljiv ožji povratni tip, da se izognete obvestilu o zastarelem podpisu.

Metode ne zamenjajte z globalno funkcijo \key($array), ki odčita ključ glede na notranji kazalec polja. Podajanje objekta tej funkciji je od PHP 8.1 označeno kot zastarelo.

Primeri

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

Rezultat

0, 0
tree
0 => oak
tree => pine

Primer uporablja `\ArrayIterator` iz knjižnice SPL. Obe branji vrneta `0`; šele `next()` premakne iterator na `tree`. Zanka `foreach` začne od začetka in izpiše oba para.

Povezane lekcije

  • PHP · Lekcija 61 · Napredna · Različica: 2
  • PHP · Lekcija 63 · Napredna · Različica: 2

Viri