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

Copy
1<?php
2
3/**
4 * FilesystemIterator::valid() メソッドのサンプルコード
5 *
6 * このスクリプトは、FilesystemIterator を使用してディレクトリの内容を走査し、
7 * valid() メソッドがどのようにイテレーションの有効性を判断するかを示します。
8 * valid() メソッドは、現在のイテレータの位置に有効な要素がある場合に true を返し、
9 * イテレーションの終わりに達したときに false を返します。
10 * これは、ファイルシステム上の特定の要素が「有効」であるかを確認する一例です。
11 */
12
13// 一時的なテストディレクトリを作成し、ファイルとサブディレクトリを追加します。
14$testDirectory = __DIR__ . '/temp_fs_iterator_test';
15
16// ディレクトリが存在しない場合のみ作成
17if (!is_dir($testDirectory)) {
18    mkdir($testDirectory);
19}
20
21// テストファイルを作成
22file_put_contents($testDirectory . '/document.txt', 'これはテストドキュメントです。');
23file_put_contents($testDirectory . '/image.jpg', 'これはテスト画像です。');
24// テスト用サブディレクトリを作成
25mkdir($testDirectory . '/archive');
26file_put_contents($testDirectory . '/archive/old_file.zip', '古いファイルです。');
27
28
29try {
30    // FilesystemIterator のインスタンスを作成します。
31    // FilesystemIterator::SKIP_DOTS フラグは、'.' と '..' エントリをスキップします。
32    $iterator = new FilesystemIterator($testDirectory, FilesystemIterator::SKIP_DOTS);
33
34    echo "ディレクトリ '{$testDirectory}' の内容を走査します:\n";
35
36    // valid() メソッドを使用して、イテレータが有効な要素を指している間ループを続けます。
37    // valid() は、イテレーションの現在の位置が有効な要素を指している場合に true を返します。
38    // イテレーションの終わりに達すると false を返します。
39    while ($iterator->valid()) {
40        // 現在の要素のファイル名と絶対パスを表示します。
41        echo "  - " . $iterator->getFilename() . " (パス: " . $iterator->getPathname() . ")\n";
42
43        // 次の要素に進みます。
44        $iterator->next();
45    }
46
47    echo "イテレーションが完了しました。\n";
48
49    // ループ終了後の valid() の戻り値を確認します。
50    // イテレーションが終了しているため、false が返されるはずです。
51    echo "ループ終了後の valid() の戻り値: " . ($iterator->valid() ? 'true' : 'false') . "\n";
52
53} catch (UnexpectedValueException $e) {
54    // 指定されたパスがディレクトリでない、またはアクセス権がない場合に発生する可能性があります。
55    echo "エラー: ディレクトリ '{$testDirectory}' にアクセスできませんでした。メッセージ: " . $e->getMessage() . "\n";
56} finally {
57    // テスト用に作成したディレクトリとファイルをクリーンアップします。
58    if (is_dir($testDirectory)) {
59        // サブディレクトリ内のファイルを削除し、サブディレクトリを削除します。
60        if (is_dir($testDirectory . '/archive')) {
61            array_map('unlink', glob($testDirectory . '/archive/*'));
62            rmdir($testDirectory . '/archive');
63        }
64        // ルートディレクトリ内のファイルを削除します。
65        array_map('unlink', glob($testDirectory . '/*'));
66        // ルートディレクトリを削除します。
67        rmdir($testDirectory);
68    }
69}

FilesystemIterator::valid() メソッドは、PHPでファイルシステム（ディレクトリなど）を走査する際に、現在の位置が有効な要素を指しているかを確認するために使用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。イテレータがファイルやサブディレクトリのような有効な要素を指している場合は true を返し、ディレクトリの終わりに達するなど、これ以上有効な要素がない場合には false を返します。

提供されたサンプルコードでは、FilesystemIterator を使用して一時的なテストディレクトリを作成し、その中のファイルやサブディレクトリを順番に処理しています。while ($iterator->valid()) という構文で、この valid() メソッドがループの継続条件として使われています。イテレータが次の有効な要素に移動するたびに valid() が呼び出され、有効な要素があれば true が返されてループ内の処理が実行されます。すべての要素を走査し終えると valid() は false を返すため、ループは適切に終了します。このように、valid() メソッドは、ファイルシステムのイテレーションにおいて、現在位置が処理可能な状態にあるかを検証し、安全かつ効率的な処理フローを構築するために不可欠な役割を果たします。

