Generator::key

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

Generator::keyyield したキーを取得する

説明

public Generator::key(): mixed

yield した値のキーを取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

yield したキーを返します。

例1 Generator::key() の例

<?php

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

$gen Gen();

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

上の例の出力は以下となります。

key => value

関連キーワード:  yield, キー, 取得, Generator, key, パラメータ, getReturn, next, public, した値