International PHP Conference Berlin 2021

Iterator::key

(PHP 5, PHP 7, PHP 8)

Iterator::keyВозврат ключа текущего элемента

Описание

abstract public Iterator::key ( ) : scalar

Возвращает ключ текущего элемента.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

При успехе возвращает scalar, или же null при неудаче.

Ошибки

Создаёт E_NOTICE при неудачном выполнении.

add a note add a note

User Contributed Notes 3 notes

up
7
michaelgranados at gmail dot com
7 years ago
Since PHP 5.5.X foreach can accept non scalar items. So the return can be anything ;)
up
-1
sofe2038 at gmail dot com
6 months ago
This function may return any type, not just scalar, for some Iterator types. In particular, it is very trivial to write a generator function that yields arbitrary keys:

<?php
function foo() {
  yield
null => 1;
  yield new
stdclass => 2;
}
?>
up
-1
Lszl Lajos Jnszky
8 years ago
And converts everything to integer except string, so in php the post process could be:

    public function key() {
        $yourKey = $this->createYourKey();
        if (is_object($yourKey) || is_array($yourKey))
            throw new Exception('Array and Object not allowed.');
        elseif (is_string($yourKey))
            return $yourKey;
        else
            return (int) $yourKey;
    }
To Top