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

CKTIS / PHP

IteratorAggregate::getIterator — déléguer le parcours avec `foreach`

Implémentez `getIterator()` pour définir les clés et les valeurs que `foreach` lit dans un objet. La méthode fournit un objet `Traversable`, pas un tableau.

Version : PHP 8.3

Syntaxe

public function getIterator(): \Traversable

En PHP 8.3, IteratorAggregate::getIterator est une méthode d’instance publique sans paramètre. Lorsque foreach commence à parcourir un objet qui implémente IteratorAggregate, il appelle cette méthode et lit les clés et les valeurs dans l’objet renvoyé. Contrairement à une classe qui implémente Iterator, la collection n’a pas à gérer elle-même la position courante.

En PHP 8.3, le type de retour \Traversable de l’interface est provisoire. Une implémentation peut déclarer : \Traversable comme dans l’exemple, ou un type de retour compatible plus spécifique (covariance), tel que : \Generator. La méthode peut, par exemple, renvoyer un \ArrayIterator ou utiliser yield pour fournir les éléments via un \Generator. Un tableau n’est pas un objet Traversable, même si foreach sait parcourir les tableaux et si le type iterable les accepte. Renvoyer un tableau avec le type déclaré \Traversable provoque une TypeError.

Aucune extension facultative n’est nécessaire : IteratorAggregate, Traversable et les générateurs sont intégrés à PHP, et ArrayIterator fait partie de l’extension obligatoire SPL.

Si la collection doit permettre des parcours répétés ou imbriqués, créez un nouvel itérateur à chaque appel. Renvoyer le même générateur peut empêcher un parcours ultérieur : un générateur ne peut pas revenir au début après avoir dépassé son premier yield.

Exemples

<?php

final class ColorPalette implements \IteratorAggregate
{
    public function getIterator(): \Traversable
    {
        yield 'primary' => 'blue';
        yield 'accent' => 'orange';
    }
}

$palette = new ColorPalette();

for ($pass = 1; $pass <= 2; $pass++) {
    echo "Pass {$pass}:\n";
    foreach ($palette as $role => $color) {
        echo "{$role} = {$color}\n";
    }
}

Résultat

Pass 1:
primary = blue
accent = orange
Pass 2:
primary = blue
accent = orange

Les deux parcours utilisent la même palette. Chaque `foreach` reçoit toutefois un nouveau générateur et affiche donc les deux mêmes paires clé-valeur dans le même ordre.

Leçons associées

  • PHP · Leçon 62 · Avancé · Version : 2

Sources