Generator::key()函数—用法及示例

函数名：Generator::key()

适用版本：PHP 5 >= 5.5.0, PHP 7

用法：Generator::key() 方法用于获取当前生成器的键。

语法：public mixed Generator::key ( void )

参数：无

返回值：返回当前生成器的键。如果生成器已经遍历完毕，返回 null。

示例：

function generateNumbers() {
    yield 'one' => 1;
    yield 'two' => 2;
    yield 'three' => 3;
}

$generator = generateNumbers();

echo $generator->key(); // 输出：one

$generator->next();

echo $generator->key(); // 输出：two

$generator->next();

echo $generator->key(); // 输出：three

$generator->next();

echo $generator->key(); // 输出：null

在上面的示例中，我们创建了一个生成器函数 generateNumbers()，它通过 yield 语句生成了一系列的键值对。然后，我们通过调用 Generator 对象的 key() 方法来获取当前生成器的键。在每次调用 next() 方法之后，当前键会随之改变。当生成器遍历完毕时，key() 方法会返回 null。

注意：Generator::key() 方法只能在生成器对象上调用，而不能在生成器函数内部使用。