PHP 5.6.24 is released

Generator::key

(PHP 5 >= 5.5.0, PHP 7)

Generator::keyGet the yielded key

Description

public mixed Generator::key ( void )

Gets the key of the yielded value.

Parameters

This function has no parameters.

Return Values

Returns the yielded key.

Examples

Example #1 Generator::key() example

<?php

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

$gen Gen();

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

The above example will output:

key => value

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top