База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / PHP

IteratorAggregate::getIterator — делегиране на обхождането във `foreach`

Реализирайте `getIterator()`, за да определите кои ключове и стойности `foreach` ще прочете от обекта. Методът предоставя обект `Traversable`, а не масив.

Версия: PHP 8.3

Синтаксис

public function getIterator(): \Traversable

В PHP 8.3 IteratorAggregate::getIterator е публичен метод на инстанция без параметри. Когато foreach започне да обхожда обект, който реализира IteratorAggregate, той извиква този метод и взема ключовете и стойностите от върнатия обект. За разлика от клас, който реализира Iterator, колекцията не е длъжна сама да следи текущата позиция.

В PHP 8.3 типът \Traversable на връщаната стойност в интерфейса е предварителен. Реализацията може да декларира : \Traversable, както в примера, или съвместим по-тесен тип на връщаната стойност (ковариантност), например : \Generator. Методът може например да върне \ArrayIterator или чрез yield да предоставя елементи посредством обект \Generator. Масивът не е обект Traversable, въпреки че foreach може да обхожда масиви, а типът iterable ги допуска. Връщането на масив при деклариран тип \Traversable предизвиква TypeError.

Не е необходимо незадължително разширение: IteratorAggregate, Traversable и генераторите са вградени в PHP, а ArrayIterator е част от задължителното разширение SPL.

Ако колекцията трябва да поддържа повторни или вложени обхождания, създавайте нов итератор при всяко извикване. Връщането на същия генератор може да попречи на следващо обхождане: след като премине отвъд първия си yield, генераторът не може да се върне в началото.

Примери

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

Резултат

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

И двете обхождания използват една и съща палитра. Всеки цикъл `foreach` обаче получава нов генератор и затова извежда едни и същи две двойки ключ–стойност в същия ред.

Свързани уроци

  • PHP · Урок 62 · Напреднало · Версия: 2

Източници