Generator::key

(PHP 5 >= 5.5.0, PHP 7)

Generator::keyRécupère la clé cédée

Description

public Generator::key ( void ) : mixed

Récupère la clé de la valeur yielded.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne la clé cédée.

Exemples

Exemple #1 Exemple avec Generator::key()

<?php

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

$gen Gen();

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

L'exemple ci-dessus va afficher :

key => value