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

Copy
1<?php
2
3/**
4 * FilterIteratorを継承し、指定されたプレフィックスで始まる文字列のみを許可する
5 * カスタムフィルタクラスです。
6 */
7class StartsWithFilterIterator extends FilterIterator
8{
9    /**
10     * PHP 8.0 の「コンストラクタのプロパティ昇格」機能を使用しています。
11     * コンストラクタの引数に可視性修飾子 (private) をつけることで、
12     * プロパティの宣言とコンストラクタ内での代入 ($this->prefix = $prefix;) を
13     * 同時に行うことができます。
14     *
15     * @param Iterator $iterator フィルタリング対象のイテレータ
16     * @param string   $prefix   フィルタリング条件となるプレフィックス文字列
17     */
18    public function __construct(
19        Iterator $iterator,
20        private string $prefix
21    ) {
22        // 親クラスである FilterIterator のコンストラクタを呼び出します。
23        parent::__construct($iterator);
24    }
25
26    /**
27     * フィルタリングの条件を定義するメソッドです。
28     * 現在の要素が条件を満たす場合に true を返す必要があります。
29     *
30     * @return bool
31     */
32    public function accept(): bool
33    {
34        // 現在のイテレータの要素を取得します。
35        $currentValue = $this->current();
36
37        // PHP 8.0 の新関数 str_starts_with() を使い、
38        // 要素が指定されたプレフィックスで始まるかどうかを判定します。
39        return str_starts_with($currentValue, $this->prefix);
40    }
41}
42
43// フィルタリングの元となるデータ配列
44$data = [
45    'Apple',
46    'Banana',
47    'Avocado',
48    'Cherry',
49    'Apricot',
50];
51
52// 配列をイテレータオブジェクトに変換します。
53$iterator = new ArrayIterator($data);
54
55// カスタムフィルタのインスタンスを生成します。
56// ここでは 'A' で始まる要素のみを抽出するように設定します。
57$filter = new StartsWithFilterIterator($iterator, 'A');
58
59// フィルタリングされた結果をループ処理して出力します。
60foreach ($filter as $item) {
61    echo $item . PHP_EOL;
62}

FilterIteratorクラスのコンストラクタ__constructは、新しいフィルタ用イテレータのインスタンスを生成する際に呼び出されます。このメソッドは、フィルタリングの対象となるIteratorオブジェクトを引数$iteratorとして受け取ります。コンストラクタはオブジェクトを初期化する役割を持つため、特定の値を返す戻り値はありません。

サンプルコードでは、FilterIteratorを継承して独自のStartsWithFilterIteratorクラスを作成しています。このクラスのコンストラクタは、2つの引数を受け取ります。1つ目の$iteratorは、parent::__construct($iterator)という形で親クラスのコンストラクタに渡されます。これにより、FilterIteratorの基本機能であるイテレータの操作が可能になります。

2つ目の引数private string $prefixでは、PHP 8の新機能である「コンストラクタのプロパティ昇格」が使われています。引数にアクセス修飾子(private)を付けるだけで、プロパティの宣言とコンストラクタ内での値の代入を同時に行うことができます。これにより、クラス内にprivate string $prefix;と記述し、コンストラクタ内で$this->prefix = $prefix;と代入する手間が省け、コードが簡潔になります。このように、コンストラクタはオブジェクトが正しく動作するための初期設定を行う重要な役割を担います。

Copy
1<?php
2
3/**
4 * FilterIteratorを継承し、指定した最小値より大きい値のみを通過させるフィルタクラス
5 */
6class MinimumValueFilter extends FilterIterator
7{
8    /**
9     * コンストラクタ
10     *
11     * PHP 8.0 の「コンストラクタのプロパティ昇格」機能を利用しています。
12     * 引数に `private int $minimumValue` と記述するだけで、
13     * private な $minimumValue プロパティが宣言され、
14     * コンストラクタの引数で受け取った値が自動的に代入されます。
15     *
16     * @param Iterator $iterator フィルタリング対象のイテレータ
17     * @param int $minimumValue この値より大きい要素のみが通過します
18     */
19    public function __construct(Iterator $iterator, private int $minimumValue)
20    {
21        // 親クラスである FilterIterator のコンストラクタを呼び出します。
22        parent::__construct($iterator);
23    }
24
25    /**
26     * 現在の要素をフィルタリングに通すかどうかを決定します。
27     * このメソッドが true を返した場合、その要素は有効とみなされます。
28     *
29     * @return bool 現在の要素が $minimumValue より大きい場合に true、そうでない場合に false を返します。
30     */
31    public function accept(): bool
32    {
33        // 現在のイテレータの値を取得し、コンストラクタで設定した最小値と比較します。
34        return $this->current() > $this->minimumValue;
35    }
36}
37
38// フィルタリング対象のデータを作成します。
39// ArrayIteratorは、配列をイテレータとして扱えるようにするクラスです。
40$numbers = new ArrayIterator([10, 25, 5, 40, 15, 30]);
41
42// 20より大きい値のみをフィルタリングするイテレータのインスタンスを生成します。
43$filter = new MinimumValueFilter($numbers, 20);
44
45echo "20より大きい数値:" . PHP_EOL;
46
47// フィルタリングされた結果をループ処理で出力します。
48foreach ($filter as $value) {
49    echo $value . PHP_EOL;
50}

FilterIteratorは、既存のイテレータに独自のフィルタリング機能を追加するための抽象クラスです。そのコンストラクタである__constructは、フィルタリング対象となるIteratorオブジェクトを引数として受け取り、インスタンスを初期化するために使用されます。このメソッド自体に戻り値はありません。

サンプルコードでは、FilterIteratorを継承して、指定した最小値より大きい数値のみを抽出するMinimumValueFilterクラスを定義しています。このクラスのコンストラクタは、フィルタリング対象のイテレータ$iteratorと、閾値となる$minimumValueを受け取ります。

コンストラクタ内では、まずparent::__construct($iterator)を呼び出し、親クラスにフィルタリング対象のイテレータを渡しています。

また、引数private int $minimumValueは、PHP 8.0の新機能「コンストラクタのプロパティ昇格」を利用した記述です。これにより、privateな$minimumValueプロパティの宣言と、引数で受け取った値の代入を同時に行うことができ、コードがより簡潔になります。

このMinimumValueFilterクラスのインスタンスをforeachで処理すると、acceptメソッドの条件を満たす要素、つまりコンストラクタで指定した値より大きい要素だけが取り出されます。