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

Copy
1<?php
2
3/**
4 * 指定された期間の日付を生成し、それぞれの日に簡単な祝日判定を行うジェネレータ関数。
5 * システムエンジニアにとって、日付のシーケンス処理は一般的なタスクです。
6 *
7 * @param string $startDateStr 開始日 (YYYY-MM-DD)
8 * @param string $endDateStr 終了日 (YYYY-MM-DD)
9 * @return Generator 日付と祝日判定の結果のペアをyieldします。
10 */
11function generateDatesWithHolidayCheck(string $startDateStr, string $endDateStr): Generator
12{
13    $currentDate = new DateTime($startDateStr);
14    $endDate = new DateTime($endDateStr);
15
16    while ($currentDate <= $endDate) {
17        $isHoliday = false;
18        $dayOfWeek = (int)$currentDate->format('N'); // 1 (月) through 7 (日)
19
20        // 簡易的な祝日判定ロジック (例: 週末や特定の日は祝日とみなす)
21        if ($dayOfWeek == 6 || $dayOfWeek == 7) { // 土曜日または日曜日
22            $isHoliday = true;
23        }
24        if ($currentDate->format('m-d') === '01-01') { // 1月1日
25            $isHoliday = true;
26        }
27
28        // 日付と祝日判定結果のペアを生成 (yield) します
29        yield $currentDate->format('Y-m-d') => $isHoliday;
30
31        $currentDate->modify('+1 day');
32    }
33}
34
35// -----------------------------------------------------------
36// ReflectionGenerator::isClosed の使用例
37// -----------------------------------------------------------
38
39// 2024年12月28日から2025年1月2日までの日付を生成するジェネレータを作成
40$generator = generateDatesWithHolidayCheck('2024-12-28', '2025-01-02');
41
42// ReflectionGenerator は、実行中のジェネレータに関する情報にアクセスするためのクラスです。
43// ここでは、ジェネレータが閉じているかどうかをチェックするために使用します。
44$reflectionGenerator = new ReflectionGenerator($generator);
45
46echo "--- ジェネレータの状態確認 (開始前) ---\n";
47// ジェネレータが閉じているかを確認します。
48// まだ値を生成していないため、通常は閉じられていません。
49echo "ジェネレータは閉じていますか？ " . ($reflectionGenerator->isClosed() ? 'はい' : 'いいえ') . "\n\n";
50
51echo "--- ジェネレータを処理中 ---\n";
52// ジェネレータから一つずつ値（日付と祝日情報）を取り出し、処理します。
53foreach ($generator as $date => $isHoliday) {
54    echo "日付: $date, 祝日: " . ($isHoliday ? 'はい' : 'いいえ') . "\n";
55    // 各イテレーション中もジェネレータはまだ閉じられていません。
56    echo "  (処理中) ジェネレータは閉じていますか？ " . ($reflectionGenerator->isClosed() ? 'はい' : 'いいえ') . "\n";
57}
58
59echo "\n--- ジェネレータの状態確認 (処理後) ---\n";
60// 全ての値を消費し終えた後、ジェネレータが閉じているかを確認します。
61// 全てのyieldが完了したため、ジェネレータは閉じられた状態になります。
62echo "ジェネレータは閉じていますか？ " . ($reflectionGenerator->isClosed() ? 'はい' : 'いいえ') . "\n";
63
64echo "\n--- 閉じられたジェネレータを再度進めようとする ---\n";
65// ジェネレータが閉じている場合、それ以上新しい値を生成することはありません。
66if ($reflectionGenerator->isClosed()) {
67    echo "ジェネレータは既に閉じているため、これ以上進められません。\n";
68}
69?>

PHP 8のReflectionGenerator::isClosedメソッドは、ジェネレータの状態を検査するために使用されます。ReflectionGeneratorクラスは、実行中のジェネレータに関する詳細情報にアクセスするための機能を提供します。このisClosedメソッドは引数を取らず、ジェネレータが全ての値を生成し終えて閉じられた状態であるかをbool型（真偽値）で返します。trueであればジェネレータは閉じられており、これ以上新しい値を生成しません。falseであれば、まだ値を生成する可能性があり、開いた状態です。

サンプルコードでは、指定された期間の日付と簡易的な祝日判定を行うgenerateDatesWithHolidayCheckというジェネレータ関数を作成しています。この関数は、システムエンジニアにとって一般的な日付処理のタスクを模しています。

コードの実行を開始する前、まだジェネレータが一つも値を生成していない時点では、isClosedはfalseを返します。foreachループでジェネレータから値を一つずつ取り出している間も、まだ全ての値が生成されていないため、isClosedはfalseのままです。ジェネレータが期間内の全ての日付と祝日情報をyieldし終え、ループが完了すると、ジェネレータは閉じられた状態になります。この時点でisClosedを呼び出すとtrueが返され、ジェネレータが完全に処理を終えたことが確認できます。このようにisClosedを使用することで、ジェネレータのライフサイクルを正確に管理し、不要な操作を避けることができます。

