【PHP8.x】validメソッドの使い方

Copy
1<?php
2
3/**
4 * ジェネレータ関数を定義します。
5 * この関数は、いくつかの数値を順番に「生成」します。
6 * ジェネレータは、メモリを節約しながら大きなデータセットを処理するのに役立ちます。
7 */
8function createNumberGenerator(): Generator
9{
10    yield 10; // 最初の値を生成
11    yield 20; // 次の値を生成
12    yield 30; // 最後の値を生成
13}
14
15// ジェネレータオブジェクトを作成します。
16// この時点では、まだ値は生成されていません。
17$generator = createNumberGenerator();
18
19echo "--- ジェネレータの初期状態 ---" . PHP_EOL;
20
21// valid() メソッドを使って、ジェネレータがまだ値を生成できる「有効な」状態にあるか確認します。
22// 最初はまだ最初の値を生成できるので、true を返します。
23echo "ジェネレータは有効な状態ですか？ " . ($generator->valid() ? "はい" : "いいえ") . PHP_EOL;
24
25// 現在の値を表示します。valid() が true なら、current() で値を取得できます。
26echo "現在の値: " . $generator->current() . PHP_EOL; // 出力: 10
27
28echo PHP_EOL . "--- 次の値へ進む ---" . PHP_EOL;
29
30// next() メソッドで、ジェネレータを次の値に進めます。
31$generator->next();
32
33// 再び valid() で有効性を確認します。
34// まだ値を生成できるので、true を返します。
35echo "ジェネレータは有効な状態ですか？ " . ($generator->valid() ? "はい" : "いいえ") . PHP_EOL;
36
37// 現在の値を表示します。
38echo "現在の値: " . $generator->current() . PHP_EOL; // 出力: 20
39
40echo PHP_EOL . "--- さらに次の値へ進む ---" . PHP_EOL;
41
42$generator->next();
43
44echo "ジェネレータは有効な状態ですか？ " . ($generator->valid() ? "はい" : "いいえ") . PHP_EOL;
45echo "現在の値: " . $generator->current() . PHP_EOL; // 出力: 30
46
47echo PHP_EOL . "--- 全ての値を生成し終える ---" . PHP_EOL;
48
49// 最後の値の次へ進みます。もう生成できる値はありません。
50$generator->next();
51
52// 全ての値を生成し終えたので、ジェネレータは「無効な」状態になります。
53// valid() は false を返します。
54echo "ジェネレータは有効な状態ですか？ " . ($generator->valid() ? "はい" : "いいえ") . PHP_EOL;
55
56// 無効な状態では current() は null を返します。
57echo "現在の値 (無効な状態): " . ($generator->current() === null ? "null" : $generator->current()) . PHP_EOL;
58

PHPのGenerator::valid()メソッドは、ジェネレータが現在、まだ次に生成すべき値を持っている「有効な状態」にあるかを確認するために使用されます。ジェネレータは、メモリを効率的に使いながら、必要なときに値を一つずつ「生成」する特別な機能を持つオブジェクトです。

このvalid()メソッドは引数を一切取らず、戻り値として真偽値（bool）を返します。ジェネレータがまだ値を生成できる場合はtrueを、全ての値を生成し終えてもうこれ以上生成するものがない場合はfalseを返します。

サンプルコードでは、createNumberGenerator()関数が数値ジェネレータを作成します。ジェネレータを初期化した直後、まだ最初の値（10）を生成できるため、$generator->valid()はtrueを返します。その後、next()メソッドでジェネレータを次の値に進めるごとに、まだ生成できる値があればvalid()はtrueを返し続けます。

最終的に、ジェネレータが全ての値（10、20、30）を生成し終えて、もうこれ以上生成する値がない状態でnext()を呼び出すと、ジェネレータは「無効な状態」になります。この時、$generator->valid()はfalseを返します。ジェネレータが無効な状態になると、current()メソッドはnullを返すようになります。このように、valid()メソッドは、ジェネレータを用いたループ処理などで、イテレーションを継続すべきか、終了すべきかを判断する重要な役割を担います。

