База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / PHP

Iterator::key — Прочитане на ключа на текущия елемент

Прочетете ключа на текущия елемент, без да местите итератора, и вижте как PHP присвоява този ключ в цикъл `foreach`.

Версия: PHP 8.3

Синтаксис

public function key(): mixed

$iterator->key();

Iterator::key е публичен метод на обект без параметри. Извикайте $iterator->key(), за да прочетете ключа на текущата позиция, без да местите итератора. current() прочита стойността на същата позиция, next() премества итератора напред, а rewind() го връща в началото.

В foreach ($iterator as $key => $value) PHP първо извиква rewind(), а преди всяка итерация проверява позицията с valid(). На валидна позиция прочита стойността с current() и ключа с key(). След нормално завършване на тялото на цикъла извиква next(). При ръчно обхождане проверявайте valid(), а не самия ключ: 0 може да е валиден ключ.

Връщаният тип mixed не ограничава ключовете до int и string: например MultipleIterator::key() връща масив. ArrayIterator::key() има по-тясна сигнатура: string|int|null. Ръководството за интерфейса посочва null и E_NOTICE при неуспех, но не приемайте, че всяка реализация се държи така на невалидна позиция. В PHP 8.3 декларирайте public function key(): mixed или съвместим по-тесен връщан тип в своята реализация, за да избегнете известие за остаряла сигнатура.

Не бъркайте този метод с глобалната функция \key($array), която прочита ключа според вътрешния указател на масива. Подаването на обект на тази функция е отбелязано като остаряло от PHP 8.1.

Примери

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

Резултат

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

Примерът използва `\ArrayIterator` от SPL. И двете прочитания връщат `0`; едва `next()` премества итератора до `tree`. Цикълът `foreach` започва отначало и извежда и двете двойки.

Свързани уроци

  • PHP · Урок 61 · Напреднало · Версия: 2
  • PHP · Урок 63 · Напреднало · Версия: 2

Източници