Generator::key

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

Generator::key — Obtém o chave gerada

Descrição

public Generator::key(): mixed

Obtém a chave do valor gerado.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Retorna a chave gerada.

Exemplos

Example #1 Exemplo do método Generator::key()

<?php

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

$gen = Gen();

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

O exemplo acima produzirá:

key => value