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

Copy
1<?php
2
3/**
4 * MyCustomIterator クラスは Iterator インターフェースを実装します。
5 * これにより、このオブジェクトを foreach ループで反復可能になり、
6 * 配列のような振る舞いをオブジェクトに持たせることができます。
7 */
8class MyCustomIterator implements Iterator
9{
10    /**
11     * イテレートするアイテムを保持するプライベート配列。
12     *
13     * @var array
14     */
15    private array $items = [];
16
17    /**
18     * 現在のイテレータの位置を示すプライベート変数。
19     *
20     * @var int
21     */
22    private int $position = 0;
23
24    /**
25     * コンストラクタ
26     *
27     * @param array $items イテレートするアイテムの配列
28     */
29    public function __construct(array $items)
30    {
31        $this->items = $items;
32    }
33
34    /**
35     * イテレータを最初の要素に巻き戻します。
36     * foreach ループの開始時に一度だけ呼び出されます。
37     */
38    public function rewind(): void
39    {
40        $this->position = 0;
41    }
42
43    /**
44     * 現在のイテレータの位置にある要素を返します。
45     * foreach ループの各イテレーションで呼び出されます。
46     *
47     * @return mixed 現在の要素
48     */
49    public function current(): mixed
50    {
51        return $this->items[$this->position];
52    }
53
54    /**
55     * 現在のイテレータの位置のキーを返します。
56     * foreach ループの各イテレーションで呼び出されます。
57     *
58     * @return mixed 現在のキー
59     */
60    public function key(): mixed
61    {
62        return $this->position;
63    }
64
65    /**
66     * イテレータを次の要素に進めます。
67     * foreach ループの各イテレーションの最後に呼び出されます。
68     */
69    public function next(): void
70    {
71        $this->position++;
72    }
73
74    /**
75     * 現在のイテレータの位置が有効かどうかをチェックします。
76     *
77     * このメソッドは foreach ループの継続条件として非常に重要です。
78     * valid() が `true` を返す間、ループは続行され、`current()`, `key()`, `next()` が呼び出されます。
79     * `false` を返すと、ループは終了します。
80     * これは、イテレーションの「有効性」を確認するもので、データ自体の「検証 (validation)」とは異なります。
81     *
82     * @return bool 現在の要素がアクセス可能であれば true、そうでなければ false。
83     */
84    public function valid(): bool
85    {
86        // 現在のポジションが、アイテム配列の有効なインデックス範囲内にあるかを確認します。
87        // これにより、イテレーションを続行できるか、または終了すべきかを判断します。
88        return isset($this->items[$this->position]);
89    }
90}
91
92// --- サンプルコードの実行 ---
93
94// イテレートするためのデータ配列を準備します。
95$myShoppingList = ['Milk', 'Bread', 'Eggs', 'Butter'];
96
97// カスタムイテレータのインスタンスを作成します。
98$listIterator = new MyCustomIterator($myShoppingList);
99
100echo "--- ショッピングリストのアイテムを処理します ---\n";
101
102// foreach ループは MyCustomIterator オブジェクトを自動的に反復処理します。
103// ループの各ステップで、内部的に valid() メソッドが呼び出され、
104// イテレーションの継続を判断します。
105foreach ($listIterator as $index => $item) {
106    echo "アイテム {$index}: {$item}\n";
107}
108
109echo "--- 処理が完了しました ---\n";
110
111echo "\n--- valid() メソッドの動作確認（手動）---\n";
112
113// イテレータをリセットし、valid() の戻り値を手動で確認してみます。
114$listIterator->rewind();
115echo "リワインド後 (position 0) の valid() 呼び出し: " . ($listIterator->valid() ? "true (有効)" : "false (無効)") . "\n";
116
117// 最後の要素の次までイテレータを進めます。
118// (通常は foreach が自動的に行いますが、ここでは手動でデモンストレーション)
119for ($i = 0; $i < count($myShoppingList); $i++) {
120    $listIterator->next();
121}
122
123// 配列の範囲外に進んだ後の valid() の戻り値を確認します。
124echo "最後の要素の次に進んだ後 (position " . $listIterator->key() . ") の valid() 呼び出し: " . ($listIterator->valid() ? "true (有効)" : "false (無効)") . "\n";
125// この時点で valid() は false を返し、もし foreach ループが動作していれば終了します。

PHP 8のIteratorインターフェースに属するvalid()メソッドは、カスタムイテレータの現在の位置が有効かどうかを判断するために利用されます。このメソッドは引数を受け取らず、真偽値（bool）を戻り値として返します。

foreachループでオブジェクトを反復処理する際、PHPは内部的にこのvalid()メソッドを呼び出します。もしvalid()がtrueを返せばループは次の要素に進み、falseを返すとループはそこで終了します。

提供されたサンプルコードのMyCustomIteratorクラスでは、valid()メソッドはisset($this->items[$this->position])という形で実装されています。これは、現在のイテレータ位置に格納されているitems配列の要素が存在するかどうかを確認しています。要素があればtrueを返し、なければfalseを返すことで、イテレーションを継続するか、あるいは終了するかをPHPに伝えています。

このvalid()メソッドの役割は、イテレータの現在の状態が有効な範囲内にあるかを確認することで、データの「有効性（validity）」を判断するものです。データ自体の内容が正しいかどうかを「検証（validation）」する目的とは異なりますのでご注意ください。これにより、存在しない要素へのアクセスを防ぎ、安全にループ処理を制御することができます。

