Generator::key

    (PHP 5 >= 5.5.0, PHP 7, PHP 8)

    Generator::key — Получает ключ сгенерированного элемента

    Описание

    public function Generator::key(): mixed

    Метод получает ключ значения, которое отдал генератор.

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

    Сигнатура функции не содержит параметров.

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

    Метод возвращает ключ элемента, который отдал генератор.

    Примеры

    Пример #1 Пример использования метода Generator::key()

    <?php

function Gen()
{
    yield 'key' => 'value';
}

$gen = Gen();

echo "{$gen->key()} => {$gen->current()}";

?>

    Результат выполнения приведённого примера: 

    key => value

    Нашли ошибку?

    Инструкция • Исправление • Сообщение об ошибке
    ＋Добавить

    Примечания пользователей 1 note

    up
    0
    jasonrlester at yahoo dot com
    4 years ago
    This is important when considering how other Generators work such as JavaScript's an Python's. While PHP's generator has the ->valid() method they don't, or an equivalent. JS uses Iterator protocol which says next() should return an object of

{
    done: bool,
    value: mixed
}

In which case you can use keys->done to see if the generator can still be iterated.
    ＋Добавить
    To Top