Generator::key

(PHP 5 >= 5.5.0, PHP 7)

Generator::key — yield したキーを取得する

説明

public Generator::key ( void ) : mixed

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

パラメータ

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

返り値

yield したキーを返します。

例

例1 Generator::key() の例

<?php

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

$gen = Gen();

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

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

key => value