WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

IteratorAggregate::getIterator — Iteration in `foreach` delegieren

Mit `getIterator()` legst du fest, welche Schlüssel und Werte `foreach` aus einem Objekt liest. Die Methode liefert ein `Traversable`-Objekt, kein Array.

Version: PHP 8.3

Syntax

public function getIterator(): \Traversable

In PHP 8.3 ist IteratorAggregate::getIterator eine öffentliche Instanzmethode ohne Parameter. Beginnt foreach mit der Iteration über ein Objekt, das IteratorAggregate implementiert, ruft es diese Methode auf und bezieht Schlüssel und Werte aus dem zurückgegebenen Objekt. Anders als bei einer Klasse, die Iterator implementiert, muss die Sammlung die aktuelle Position nicht selbst verwalten.

Der Rückgabetyp \Traversable der Schnittstelle ist in PHP 8.3 vorläufig. Eine Implementierung kann wie im Beispiel : \Traversable oder einen kompatiblen, spezifischeren Rückgabetyp (Kovarianz) wie : \Generator deklarieren. Die Methode kann etwa einen \ArrayIterator zurückgeben oder mit yield Elemente über einen \Generator liefern. Ein Array ist kein Traversable-Objekt, obwohl foreach Arrays durchlaufen kann und der Typ iterable sie akzeptiert. Ein Array als Rückgabewert führt beim deklarierten Typ \Traversable zu einem TypeError.

Es ist keine optionale Erweiterung erforderlich: IteratorAggregate, Traversable und Generatoren sind in PHP eingebaut, und ArrayIterator gehört zur obligatorischen SPL-Erweiterung.

Soll die Sammlung wiederholte oder verschachtelte Durchläufe unterstützen, erzeuge bei jedem Aufruf einen neuen Iterator. Derselbe Generator kann einen weiteren Durchlauf verhindern: Sobald er über sein erstes yield hinausgelaufen ist, lässt er sich nicht mehr zurücksetzen.

Beispiele

<?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";
    }
}

Ergebnis

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

Beide Durchläufe verwenden dieselbe Palette. Jedes `foreach` erhält jedoch einen neuen Generator und gibt daher dieselben zwei Schlüssel-Wert-Paare in derselben Reihenfolge aus.

Zugehörige Lektionen

  • PHP · Lektion 62 · Fortgeschritten · Version: 2

Quellen