PHPのIteratorAggregateインターフェース徹底解説！外部イテレータの作成方法

はじめに

IteratorAggregateインターフェースは、抽象インターフェースであるTraversableを継承しています。このインターフェースをクラスに実装することで、そのクラスに対して外部イテレータ（External Iterator）を作成できるようになります。IteratorAggregateには、getIterator()という抽象メソッドが1つだけ定義されています。

構文

IteratorAggregate extends Traversable {
    /* メソッド */
    abstract public getIterator ( void ) : Traversable
}

メソッド

IteratorAggregateインターフェースには、以下のメソッドが定義されています。

IteratorAggregate::getIterator — 外部イテレータを取得する

このメソッドは引数を受け取らず、IteratorまたはTraversableを実装したオブジェクトのインスタンスを返します。

Iteratorインターフェースとの違い

Iteratorインターフェースを実装する場合は、クラス自身が現在位置などの反復状態を内部的に管理する必要があります。一方、IteratorAggregateでは外部イテレータを返すだけでよいため、反復処理のロジックをArrayIteratorなどの別クラスに委譲できます。その結果、コードの責務が明確に分離され、再利用性も向上します。

IteratorAggregateの使用例

次のPHPスクリプトでは、IteratorAggregateインターフェースを実装したクラスが、配列をプロパティとして持っています。getIterator()メソッドは、この配列からArrayIteratorオブジェクトを生成して返します。これにより、foreachループを使ってオブジェクト内の配列を簡単に走査できるようになります。

コード例

<?php
class myIterator implements IteratorAggregate {
    public $arr;
    public function __construct() {
        $this->arr = array(10,20,30,40);
    }
    public function getIterator() {
        return new ArrayIterator($this->arr);
    }
}
$obj = new myIterator();
foreach($obj as $key => $value) {
    echo $key ." =>" . $value . "\n";
}
?>

実行結果

配列プロパティを走査すると、以下のような結果が出力されます。

0=>10
1=>20
2=>30
3=>40