Copy
1<?php
2
3/**
4 * ジェネレータ関数の例
5 * 数値を順番に生成し、最後に文字列を返します。
6 *
7 * @return Generator
8 */
9function simpleGenerator(): Generator
10{
11    echo "--- ジェネレータが開始されました ---\n";
12    yield 1;
13    echo "--- 1が生成されました ---\n";
14    yield 2;
15    echo "--- 2が生成されました ---\n";
16    // ジェネレータの実行が完了し、閉じられることを示す
17    return "Generator finished successfully.";
18}
19
20/**
21 * ReflectionGenerator::isClosed メソッドの利用例
22 * ジェネレータの状態変化に伴う isClosed の挙動を示します。
23 *
24 * @return void
25 */
26function demonstrateReflectionGeneratorIsClosed(): void
27{
28    // ジェネレータオブジェクトを生成します。
29    // この時点では、ジェネレータはまだ実行されていません。
30    $generator = simpleGenerator();
31
32    // ジェネレータがオブジェクトであることを確認します。
33    // is_object() はPHPの組み込み関数で、変数がオブジェクト型であるかを判定します。
34    // このチェックは、ジェネレータがPHPのオブジェクトであるという基本的な理解を助けます。
35    echo "ジェネレータはオブジェクトですか？ " . (is_object($generator) ? "はい" : "いいえ") . "\n\n";
36
37    // ReflectionGenerator のインスタンスを作成します。
38    // これにより、ジェネレータの内部状態を検査できるようになります。
39    $reflector = new ReflectionGenerator($generator);
40
41    echo "--- 実行前 ---\n";
42    // ジェネレータはまだ開始されていないため、閉じられていません。
43    echo "isClosed(): " . ($reflector->isClosed() ? "true" : "false") . "\n\n";
44
45    // ジェネレータを最初の yield まで進めます。
46    // current() は最初の yield の値を返しますが、ジェネレータの内部ポインタはまだ移動していません。
47    echo "generator->current(): " . $generator->current() . "\n";
48    echo "generator->next() を呼び出し... (最初の yield 後に進む)\n";
49    $generator->next();
50
51    echo "--- 最初の yield 後 (一時停止中) ---\n";
52    // ジェネレータは一時停止中であり、まだ実行が完了していないため、閉じられていません。
53    echo "isClosed(): " . ($reflector->isClosed() ? "true" : "false") . "\n\n";
54
55    // ジェネレータを次の yield まで進めます。
56    echo "generator->current(): " . $generator->current() . "\n";
57    echo "generator->next() を呼び出し... (2番目の yield 後に進む)\n";
58    $generator->next();
59
60    echo "--- 2番目の yield 後 (一時停止中) ---\n";
61    // ジェネレータは一時停止中であり、まだ実行が完了していないため、閉じられていません。
62    echo "isClosed(): " . ($reflector->isClosed() ? "true" : "false") . "\n\n";
63
64    // ジェネレータを最後まで実行させます。
65    // これにより、ジェネレータは 'return' 文に到達し、実行が完了して閉じられます。
66    echo "generator->next() を呼び出し (ジェネレータの終了まで)...\n";
67    $generator->next();
68
69    echo "--- ジェネレータ実行完了後 ---\n";
70    // ジェネレータの実行が完了したため、閉じられています。
71    echo "isClosed(): " . ($reflector->isClosed() ? "true" : "false") . "\n";
72
73    // ジェネレータの戻り値も取得できます (PHP 7 以降でサポート)
74    echo "ジェネレータの戻り値: " . $reflector->getReturnValue() . "\n";
75}
76
77// サンプル関数の実行
78demonstrateReflectionGeneratorIsClosed();

PHP 8のReflectionGeneratorクラスに属するisClosedメソッドは、ジェネレータの実行が完了し、閉じられた状態であるかを判定するために使用されます。このメソッドは引数を取らず、ジェネレータが閉じられている場合はtrueを、まだ実行中であるか、またはまだ開始されていない場合はfalseをブール値として返します。

サンプルコードでは、simpleGenerator関数がyieldキーワードを使って値を段階的に生成し、最後にreturn文で終了するジェネレータの例を示しています。このジェネレータの内部状態を調べるために、ReflectionGeneratorのインスタンスを作成します。

ジェネレータがまだ開始されていない時点や、yieldによって一時停止している間は、isClosedメソッドはfalseを返します。これは、ジェネレータがまだ値を生成する可能性があり、実行が完了していないことを意味します。しかし、ジェネレータがすべてのyieldを処理し、return文に到達して実行を完了すると、isClosedはtrueを返すようになります。これは、ジェネレータが完全に閉じられ、それ以上値を生成できない状態になったことを示します。

コード内でis_object($generator)とあるのは、ジェネレータがPHPにおいてオブジェクトの一種であることを確認するための記述です。ReflectionGenerator::isClosedメソッドは、このようにジェネレータのライフサイクルにおける現在の状態を正確に把握する際に役立ちます。