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

Copy
1<?php
2
3/**
4 * SeekableIterator インターフェースを実装するカスタムイテレータの例。
5 * valid() メソッドの動作と、イテレータの現在位置の「有効性」を検証する役割を示します。
6 */
7class MyArrayIterator implements SeekableIterator
8{
9    private array $data;
10    private int $position = 0;
11
12    /**
13     * コンストラクタ
14     *
15     * @param array $data イテレートする対象のデータ配列
16     */
17    public function __construct(array $data)
18    {
19        // データ配列を内部に保持し、キーを数値インデックスにリセットして扱いやすくする
20        $this->data = array_values($data);
21    }
22
23    /**
24     * イテレータを最初の要素に巻き戻します。
25     */
26    public function rewind(): void
27    {
28        $this->position = 0;
29    }
30
31    /**
32     * 現在の要素の値を返します。
33     *
34     * @return mixed 現在の要素の値
35     */
36    public function current(): mixed
37    {
38        return $this->data[$this->position];
39    }
40
41    /**
42     * 現在の要素のキーを返します。
43     *
44     * @return int 現在のキー (ここでは配列のインデックス)
45     */
46    public function key(): int
47    {
48        return $this->position;
49    }
50
51    /**
52     * イテレータを次の要素に進めます。
53     */
54    public function next(): void
55    {
56        ++$this->position;
57    }
58
59    /**
60     * 現在のイテレータの位置が有効かどうかを検証します。
61     * これがこのサンプルコードの主要な部分であり、PHPのイテレータで要素の「有効性」をチェックします。
62     *
63     * @return bool 現在の位置に要素が存在すれば true、そうでなければ false
64     */
65    public function valid(): bool
66    {
67        // 現在のポジションがデータ配列の範囲内にあるかをチェックします。
68        // これが、イテレータが有効な要素を指しているかどうかの「検証 (validate)」にあたります。
69        return isset($this->data[$this->position]);
70    }
71
72    /**
73     * イテレータを指定された位置へシークします。
74     * SeekableIterator インターフェースの必須メソッドですが、`valid()`の理解を目的としているため簡略化。
75     *
76     * @param int $offset シークする位置 (配列のインデックス)
77     * @throws OutOfBoundsException 指定された位置が無効な場合
78     */
79    public function seek(int $offset): void
80    {
81        // シークしようとしているオフセットが有効な範囲内かを確認（ここでも有効性の検証が行われる）
82        if (!isset($this->data[$offset])) {
83            throw new OutOfBoundsException("Invalid seek position: $offset");
84        }
85        $this->position = $offset;
86    }
87}
88
89// サンプルデータ配列
90$items = ['Apple', 'Banana', 'Cherry', 'Date'];
91
92// MyArrayIterator クラスのインスタンスを作成
93$iterator = new MyArrayIterator($items);
94
95echo "--- foreach ループでの利用例 (内部で valid() が自動的に呼び出されます) ---\n";
96// foreach ループは内部的に rewind() -> valid() -> current() -> key() -> next() -> valid() ... の順で動作します。
97// valid() が false を返すとループが終了します。
98foreach ($iterator as $key => $value) {
99    echo "Key: {$key}, Value: {$value}\n";
100}
101
102echo "\n--- valid() メソッドの手動での動作確認 ---\n";
103
104// イテレータを最初の位置に巻き戻す
105$iterator->rewind();
106echo "rewind() 後: " . ($iterator->valid() ? '有効 (true)' : '無効 (false)') . "\n"; // 最初の要素 'Apple' があるため true
107
108$iterator->next(); // 次の要素へ進む ('Banana' へ)
109echo "next() 後: " . ($iterator->valid() ? '有効 (true)' : '無効 (false)') . "\n"; // 'Banana' があるため true
110
111$iterator->seek(3); // インデックス3の位置へシーク ('Date' へ)
112echo "seek(3) 後: " . ($iterator->valid() ? '有効 (true)' : '無効 (false)') . "\n"; // 'Date' があるため true
113
114$iterator->next(); // さらに次の要素へ進む (配列の範囲外へ)
115echo "next() 後: " . ($iterator->valid() ? '有効 (true)' : '無効 (false)') . "\n"; // 範囲外のため false
116
117// 空の配列での valid() の動作確認
118echo "\n--- 空の配列での valid() 確認 ---\n";
119$emptyItems = [];
120$emptyIterator = new MyArrayIterator($emptyItems);
121$emptyIterator->rewind();
122echo "空配列での rewind() 後: " . ($emptyIterator->valid() ? '有効 (true)' : '無効 (false)') . "\n"; // 要素がないため false
123

PHP 8のSeekableIterator::valid()メソッドは、データを順番に処理する「イテレータ」が現在指し示している位置に、有効な要素が存在するかどうかを検証する役割を持ちます。このメソッドは引数を受け取らず、現在の位置に要素が存在すればtrue（真）を、存在しなければfalse（偽）をbool型で返します。

この機能は、イテレータがデータの終端に達したか、または現在の位置がデータとして有効ではないかを判断するために非常に重要です。例えば、PHPのforeachループで配列やカスタムクラスを扱う際、内部ではこのvalid()メソッドが自動的に呼び出され、ループを継続すべきか、それとも終了すべきかを判断しています。

