KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / PHP

IteratorAggregate::getIterator — iteratie in `foreach` delegeren

Implementeer `getIterator()` om te bepalen welke sleutels en waarden `foreach` uit een object leest. De methode levert een `Traversable`-object, geen array.

Versie: PHP 8.3

Syntax

public function getIterator(): \Traversable

In PHP 8.3 is IteratorAggregate::getIterator een publieke instantiemethode zonder parameters. Als foreach een object begint te doorlopen dat IteratorAggregate implementeert, roept het deze methode aan en haalt het de sleutels en waarden uit het teruggegeven object. Anders dan bij een klasse die Iterator implementeert, hoeft de collectie de huidige positie niet zelf bij te houden.

Het returntype \Traversable van de interface is in PHP 8.3 voorlopig. Een implementatie kan : \Traversable declareren, zoals in het voorbeeld, of een compatibel, specifieker returntype (covariantie), zoals : \Generator. De methode kan bijvoorbeeld een \ArrayIterator teruggeven of met yield elementen leveren via een \Generator. Een array is geen Traversable-object, ook al kan foreach arrays doorlopen en accepteert het type iterable ze. Een array teruggeven met het gedeclareerde type \Traversable veroorzaakt een TypeError.

Er is geen optionele extensie nodig: IteratorAggregate, Traversable en generatoren zijn ingebouwd in PHP, en ArrayIterator maakt deel uit van de verplichte SPL-extensie.

Moet de collectie herhaalde of geneste doorlopen ondersteunen, maak dan bij elke aanroep een nieuwe iterator. Dezelfde generator teruggeven kan een volgende doorloop verhinderen: zodra een generator voorbij zijn eerste yield is, kan hij niet meer terug naar het begin.

Voorbeelden

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

Resultaat

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

Beide doorlopen gebruiken hetzelfde palet. Elke `foreach` krijgt echter een nieuwe generator en drukt daardoor dezelfde twee sleutel-waardeparen in dezelfde volgorde af.

Gerelateerde lessen

  • PHP · Les 62 · Gevorderd · Versie: 2

Bronnen