ArrayIterator — что такое и зачем нужен?

Question

[Stanislav]

Начал изучать SPL, постепенно скатился к теме итераторов.

Не могу понять что делает ArrayIterator. Примеров в интернете нет, его всегда используют в IteratorAggregate. В документации написано: "Этот итератор позволяет сбрасывать и модифицировать значения и ключи в процессе итерации по массивам и объектам." - это всё очень хорошо, но каким образом он это позволяет делать?

Как вообще это использовать?

Answer 1

[Андрей]

Любой объект можно представить в виде массива, элементами в нем будут публичные свойства.
Мы можем обращаться к объекту как к массиву.

<?php
class a {
    public $a = 1;
    public $b = 2;
}
$obj = new a();
foreach ($obj as $value) {
    echo $value.'|';
}
//1|2
?>

Итераторы позволяют подсунуть вместо свойств объекта, свой массив и проводить итерации по нему. Тут уже мы итерируем приватное свойство класса, которое представляет из себя массив.

<?php
class MyIterator implements Iterator
{
    private $var = array();

    public function __construct($array)
    {
        if (is_array($array)) {
            $this->var = $array;
        }
    }

    public function rewind()
    {
        echo "перемотка в начало\n";
        reset($this->var);
    }
  
    public function current()
    {
        $var = current($this->var);
        echo "текущий: $var\n";
        return $var;
    }
  
    public function key() 
    {
        $var = key($this->var);
        echo "ключ: $var\n";
        return $var;
    }
  
    public function next() 
    {
        $var = next($this->var);
        echo "следующий: $var\n";
        return $var;
    }
  
    public function valid()
    {
        $key = key($this->var);
        $var = ($key !== NULL && $key !== FALSE);
        echo "верный: $var\n";
        return $var;
    }

}

$values = array(1,2,3);
$it = new MyIterator($values);

foreach ($it as $a => $b) {
    print "$a: $b\n";
}
?>

php.net/manual/ru/language.oop5.iterations.php

Comments

[Stanislav]

Вопрос вообще не об этом. Вопрос именно об ArrayIterator. Что такое Iterator, и как он реализовывается я понимаю.

[Андрей]

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

[Stanislav]

Андрей: ArrayIterator идентичен этому? :

class ArIterator implements Iterator
{
    protected $position = 0;
    protected $arr = [];

    public function __construct($arr)
    {
    	$this->arr = $arr;
    }

    public function rewind() {
        $this->position = 0;
    }
 
    public function current() {
        return $this->arr[$this->position];
    }
 
    public function key() {
        return $this->position;
    }
 
    public function next() {
        ++$this->position;
    }
 
    public function valid() {
        return isset($this->arr[$this->position]);
    }
}

[Андрей]

Stasgar: Нет, тут не реализуется ArrayAccess, который позволяет обратиться к объекту как к массиву, $obj['prop']; Не реализуется Countable, который позволяет посчитать кол-во элементов в вашем приватном массиве, не реализуется Serializable, для сериализации и десериализации вашего массива. Iterator это самый простой вариант, для перебора foreach'ем.

[Stanislav]

Андрей: |class ArIterator implements Iterator, Countable, ArrayAccess, Serializable | ?

[Андрей]

Stasgar: ну да, можно так, по сути реализация этих классов/интерфейсов ничего не дает, вы можете сами определить методы в своем классе:
public function count();
public function serialize();
public function unserialize($sz);
Они лишь заставляют вас это сделать.

[Stanislav]

Андрей: хорошо. Тогда зачем нужен IteratorAgregate?

class Foo implements IteratorAggregate
{
    protected $attributes;

    public function getIterator()
    {
        return new ArrayIterator($this->attributes);
    }
}

[Андрей]

Stasgar: он позволяет добавить новое свойство в ваш класс:

$obj = new Foo();
$obj->val1 = 1;
$obj->val2 = 2;
foreach($obj as $key => $value) {
    echo $key . "|" . $value . "\r\n";
}
//val1|1
//val2|2

[Stanislav]

Андрей: я не могу объяснить, что происходит в этом коде ;(

[Андрей]

Stasgar: в методе getIterator мы отдаем другой экземпляр класса итератор, вы его можете определить сами, и в конструктор передается ваш массив для итерации. И вы получается работаете уже с другим классом.

[Stanislav]

"в методе getIterator мы отдаем другой экземпляр класса итератор" - хорошо.
"вы его можете определить сами" - хорошо.
"и в конструктор передается ваш массив для итерации." - о каком конструкторе и массиве речь?
"И вы получается работаете уже с другим классом." - не понял.

[Stanislav]

Еще вопрос - тема действительно сложная, или просто я тупой?

[Андрей]

Stasgar: она не сложная, просто надо вникнуть.
Конструктор внешнего итератора, то есть вы создаете еще один класс, который и будет вашим итератором, и в методе getIterator его отдаете, прим.:

public function getIterator() {
    return new ВашКласс($this->attributes);
}

и вся дальнейшая работа итератора переходит в ВашКласс в конструкторе которого вы принимаете массив, и сохраняете там у себя в приватном свойстве и итерируете его например.

[Stanislav]

Андрей: ладно, допустим. Вот мы делаем супер мега классный собственный уникальный итератор "class MySuperIterator implements Iterator", и потом для каждого класса, который мы хотим пропустить через foreach - мы делаем "implements IterratorAggregate", в нем делаем

function getIterator() {
     return new MySuperIterator($this);
    }

И теперь все объекты при их foreach - проходят foreach(по свойствам, т.е. $this) по сценарию, прописанному в MySuperIterator?

[Андрей]

Stasgar: да, если вам надо чтобы элементами итератора были свойства вашего класса, то передавайте как в примере $this, если в классе есть уже массив, то передавайте его, $this->_dataArray, и уже по нему будет работать ваш суперитератор

[Stanislav]

Все, теперь понял. Т.е. IteratorAggregate - это такая условность для предоставления "услуг" готовых и самодельных итераторов.