Copy
1<?php
2
3/**
4 * FilesystemIterator::valid() メソッドの動作をデモンストレーションする関数。
5 *
6 * この関数は一時的なディレクトリとファイルを作成し、FilesystemIterator を使用して
7 * ディレクトリ内の要素を走査します。その際、valid() メソッドの戻り値を確認し、
8 * イテレーションが有効な間は true を返し、全ての要素を処理し終えると false を返すことを示します。
9 *
10 * ここでいう「validator」は、イテレータが「有効な状態にあるか」を検証する意味合いで使われます。
11 */
12function demonstrateFilesystemIteratorValid(): void
13{
14    // 1. テスト用のディレクトリとファイルを作成します。
15    // スクリプトが実行されているディレクトリに一時的なディレクトリを作成します。
16    $testDir = __DIR__ . '/temp_iterator_test_dir';
17    if (!is_dir($testDir)) {
18        // ディレクトリが存在しない場合は作成します。`true`で親ディレクトリも作成可能にします。
19        mkdir($testDir, 0777, true);
20        echo "テストディレクトリ '{$testDir}' を作成しました。" . PHP_EOL;
21    }
22
23    // テスト用のファイルをいくつか作成します。
24    file_put_contents($testDir . '/file1.txt', 'コンテンツ1');
25    file_put_contents($testDir . '/file2.txt', 'コンテンツ2');
26    // テスト用のサブディレクトリも作成します。
27    mkdir($testDir . '/subdir', 0777);
28    file_put_contents($testDir . '/subdir/subfile.txt', 'サブコンテンツ');
29
30    echo "\n--- FilesystemIterator::valid() デモンストレーション開始 ---" . PHP_EOL;
31    // 対象となるディレクトリの絶対パスを表示します。
32    echo "対象ディレクトリ: " . realpath($testDir) . PHP_EOL . PHP_EOL;
33
34    try {
35        // 2. FilesystemIterator のインスタンスを作成します。
36        // FilesystemIterator::SKIP_DOTS フラグは、'.' (カレントディレクトリ) と '..' (親ディレクトリ) を
37        // イテレーションの対象からスキップするために使用されます。
38        $iterator = new FilesystemIterator($testDir, FilesystemIterator::SKIP_DOTS);
39
40        // 3. while ループを使用してイテレータを走査し、valid() メソッドの動作を確認します。
41        // valid() メソッドは、イテレータが現在有効な要素を指しているか（イテレーションが続行可能か）を
42        // 真偽値（true または false）で返します。
43        // ループの条件として valid() を使用することで、要素が存在する間だけ処理が繰り返されます。
44        while ($iterator->valid()) {
45            // valid() が true を返している間は、現在の要素にアクセスできます。
46            // current() メソッドは SplFileInfo オブジェクトを返すため、
47            // その getPathname() メソッドを使ってファイルやディレクトリのパスを取得します。
48            echo "✓ valid() は true を返しました。現在の要素: " . $iterator->current()->getPathname() . PHP_EOL;
49            $iterator->next(); // 次の要素へイテレータを進めます。これを忘れると無限ループになります。
50        }
51
52        echo "\n全ての要素を処理し終えました。" . PHP_EOL;
53
54        // ループ終了後、イテレータがもう有効な要素を指していないため、
55        // valid() は false を返すはずです。
56        if (!$iterator->valid()) {
57            echo "✗ valid() は現在 false を返しています。イテレーションは終了しました。" . PHP_EOL;
58        }
59
60    } catch (UnexpectedValueException $e) {
61        // FilesystemIterator のコンストラクタに指定されたパスが存在しない、またはディレクトリではない場合に
62        // UnexpectedValueException が発生することがあります。
63        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
64    } finally {
65        // 4. クリーンアップ処理: 作成したテストディレクトリとファイルを削除します。
66        echo "\n--- クリーンアップ開始 ---" . PHP_EOL;
67        if (is_dir($testDir)) {
68            // recursiveDirectoryRemove ヘルパー関数でディレクトリを安全に再帰的に削除します。
69            if (recursiveDirectoryRemove($testDir)) {
70                echo "テストディレクトリ '{$testDir}' とその内容を削除しました。" . PHP_EOL;
71            } else {
72                echo "テストディレクトリ '{$testDir}' の削除に失敗しました。" . PHP_EOL;
73            }
74        }
75    }
76}
77
78/**
79 * ディレクトリとその内容を再帰的に削除するヘルパー関数。
80 * rmdir() 関数は空のディレクトリしか削除できないため、この関数が必要です。
81 *
82 * @param string $dir 削除するディレクトリのパス。
83 * @return bool 削除に成功した場合は true、失敗した場合は false。
84 */
85function recursiveDirectoryRemove(string $dir): bool
86{
87    if (!is_dir($dir)) {
88        return false;
89    }
90    // ディレクトリ内のファイルとサブディレクトリのリストを取得します。
91    // '.' と '..' は特殊なエントリなので除外します。
92    $files = array_diff(scandir($dir), ['.', '..']);
93    foreach ($files as $file) {
94        $path = $dir . '/' . $file;
95        if (is_dir($path)) {
96            // サブディレクトリの場合、自身を再帰的に呼び出して削除します。
97            recursiveDirectoryRemove($path);
98        } else {
99            // ファイルの場合、unlink() で削除します。
100            unlink($path);
101        }
102    }
103    // 全てのファイルとサブディレクトリが削除されたら、空になったディレクトリを削除します。
104    return rmdir($dir);
105}
106
107
108// 上記で定義したデモンストレーション関数を実行します。
109demonstrateFilesystemIteratorValid();
110
111?>

PHPのFilesystemIterator::valid()メソッドは、ファイルシステムを走査するFilesystemIteratorが、現在有効な要素（ファイルやディレクトリなど）を指しているかを確認するために使用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。

通常、valid()メソッドはwhileループの条件式として利用されます。イテレータがまだ走査すべき次の要素を指している間はtrueを返し、処理を継続できることを示します。一方、全ての要素を処理し終えた後や、有効な要素が存在しない場合にはfalseを返し、イテレーションを終了するべきであることを示します。

サンプルコードでは、一時的なテストディレクトリと複数のファイルを作成し、そのディレクトリに対してFilesystemIteratorを作成しています。while ($iterator->valid())のループでは、valid()がtrueを返す間、現在の要素のパスを表示し、next()メソッドで次の要素へ進みます。これにより、イテレータがディレクトリ内の全ての要素を順に処理していく様子が確認できます。全ての要素が処理し終えられると、valid()はfalseを返すためループは終了し、イテレーションが完了したことが示されます。このように、valid()メソッドはイテレータの状態が「有効であるか」を検証する役割を果たしています。最後に、作成したテスト用のディレクトリとファイルは削除され、クリーンアップされます。