【PHP8.x】IteratorIterator::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * IteratorIteratorを継承し、コンストラクタプロモーションを利用するカスタムイテレータクラス
5 *
6 * このクラスは、ラップしたイテレータの各操作でログを出力する機能を追加します。
7 */
8class LoggableIterator extends IteratorIterator
9{
10    /**
11     * コンストラクタ
12     *
13     * PHP 8の「コンストラクタプロモーション」機能を利用しています。
14     * `private string $logPrefix` と記述するだけで、
15     * `$logPrefix` という名前のプライベートプロパティが宣言され、
16     * コンストラクタ引数から渡された値が自動的に代入されます。
17     * これにより、プロパティ宣言とコンストラクタ内での代入文を省略でき、コードが簡潔になります。
18     *
19     * @param Traversable $iterator ラップするTraversableオブジェクト（ArrayIteratorなど）
20     * @param string $logPrefix ログ出力時に使用する接頭辞
21     */
22    public function __construct(
23        Traversable $iterator,
24        private string $logPrefix
25    ) {
26        // 親クラスである IteratorIterator のコンストラクタを呼び出し、
27        // ラップ対象のイテレータを渡します。
28        parent::__construct($iterator);
29    }
30
31    /**
32     * イテレータを巻き戻す際にログを出力します。
33     */
34    public function rewind(): void
35    {
36        echo "{$this->logPrefix}: イテレーションを開始します。\n";
37        parent::rewind();
38    }
39
40    /**
41     * 現在の要素を取得する際にログを出力します。
42     */
43    public function current(): mixed
44    {
45        $value = parent::current();
46        $key = parent::key();
47        echo "{$this->logPrefix}: 要素 (キー: {$key}, 値: {$value}) を取得しました。\n";
48        return $value;
49    }
50}
51
52// ArrayIteratorはTraversableインターフェースを実装しているため、
53// LoggableIteratorのコンストラクタに渡すことができます。
54$sourceArray = new ArrayIterator(['apple', 'banana', 'cherry']);
55
56// LoggableIteratorのインスタンスを生成します。
57// 第2引数の 'FRUITS' が、コンストラクタプロモーションによって
58// privateプロパティ $logPrefix に自動的にセットされます。
59$loggableIterator = new LoggableIterator($sourceArray, 'FRUITS');
60
61// foreachでループさせると、オーバーライドされたメソッドが呼び出されます。
62foreach ($loggableIterator as $fruit) {
63    echo "  -> ループ内の処理: '{$fruit}' を受け取りました。\n\n";
64}
65

IteratorIteratorのコンストラクタ__constructは、新しいイテレータのインスタンスを生成する際に呼び出される特別なメソッドです。このクラスは、配列のように反復処理が可能な既存のオブジェクト（イテレータ）を内部に包み込み、それ自身もイテレータとして振る舞う機能を提供します。

第1引数$iteratorには、foreachなどでループ処理できるTraversable型のオブジェクトを指定します。サンプルコードではnew ArrayIterator()がこれにあたり、この引数で渡されたオブジェクトが処理の対象となります。

サンプルコードではIteratorIteratorを継承し、独自の機能を追加したLoggableIteratorクラスを作成しています。このコンストラクタでは、PHP 8の新機能「コンストラクタプロモーション」が活用されています。引数にprivate string $logPrefixと記述するだけで、クラス内に$logPrefixというプロパティが自動的に定義され、渡された値が代入されます。これにより、プロパティ宣言と代入の記述を省略でき、コードが簡潔になります。また、parent::__construct($iterator)を呼び出して親クラスのコンストラクタに処理を引き継ぎ、基本的な初期化を完了させています。

コンストラクタはインスタンスを初期化することが目的のため、特定の処理結果を返すことはなく、戻り値はありません。

Copy
1<?php
2
3/**
4 * IteratorIteratorを継承し、追加のプロパティを持つカスタムイテレータクラス。
5 *
6 * PHP 8.0で導入された「コンストラクタプロパティプロモーション」を利用して、
7 * コンストラクタの引数でプロパティの宣言と初期化を同時に行います。
8 */
9class DescribedIterator extends IteratorIterator
10{
11    /**
12     * コンストラクタ
13     *
14     * public readonly string $description の部分がプロパティプロモーションです。
15     * これにより、$description プロパティの宣言と、コンストラクタ内での
16     * $this->description = $description; という代入が不要になります。
17     *
18     * @param Traversable $iterator 親クラスに渡すイテレータ
19     * @param string $description このイテレータに関する説明（プロモーションされるプロパティ）
20     */
21    public function __construct(
22        Traversable $iterator,
23        public readonly string $description
24    ) {
25        // 必ず親クラスのコンストラクタを呼び出します。
26        parent::__construct($iterator);
27    }
28
29    /**
30     * 追加したプロパティを取得するメソッド
31     *
32     * @return string
33     */
34    public function getDescription(): string
35    {
36        return $this->description;
37    }
38}
39
40// 処理対象のデータ配列
41$colors = ['Red', 'Green', 'Blue'];
42
43// 配列をイテレータに変換します (ArrayIteratorはTraversableです)
44$arrayIterator = new ArrayIterator($colors);
45
46// コンストラクタプロパティプロモーションを使ったクラスをインスタンス化します
47$describedIterator = new DescribedIterator($arrayIterator, 'List of primary colors');
48
49// プロモーションで設定されたプロパティにアクセスします
50echo $describedIterator->getDescription() . PHP_EOL;
51echo '--------------------' . PHP_EOL;
52
53// IteratorIteratorを継承しているため、そのままforeachで反復処理できます
54foreach ($describedIterator as $key => $color) {
55    echo "{$key}: {$color}" . PHP_EOL;
56}

このサンプルコードは、IteratorIteratorクラスのコンストラクタを利用して、既存のイテレータに独自の機能を追加する方法を示しています。ここでは、PHP 8.0の新機能「コンストラクタプロパティプロモーション」を活用している点が特徴です。

DescribedIteratorクラスはIteratorIteratorを継承しています。このクラスのコンストラクタ__constructは2つの引数を取ります。第1引数の$iteratorは、foreachで反復処理が可能なTraversable型のオブジェクトです。この引数はparent::__construct()を通じて親クラスに渡され、イテレータとしての基本的な機能を提供します。

第2引数のpublic readonly string $descriptionが、コンストラクタプロパティプロモーションです。この記述だけで、descriptionという公開プロパティの宣言と、引数で受け取った値による初期化が同時に行われます。これにより、クラス定義がより簡潔になります。コンストラクタはインスタンスを初期化する役割を持つため、戻り値はありません。

実行部分では、配列からArrayIteratorを作成し、それを説明文と共にDescribedIteratorのコンストラクタに渡してインスタンスを生成しています。その結果、元の配列の値をforeachで処理できるだけでなく、プロパティプロモーションで設定された説明文も取得できています。