サンプルコードのMyArrayIteratorクラスでは、valid()メソッドが現在の内部配列のインデックス（$this->position）にデータが存在するかをisset()関数でチェックすることで、要素の有効性を判断しています。next()メソッドで次の位置に進んだ結果、配列の範囲外になった場合や、もともと空の配列であった場合など、要素が存在しない位置ではvalid()はfalseを返します。これにより、イテレータが指し示す位置が適切かどうかをプログラムが確認し、安全にデータを処理できるようになっています。

Copy
1<?php
2
3/**
4 * SeekableIteratorインターフェースを実装するカスタムイテレータ。
5 * valid()メソッドはIteratorインターフェース（SeekableIteratorが継承）の一部であり、
6 * イテレータの現在の位置に有効な要素があるかを検証します。
7 * キーワード「validator」に関連して、イテレータの内部状態の「有効性」をチェックする用途を示します。
8 */
9class SimpleSeekableIterator implements SeekableIterator
10{
11    private array $data;
12    private int $position = 0;
13
14    public function __construct(array $data)
15    {
16        $this->data = $data;
17    }
18
19    /**
20     * イテレータの現在の要素を返す。
21     * @return mixed 現在の要素の値
22     */
23    public function current(): mixed
24    {
25        return $this->data[$this->position];
26    }
27
28    /**
29     * イテレータの現在のキーを返す。
30     * @return int 現在の要素のキー
31     */
32    public function key(): int
33    {
34        return $this->position;
35    }
36
37    /**
38     * イテレータを次の要素に進める。
39     */
40    public function next(): void
41    {
42        $this->position++;
43    }
44
45    /**
46     * イテレータを最初の位置（0）に巻き戻す。
47     */
48    public function rewind(): void
49    {
50        $this->position = 0;
51    }
52
53    /**
54     * 現在の位置に有効な要素があるかを検証する。
55     * このメソッドは、イテレーションのループが継続できるかどうかを判断するために使用されます。
56     * @return bool 現在の位置が有効な要素を指していればtrue、そうでなければfalse。
57     */
58    public function valid(): bool
59    {
60        return isset($this->data[$this->position]);
61    }
62
63    /**
64     * 指定された位置にイテレータを移動する (SeekableIteratorのメソッド)。
65     * @param int $position 移動するインデックス
66     * @throws OutOfBoundsException 指定された位置が存在しない場合
67     */
68    public function seek(int $position): void
69    {
70        if (!isset($this->data[$position])) {
71            throw new OutOfBoundsException("Invalid seek position: {$position}");
72        }
73        $this->position = $position;
74    }
75}
76
77// サンプルデータの準備
78$myData = ['Apple', 'Banana', 'Cherry', 'Date'];
79
80// カスタムイテレータのインスタンスを作成
81$iterator = new SimpleSeekableIterator($myData);
82
83echo "--- valid() メソッドを使った手動イテレーションの例 ---" . PHP_EOL;
84
85// イテレータを最初の位置にリセット
86$iterator->rewind();
87
88// valid() が true を返す間、ループを続ける
89while ($iterator->valid()) {
90    echo "Key: " . $iterator->key() . ", Value: " . $iterator->current() . PHP_EOL;
91    $iterator->next(); // 次の要素へ進む
92}
93
94echo PHP_EOL . "--- foreach ループでの利用 (内部でvalid()などが使われる) ---" . PHP_EOL;
95// foreach ループは、内部的に rewind(), valid(), current(), key(), next() を使用します。
96foreach ($iterator as $key => $value) {
97    echo "Key: {$key}, Value: {$value}" . PHP_EOL;
98}
99
100echo PHP_EOL . "--- seek() 後に valid() を確認する例 ---" . PHP_EOL;
101// 特定の位置にシーク
102$iterator->seek(1); // 2番目の要素 (インデックス1) に移動
103
104// valid() をチェックして現在の位置が有効か確認
105if ($iterator->valid()) {
106    echo "Seeked to position 1. Current value: " . $iterator->current() . PHP_EOL; // Banana
107} else {
108    echo "Seeked to position 1, but it is not valid." . PHP_EOL;
109}
110
111echo PHP_EOL . "--- 空のイテレータで valid() が false になる状況 ---" . PHP_EOL;
112$emptyIterator = new SimpleSeekableIterator([]);
113$emptyIterator->rewind();
114if (!$emptyIterator->valid()) {
115    echo "空のイテレータでは valid() が false を返します。" . PHP_EOL;
116}
117

PHPのSeekableIteratorインターフェースは、コレクションの要素を順番に処理するための機能を提供します。その中のvalid()メソッドは、イテレータの現在の位置に有効な要素が存在するかどうかを確認するために使用されます。このメソッドは引数を取らず、現在の位置が有効であればtrueを、そうでなければfalseをブール値で返します。

サンプルコードでは、SimpleSeekableIteratorクラスが配列の要素が存在するかどうかをvalid()メソッドでチェックしています。これにより、イテレーションのループが次の要素に進むことができるか、あるいはすでにコレクションの終わりに達しているかを判断します。whileループでvalid()の結果を利用してイテレーションを継続するかどうかを決定したり、foreachループが内部的にvalid()を呼び出して要素を順番に処理したりします。また、seek()メソッドで特定のインデックスに移動した後、その位置が有効であるかをvalid()で確認することもできます。空のイテレータの場合、valid()はfalseを返し、処理を停止させます。このようにvalid()は、イテレータの「状態の有効性」を検証する役割を持ち、キーワード「validator」の文脈に合致するメソッドです。