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

Copy
1<?php
2
3/**
4 * DirectoryIterator::valid() メソッドのサンプルコード。
5 *
6 * この関数は、指定されたディレクトリの内容を DirectoryIterator を使って走査し、
7 * valid() メソッドがどのようにイテレータの有効性を検証するかを示します。
8 * valid() メソッドは、イテレータがまだ有効な要素（ファイルやサブディレクトリ）を
9 * 指しているかどうかをチェックし、ループの継続条件として利用されます。
10 *
11 * 「validation」というキーワードは、この文脈ではデータ入力の検証ではなく、
12 * イテレータの現在の位置が有効であるかの「検証」を指します。
13 */
14function demonstrateDirectoryIteratorValid(): void
15{
16    // 1. 一時ディレクトリとテストファイルを作成
17    // 一時ディレクトリのパスを生成
18    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_dir_iter_test_' . uniqid('dir_');
19
20    // ディレクトリの作成を試みる
21    if (!mkdir($tempDir, 0777, true) && !is_dir($tempDir)) {
22        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
23        return;
24    }
25
26    // テスト用のファイルとサブディレクトリを作成
27    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'test content');
28    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'another content');
29    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir');
30
31    echo "一時ディレクトリ '{$tempDir}' を作成し、テストファイルを追加しました。\n";
32    echo "DirectoryIterator を使用して内容を走査しています...\n";
33
34    try {
35        // 2. DirectoryIterator のインスタンスを作成
36        // 指定されたディレクトリの内容をイテレーションするためのオブジェクト
37        $iterator = new DirectoryIterator($tempDir);
38
39        // 3. イテレータを先頭にリセット (必須ではないが、明示的に示すことで理解しやすくなる)
40        $iterator->rewind();
41
42        // 4. valid() メソッドを使って、イテレータが有効な要素を指している間ループを続ける
43        // valid() は、イテレータが末尾に達していないか、あるいは無効な状態でないかをチェックします。
44        while ($iterator->valid()) {
45            // '.' と '..' は特別なエントリなので、通常はスキップします
46            if ($iterator->isDot()) {
47                echo "- スキップ: '{$iterator->getFilename()}' (特殊エントリ)\n";
48            } else {
49                // 現在の要素のファイル名と種類を表示
50                $filename = $iterator->getFilename();
51                $type = $iterator->isDir() ? 'ディレクトリ' : 'ファイル';
52                echo "- 見つかった {$type}: {$filename}\n";
53            }
54
55            // 5. 次の要素に進む
56            $iterator->next();
57        }
58
59        echo "すべてのエントリの走査が完了しました。\n";
60
61    } catch (UnexpectedValueException $e) {
62        // ディレクトリが存在しない、または読み取り権限がない場合のエラーハンドリング
63        echo "エラー: ディレクトリの読み込み中に問題が発生しました - " . $e->getMessage() . "\n";
64    } finally {
65        // 6. クリーンアップ: 作成したディレクトリとファイルを削除
66        echo "一時ディレクトリ '{$tempDir}' をクリーンアップしています...\n";
67        
68        // サブディレクトリ内のファイルを削除してからサブディレクトリを削除
69        if (is_dir($tempDir . DIRECTORY_SEPARATOR . 'subdir')) {
70            rmdir($tempDir . DIRECTORY_SEPARATOR . 'subdir');
71        }
72        if (file_exists($tempDir . DIRECTORY_SEPARATOR . 'file1.txt')) {
73            unlink($tempDir . DIRECTORY_SEPARATOR . 'file1.txt');
74        }
75        if (file_exists($tempDir . DIRECTORY_SEPARATOR . 'file2.txt')) {
76            unlink($tempDir . DIRECTORY_SEPARATOR . 'file2.txt');
77        }
78        // 最上位の一時ディレクトリを削除
79        if (is_dir($tempDir)) {
80            rmdir($tempDir);
81        }
82        echo "クリーンアップが完了しました。\n";
83    }
84}
85
86// 関数の実行
87demonstrateDirectoryIteratorValid();

PHP 8のDirectoryIteratorクラスに属するvalid()メソッドは、ディレクトリ内の要素を順に処理する際に、現在のイテレータの位置が有効であるかを検証するために使用されます。このメソッドは引数を持たず、戻り値として真偽値（bool）を返します。

具体的には、valid()メソッドは、DirectoryIteratorがまだ処理すべきファイルやサブディレクトリなどの有効な要素を指している場合にtrueを返します。すべての要素の走査が完了したり、イテレータが無効な状態になったりした場合にはfalseを返します。この特性から、通常はwhileループの継続条件として利用され、ディレクトリ内の全要素を確実に走査するために不可欠です。

