Generator::key

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

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

Описание

public Generator::key(): mixed

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

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

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

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

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

Примеры

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

<?php

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

$gen = Gen();

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

?>

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

key => value