Copy
1<?php
2
3/**
4 * PHPのGenerator::valid()メソッドの動作を初心者向けに示します。
5 *
6 * このメソッドは、ジェネレータがまだ値を生成できる状態か（つまり、イテレーションの継続が有効か）
7 * をチェックするために使用されます。
8 * キーワードの「validator」から連想される一般的な入力値のバリデーション（検証）とは異なり、
9 * ジェネレータの内部状態が「有効な要素を保持しているか」を判断します。
10 */
11function demonstrateGeneratorValid(): void
12{
13    /**
14     * 指定された回数だけ数値を順次生成するジェネレータ関数です。
15     *
16     * @param int $max 生成する数値の最大値（この値を含まない）
17     * @return Generator<int>
18     */
19    $numberGenerator = function (int $max): Generator {
20        for ($i = 0; $i < $max; $i++) {
21            echo "  ジェネレータが " . $i . " を 'yield' しました。\n";
22            yield $i;
23        }
24        echo "  ジェネレータは全ての値を生成し終わりました。\n";
25    };
26
27    // ジェネレータオブジェクトを生成します。この時点では、まだ値は生成されていません。
28    $generator = $numberGenerator(3);
29
30    echo "--- ジェネレータの初期状態 ---\n";
31    // ジェネレータは最初の要素を指す準備ができています。
32    // valid() は、ジェネレータが有効な要素を指しているか、または指すことができるかを示します。
33    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // true
34
35    echo "\n--- 最初の要素の取得と、次の要素の存在確認 ---\n";
36    // current() を呼び出すと、最初の 'yield' が実行されます。
37    echo "generator->current() の値: " . $generator->current() . "\n"; // 0
38    // 次の要素（1）が存在するため、valid() は true です。
39    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // true
40
41    echo "\n--- 次の要素へ進む ---\n";
42    // next() を呼び出すと、ジェネレータは次の 'yield' へと進みます。
43    $generator->next();
44    echo "generator->current() の値: " . $generator->current() . "\n"; // 1
45    // 次の要素（2）が存在するため、valid() は true です。
46    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // true
47
48    echo "\n--- さらに次の要素へ進む ---\n";
49    $generator->next();
50    echo "generator->current() の値: " . $generator->current() . "\n"; // 2
51    // これが最後の要素です。この後にはもう要素がありません。
52    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // true
53
54    echo "\n--- 全ての要素を消費した後 ---\n";
55    // 全ての要素を 'yield' し終えた後、ジェネレータは終了状態になります。
56    $generator->next();
57    // ジェネレータが終了したため、current() は null を返します。
58    echo "generator->current() の値: " . var_export($generator->current(), true) . "\n"; // null
59    // もう有効な要素が存在しないため、valid() は false です。
60    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // false
61
62    echo "\n--- ジェネレータ終了後の valid() ---\n";
63    // 終了状態では、valid() は常に false を返します。
64    $generator->next(); // この呼び出しは何も影響しません
65    echo "generator->valid() の結果: " . var_export($generator->valid(), true) . "\n"; // false
66}
67
68// 関数を実行して、Generator::valid() の動作を確認します。
69demonstrateGeneratorValid();

PHPのGenerator::valid()メソッドは、ジェネレータがまだ値を生成できる状態にあるか、つまり繰り返し処理を継続できるかを確認するために使用されます。これは一般的な入力値の検証とは異なり、ジェネレータが内部的に「有効な要素を指しているか」、または「次の要素を生成できるか」を判断するものです。

このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。ジェネレータがまだ有効な要素を生成できる状態であればtrueを返し、全ての値の生成を終えて終了状態になるとfalseを返します。

サンプルコードでは、数値を順次生成するジェネレータを用いてGenerator::valid()の動作を示しています。ジェネレータオブジェクトを生成した直後、まだ値が生成されていなくても、最初の要素を生成できるためtrueを返します。current()で値を取得し、next()で次の要素に進む間は、ジェネレータが次の要素を持っているため、valid()は一貫してtrueを返します。しかし、全ての値を生成し終わり、next()を呼び出してジェネレータが終了状態になると、valid()はfalseを返します。これにより、ジェネレータが全ての処理を終えたことを確認できます。foreachループがジェネレータを処理する際にも、内部でこのvalid()メソッドを使って反復を続けるかどうかを判断しています。