キーワード「validation」は、一般的なデータ入力の検証とは異なり、この文脈ではイテレータの現在の状態が「有効であるか」を検査する意味合いで使われます。サンプルコードでは、一時ディレクトリを作成し、その中のテストファイルやサブディレクトリをDirectoryIteratorで順に走査する過程で、valid()メソッドがどのようにループの継続を制御しているかを示しています。これにより、ディレクトリ内のすべてのエントリを安全かつ効率的に処理できる仕組みを理解できます。

Copy
1<?php
2
3/**
4 * DirectoryIterator::valid() メソッドの使用例。
5 *
6 * この関数は、指定されたディレクトリの内容を反復処理し、
7 * DirectoryIterator::valid() メソッドが現在のイテレータ位置が有効かどうかを
8 * どのように「検証」するかを示します。
9 *
10 * @param string $directoryPath 処理するディレクトリのパス。
11 *                              デフォルトはカレントディレクトリ ('.')。
12 * @return void
13 */
14function demonstrateDirectoryIteratorValid(string $directoryPath = '.'): void
15{
16    echo "--- DirectoryIterator::valid() デモンストレーション for: '{$directoryPath}' ---\n\n";
17
18    try {
19        // DirectoryIterator オブジェクトを作成します。
20        // 指定されたパスが存在しないかアクセスできない場合、UnexpectedValueException がスローされます。
21        $iterator = new DirectoryIterator($directoryPath);
22
23        // 1. イテレータが初期位置にあるときの valid() の状態を確認します。
24        // ディレクトリが存在し、エントリーがある場合は true を返します。
25        echo "初期位置でイテレータは有効ですか？ " . ($iterator->valid() ? "はい" : "いいえ") . "\n\n";
26
27        // 2. イテレータを数回進めながら valid() の状態を確認します。
28        // valid() は、ループの続行が可能かどうかを「検証」するために使用されます。
29        echo "最初の数アイテムを反復処理中...\n";
30        $processedCount = 0;
31        while ($iterator->valid() && $processedCount < 3) {
32            // 現在のファイル名を取得します。
33            echo "- ファイル名: " . $iterator->getFilename() . "\n";
34
35            // イテレータを次の位置に進めます。
36            $iterator->next();
37            $processedCount++;
38        }
39        echo "上記 " . $processedCount . " アイテム処理後、現在の位置は有効ですか？ " . ($iterator->valid() ? "はい" : "いいえ") . "\n\n";
40
41        // 3. イテレータをディレクトリの終端まで進め、valid() の状態を最終確認します。
42        echo "ディレクトリの終端まで進んでいます...\n";
43        while ($iterator->valid()) {
44            $iterator->next(); // 有効なエントリーがなくなるまで進めます。
45        }
46
47        // 全てのエントリーを過ぎた後、valid() は false を返します。
48        echo "全てのエントリーを過ぎた後、イテレータは有効ですか？ " . ($iterator->valid() ? "はい" : "いいえ") . "\n"; // これは「いいえ」になるはずです。
49
50    } catch (UnexpectedValueException $e) {
51        echo "エラー: ディレクトリ '{$directoryPath}' を開けませんでした。エラーメッセージ: " . $e->getMessage() . "\n";
52    } catch (Exception $e) {
53        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
54    }
55
56    echo "\n--- デモンストレーション終了 ---\n";
57}
58
59// 現在のスクリプトがあるディレクトリ (通常は必ず存在する) を対象にデモンストレーションを実行します。
60demonstrateDirectoryIteratorValid('.');
61
62// 参考: 存在しないディレクトリを指定した場合のエラー処理の例
63// demonstrateDirectoryIteratorValid('non_existent_directory_123');

DirectoryIterator::valid() メソッドは、PHPでディレクトリ内のファイルやサブディレクトリを順番に処理する際に利用される重要な機能です。このメソッドは引数を一切取らず、現在のイテレータ（ディレクトリを探索している位置）が有効なエントリ（ファイルやフォルダ）を指しているかどうかを真偽値（trueまたはfalse）で「検証」し、その結果を返します。

具体的には、まだ処理すべき有効なファイルやフォルダが存在する場合にtrueを返し、既に全てのファイルやフォルダを処理し終えてディレクトリの終端に達した場合にはfalseを返します。そのため、一般的にはwhileループの条件式として使用され、反復処理を継続すべきかどうかを判断する役割を担います。

サンプルコードでは、まずイテレータの初期位置でvalid()がtrueを返すことを確認し、いくつかのアイテムを処理した途中、そして最終的にディレクトリの全てのエントリを処理し終えた後にfalseを返す様子が示されています。これにより、valid()がディレクトリの反復処理において、いつ処理を続けるべきか、いつ終了すべきかを正確に判断するための「バリデータ」として機能することがわかります。