Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / PHP

Iterator::key — Lire la clé de l’élément courant

Lisez la clé de l’élément courant sans avancer l’itérateur et voyez comment PHP affecte cette clé dans une boucle `foreach`.

Version : PHP 8.3

Syntaxe

public function key(): mixed

$iterator->key();

Iterator::key est une méthode d’instance publique sans paramètre. Appelez $iterator->key() pour lire la clé à la position courante sans déplacer l’itérateur. current() lit la valeur à cette même position, next() avance et rewind() revient au début.

Dans foreach ($iterator as $key => $value), PHP appelle rewind() au départ et vérifie valid() avant chaque tour. À une position valide, il lit la valeur avec current() et la clé avec key(). Après un tour normal du corps de la boucle, il appelle next(). Si vous parcourez l’itérateur manuellement, testez valid() plutôt que la clé : 0 peut être une clé valide.

Le type de retour mixed ne limite pas les clés à int et string : par exemple, MultipleIterator::key() renvoie un tableau. ArrayIterator::key() a une signature plus restrictive : string|int|null. Le manuel de l’interface indique null et E_NOTICE en cas d’échec, mais ne supposez pas que toutes les implémentations réagissent ainsi à une position invalide. En PHP 8.3, déclarez public function key(): mixed ou un type de retour compatible plus restrictif dans votre implémentation pour éviter un avis de dépréciation lié à la signature.

Ne confondez pas cette méthode avec la fonction globale \key($array), qui renvoie la clé de l’élément désigné par le pointeur interne du tableau. Le passage d’un objet à cette fonction est déprécié depuis PHP 8.1.

Exemples

<?php
$iterator = new \ArrayIterator([0 => 'oak', 'tree' => 'pine']);

$iterator->rewind();
if ($iterator->valid()) {
    echo $iterator->key(), ', ', $iterator->key(), "\n";
}

$iterator->next();
if ($iterator->valid()) {
    echo $iterator->key(), "\n";
}

foreach ($iterator as $key => $value) {
    echo $key, ' => ', $value, "\n";
}

Résultat

0, 0
tree
0 => oak
tree => pine

L’exemple utilise `\ArrayIterator`, fourni par SPL. Les deux lectures renvoient `0` ; `next()` fait passer l’itérateur à `tree`. La boucle `foreach` repart du début et affiche les deux paires.

Leçons associées

  • PHP · Leçon 61 · Avancé · Version : 2
  • PHP · Leçon 63 · Avancé · Version : 2

Sources