Итерируемые типы в PHP

Итерируемые объекты в PHP

Итерируемый объект (iterable) в PHP — это любое значение, которое можно перебрать с помощью цикла foreach().

В PHP 7.1 был добавлен псевдотип iterable, который можно использовать для аргументов функций и возвращаемых значений.

Подходят значения двух видов: массивы и объекты, реализующие интерфейс Iterator.

PHP — использование iterable

Укажите iterable как тип параметра функции или как возвращаемый тип функции:

Пример

Функция, принимающая итерируемый параметр, вызывается один раз с массивом и один раз с объектом:

Создайте PHP-функцию printIterable, которая принимает параметр типа iterable и выводит каждый элемент. Вызовите её с массивом ["a", "b", "c"], а также с объектом ArrayIterator, содержащим ["d", "e", "f"].

> Вывод: PHP-скрипт

Prompt

Создайте PHP-функцию printIterable, которая принимает параметр типа iterable и выводит каждый элемент. Вызовите её с массивом ["a", "b", "c"], а также с объектом ArrayIterator, содержащим ["d", "e", "f"].

Вывод: PHP-скрипт

<?php
function printIterable(iterable $x) {
  foreach($x as $item) {
    echo $item;
  }
}

// Вызов с массивом:
printIterable(["a", "b", "c"]);

// Вызов с объектом:
$iterator = new ArrayIterator(["d", "e", "f"]);
printIterable($iterator);
?>

Пример

Функция, возвращаемый тип которой — iterable:

Создайте PHP-функцию getIterable с типом возвращаемого значения iterable, которая возвращает массив ["a", "b", "c"]. С помощью цикла foreach выведите каждый элемент из возвращённого iterable.

> Вывод: PHP-скрипт

Prompt

Создайте PHP-функцию getIterable с типом возвращаемого значения iterable, которая возвращает массив ["a", "b", "c"]. С помощью цикла foreach выведите каждый элемент из возвращённого iterable.

Вывод: PHP-скрипт

<?php
function getIterable():iterable {
  return ["a", "b", "c"];
}

foreach(getIterable() as $item) {
  echo $item;
}
?>

PHP — создание итерируемых объектов

Любой массив является итерируемым, поэтому его можно передать в функцию, которая ожидает итерируемое значение.

То же относится и к объектам: любой объект, реализующий Iterator, также принимается.

Итератор хранит список элементов и предоставляет методы для перемещения по ним. Он держит указатель на одном элементе списка за раз, и у каждого элемента должен быть ключ, по которому его можно найти.

Ваш итератор должен определять эти пять методов:

current() — возвращает элемент под указателем, который может быть любого типа данных
key() — возвращает ключ текущего элемента, который может быть только целым числом, числом с плавающей точкой, логическим значением или строкой
next() — перемещает указатель на один элемент вперёд
rewind() — возвращает указатель на первый элемент
valid() — возвращает true, пока внутренний указатель находится на элементе. Метод должен возвращать false, когда указатель не находится ни на каком элементе, например после вызова next() в конце списка

Пример

Здесь класс реализует Iterator, а его объект затем передаётся в функцию как итерируемое значение:

Создайте PHP-класс MyIterator, который реализует интерфейс Iterator с методами current(), key(), next(), rewind() и valid(). Затем создайте функцию printIterable(), которая проходит по iterable и выводит каждый элемент. Используйте MyIterator с элементами ["a", "b", "c"].

> Вывод: PHP-скрипт

Prompt

Создайте PHP-класс MyIterator, который реализует интерфейс Iterator с методами current(), key(), next(), rewind() и valid(). Затем создайте функцию printIterable(), которая проходит по iterable и выводит каждый элемент. Используйте MyIterator с элементами ["a", "b", "c"].

Вывод: PHP-скрипт

<?php
// Создаём итератор
class MyIterator implements Iterator {
  private $items = [];
  private $pointer = 0;

  public function __construct($items) {
    // array_values() гарантирует, что ключами будут числа
    $this->items = array_values($items);
  }

  public function current() {
    return $this->items[$this->pointer];
  }

  public function key() {
    return $this->pointer;
  }

  public function next() {
    $this->pointer++;
  }

  public function rewind() {
    $this->pointer = 0;
  }

  public function valid() {
    // count() показывает, сколько элементов в списке
    return $this->pointer < count($this->items);
  }
}

// Функция, которая работает с iterable
function printIterable(iterable $myIterable) {
  foreach($myIterable as $item) {
    echo $item;
  }
}

// Используем итератор как iterable
$iterator = new MyIterator(["a", "b", "c"]);
printIterable($iterator);
?>