Copy
1<?php
2
3/**
4 * カスタムイテレータの例。
5 * 指定された数値の範囲をイテレートします。
6 * PHPの内部インターフェースである Iterator を実装しています。
7 */
8class RangeIterator implements Iterator
9{
10    private int $start;
11    private int $end;
12    private int $current;
13
14    /**
15     * コンストラクタ
16     * イテレーションする数値の開始と終了を設定します。
17     *
18     * @param int $start 範囲の開始値 (含む)
19     * @param int $end   範囲の終了値 (含む)
20     */
21    public function __construct(int $start, int $end)
22    {
23        $this->start = $start;
24        $this->end = $end;
25    }
26
27    /**
28     * イテレータを初期状態に戻します。
29     * 通常、イテレーションの最初の要素に内部ポインタをリセットします。
30     * foreach ループが開始する際に最初に呼び出されます。
31     */
32    public function rewind(): void
33    {
34        $this->current = $this->start;
35    }
36
37    /**
38     * 現在の要素の値を返します。
39     *
40     * @return int 現在の要素の値
41     */
42    public function current(): int
43    {
44        return $this->current;
45    }
46
47    /**
48     * 現在の要素のキーを返します。
49     * この例では、値自体をキーとして使用します。
50     *
51     * @return int 現在の要素のキー
52     */
53    public function key(): int
54    {
55        return $this->current;
56    }
57
58    /**
59     * イテレータを次の要素に進めます。
60     *
61     * @return void
62     */
63    public function next(): void
64    {
65        $this->current++;
66    }
67
68    /**
69     * 現在の位置が有効かどうかを検証 (validate) します。
70     * Iterator::valid() メソッドは、現在のイテレータの位置が有効である（つまり、まだ処理すべき要素がある）場合に
71     * true を返します。有効でない場合は false を返し、foreach ループを終了させます。
72     * この例では、現在の値が終了値以下であれば有効と判断します。
73     *
74     * @return bool 現在の要素がイテレーション範囲内にある場合は true、それ以外は false
75     */
76    public function valid(): bool
77    {
78        // 現在の値が終了値以下であれば、その位置は「有効」と判断されます。
79        // foreach ループは、このメソッドが true を返す間、イテレーションを続けます。
80        // ここが、イテレータが妥当な状態にあるかを確認する「validator」として機能する部分です。
81        return $this->current <= $this->end;
82    }
83}
84
85// RangeIterator を使用する例
86echo "--- RangeIterator の動作例 ---\n";
87$iterator = new RangeIterator(1, 5);
88
89// foreach ループは内部的に以下の流れで Iterator メソッドを呼び出します:
90// 1. $iterator->rewind() を呼び出し、イテレータを初期化。
91// 2. $iterator->valid() を呼び出し、現在の位置が有効か検証。
92// 3. valid() が true を返せば、ループ本体を実行し、$iterator->current() で値を取得。
93// 4. $iterator->next() を呼び出し、次の要素へ進める。
94// 5. 2に戻り、再度 valid() で有効性を検証。
95// valid() が false を返すまでこれを繰り返します。
96foreach ($iterator as $number) {
97    echo "現在の数値: " . $number . "\n";
98}
99
100echo "\n--- valid() メソッドの直接的なデモンストレーション ---\n";
101
102// 単一の値のみをイテレートするイテレータを作成
103$singleValueIterator = new RangeIterator(10, 10);
104$singleValueIterator->rewind(); // イテレータを初期化 (current = 10)
105
106// 初期状態での valid() の確認
107echo "初期状態: 現在の値 " . $singleValueIterator->current() . "\n";
108echo "有効性チェック (valid()): " . ($singleValueIterator->valid() ? 'true' : 'false') . " (期待: true)\n"; // 10 <= 10 なので true
109
110$singleValueIterator->next(); // 次へ進める (current = 11)
111
112// 次に進めた後の valid() の確認
113echo "next() 呼び出し後: 現在の値 " . $singleValueIterator->current() . "\n";
114echo "有効性チェック (valid()): " . ($singleValueIterator->valid() ? 'true' : 'false') . " (期待: false)\n"; // 11 <= 10 ではないので false
115
116// このコードは、Iterator::valid メソッドがイテレータの「現在の位置が有効であるか」を「検証」し、
117// イテレーションの継続を制御する基本的な仕組みを示しています。

PHPのIteratorインターフェースが提供するvalid()メソッドは、イテレータの現在の位置に、まだ処理すべき要素が存在するかどうかを「検証」するために使用されます。このメソッドは引数を取らず、現在の位置が有効な場合はtrueを、無効な場合はfalseを真偽値として返します。

foreachループがカスタムイテレータを使う際には、内部的にまずrewind()メソッドでイテレータを初期化し、その後valid()メソッドを呼び出してイテレーションの開始や継続を判断します。valid()がtrueを返す間は、current()メソッドで要素を取得し、next()メソッドで次の要素に進み、再びvalid()で有効性を検証する、という流れを繰り返します。

サンプルコードのRangeIteratorでは、現在の数値が指定された終了値以下であるかをvalid()メソッドで確認しています。$this->current <= $this->endがtrueであれば、その位置は有効と判断され、foreachループは継続します。一方、falseを返すとイテレータは範囲の終わりと見なされ、ループは終了します。

このようにvalid()は、イテレータが妥当な状態にあるかを「バリデート」し、イテレーションの継続・終了を制御する、まさに「validator」としての役割を果たす重要なメソッドです。