【PHP8.x】FilesystemIterator::SKIP_DOTS定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容を再帰的に削除します。
5 * FilesystemIterator::SKIP_DOTS のデモンストレーションで使用する一時ディレクトリのクリーンアップに利用します。
6 *
7 * @param string $dir 削除するディレクトリのパス
8 */
9function deleteDirectoryRecursively(string $dir): void
10{
11    // 指定されたパスがディレクトリでなければ何もしません。
12    if (!is_dir($dir)) {
13        return;
14    }
15
16    // ディレクトリ内のすべてのファイルとサブディレクトリを取得します。
17    // '.' (カレントディレクトリ) と '..' (親ディレクトリ) は結果から除外します。
18    $items = array_diff(scandir($dir) ?: [], ['.', '..']);
19
20    foreach ($items as $item) {
21        $path = $dir . DIRECTORY_SEPARATOR . $item;
22        if (is_dir($path)) {
23            // サブディレクトリの場合は、この関数を再帰的に呼び出して削除します。
24            deleteDirectoryRecursively($path);
25        } else {
26            // ファイルの場合は、unlink() 関数で削除します。
27            unlink($path);
28        }
29    }
30
31    // ディレクトリが空になったら、rmdir() 関数で削除します。
32    rmdir($dir);
33}
34
35/**
36 * FilesystemIterator::SKIP_DOTS を使用してディレクトリの内容を走査する例を示します。
37 * このフラグを使用すると、'.' (カレントディレクトリ) と '..' (親ディレクトリ) のエントリがスキップされます。
38 */
39function demonstrateFilesystemIteratorSkipDots(): void
40{
41    echo "--- FilesystemIterator::SKIP_DOTS のデモンストレーション ---" . PHP_EOL;
42
43    // 1. テスト用の作業ディレクトリを作成します。
44    // システムの一時ディレクトリ内に、ユニークな名前でディレクトリを作成します。
45    $testDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iterator_test_' . uniqid();
46    if (!mkdir($testDir) && !is_dir($testDir)) {
47        echo "エラー: テストディレクトリの作成に失敗しました。" . PHP_EOL;
48        return;
49    }
50    echo "テストディレクトリを作成しました: " . $testDir . PHP_EOL;
51
52    // 2. 作成したディレクトリ内にテスト用のファイルとサブディレクトリを作成します。
53    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはテストファイルです。');
54    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'report.pdf', 'テストレポート。');
55    mkdir($testDir . DIRECTORY_SEPARATOR . 'images');
56    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png', '画像データ');
57
58    echo PHP_EOL . "--- 作成されたディレクトリコンテンツ (scandir で確認) ---" . PHP_EOL;
59    // scandir() 関数は、常に '.' と '..' のエントリを含みます。
60    foreach (scandir($testDir) as $item) {
61        echo "- " . $item . PHP_EOL;
62    }
63
64    echo PHP_EOL . "--- FilesystemIterator::SKIP_DOTS を使用してディレクトリを走査 ---" . PHP_EOL;
65    echo "（この方法では '.' と '..' のエントリはスキップされます）" . PHP_EOL;
66
67    try {
68        // FilesystemIterator をインスタンス化し、第二引数に FilesystemIterator::SKIP_DOTS フラグを指定します。
69        // これにより、イテレータは '.' と '..' のエントリを返さなくなります。
70        $iterator = new FilesystemIterator($testDir, FilesystemIterator::SKIP_DOTS);
71
72        // イテレータを使ってディレクトリ内の各エントリをループ処理します。
73        // $fileInfo は SplFileInfo クラスのインスタンスで、ファイルに関する情報を提供します。
74        foreach ($iterator as $fileInfo) {
75            echo "  - " . $fileInfo->getFilename(); // 現在のエントリのファイル名またはディレクトリ名を取得
76
77            // エントリがディレクトリかファイルかを判断して表示します。
78            if ($fileInfo->isDir()) {
79                echo " (ディレクトリ)";
80            } elseif ($fileInfo->isFile()) {
81                echo " (ファイル)";
82            }
83            echo PHP_EOL;
84        }
85    } catch (UnexpectedValueException $e) {
86        // 指定されたパスが存在しない、またはディレクトリでない場合などにこの例外が発生する可能性があります。
87        echo "エラー: ディレクトリの読み込み中に問題が発生しました: " . $e->getMessage() . PHP_EOL;
88    } finally {
89        // 3. デモンストレーション後、テスト用のディレクトリと作成したコンテンツをクリーンアップします。
90        echo PHP_EOL . "テストディレクトリをクリーンアップ中..." . PHP_EOL;
91        deleteDirectoryRecursively($testDir);
92        echo "クリーンアップが完了しました。" . PHP_EOL;
93    }
94}
95
96// デモンストレーション関数を実行します。
97demonstrateFilesystemIteratorSkipDots();

このPHPサンプルコードは、FilesystemIterator::SKIP_DOTS定数の使い方を示しています。FilesystemIteratorクラスは、指定されたディレクトリの内容を効率的に反復処理するための機能を提供します。SKIP_DOTSは、このイテレータの動作を制御するフラグの一つで、引数や戻り値はなく、FilesystemIteratorの挙動を制御するフラグとして使用します。

具体的には、この定数をFilesystemIteratorのコンストラクタに指定すると、ディレクトリを走査する際に通常含まれる「.`」（カレントディレクトリ）と「..」（親ディレクトリ）という特殊なエントリが自動的にスキップされます。これにより、実際のファイルやサブディレクトリだけを処理対象とすることができ、コードを簡潔に保てます。

サンプルコードでは、まず一時的なテストディレクトリを作成し、ファイルとサブディレクトリを配置しています。次に、scandir関数で通常のディレクトリ内容（.と..を含む）を表示した後、FilesystemIterator::SKIP_DOTSフラグを付けてイテレータを作成し、ディレクトリ内容を走査しています。これにより、「.`」と「..」がスキップされ、実際のコンテンツのみがリストアップされることを確認できます。最後に、作成したテストディレクトリはクリーンアップされています。

Copy
1<?php
2
3/**
4 * PHPのFilesystemIterator::SKIP_DOTS定数の使用例と、
5 * scandir()関数との比較を示します。
6 *
7 * この関数は、一時的なディレクトリを作成し、その内容を
8 * FilesystemIterator::SKIP_DOTSオプションを使用してリスト表示します。
9 * これにより、カレントディレクトリ(.)と親ディレクトリ(..)のエントリが
10 * 自動的にスキップされることを示します。
11 *
12 * また、比較としてscandir()関数の結果も表示し、
13 * ドットディレクトリがどのように扱われるかの違いを理解しやすくします。
14 *
15 * @return void
16 */
17function demonstrateFilesystemIteratorSkipDotsAndScandirComparison(): void
18{
19    // 1. テスト用のディレクトリとファイルを作成します。
20    $testDir = 'temp_test_dir_' . uniqid(); // 一意な名前で一時ディレクトリを作成
21    if (!mkdir($testDir) && !is_dir($testDir)) {
22        echo "エラー: テストディレクトリ '{$testDir}' の作成に失敗しました。\n";
23        return;
24    }
25
26    file_put_contents($testDir . '/file1.txt', 'Content for file1.');
27    file_put_contents($testDir . '/file2.txt', 'Content for file2.');
28    mkdir($testDir . '/subdir_a'); // テスト用のサブディレクトリも作成
29
30    echo "--- ディレクトリ '{$testDir}' の内容リスト ---\n";
31
32    // 2. FilesystemIterator::SKIP_DOTS を使用した場合
33    echo "\n[FilesystemIterator::SKIP_DOTS を使用した結果]\n";
34    echo "カレントディレクトリ(.)と親ディレクトリ(..)は自動的にスキップされます。\n";
35    try {
36        // FilesystemIterator に FilesystemIterator::SKIP_DOTS フラグを渡します。
37        // これにより、ディレクトリ内の '.' と '..' エントリが結果から除外されます。
38        $iterator = new FilesystemIterator($testDir, FilesystemIterator::SKIP_DOTS);
39
40        foreach ($iterator as $fileInfo) {
41            echo "  - " . $fileInfo->getFilename();
42            if ($fileInfo->isDir()) {
43                echo " (ディレクトリ)\n";
44            } else {
45                echo " (ファイル)\n";
46            }
47        }
48    } catch (UnexpectedValueException $e) {
49        echo "エラー: FilesystemIteratorの初期化に失敗しました。({$e->getMessage()})\n";
50    }
51
52    // 3. 比較として scandir() 関数を使用した場合
53    echo "\n[scandir() を使用した結果]\n";
54    echo "カレントディレクトリ(.)と親ディレクトリ(..)が含まれます。\n";
55    $scandirResult = scandir($testDir);
56    if ($scandirResult === false) {
57        echo "エラー: scandir()でディレクトリの内容を読み込めませんでした。\n";
58    } else {
59        foreach ($scandirResult as $item) {
60            echo "  - " . $item . "\n";
61        }
62    }
63
64    // 4. テスト後に作成したディレクトリとファイルをクリーンアップします。
65    echo "\n--- クリーンアップ ---\n";
66    try {
67        // FilesystemIterator はデフォルトで '.' と '..' をスキップするため、
68        // クリーンアップ処理でそれらを気にせずループできます。
69        $cleanIterator = new FilesystemIterator($testDir);
70        foreach ($cleanIterator as $file) {
71            if ($file->isDir()) {
72                // サブディレクトリが空の場合のみ削除できます。
73                // より複雑な削除には再帰的な処理が必要です。
74                rmdir($file->getPathname());
75            } else {
76                unlink($file->getPathname()); // ファイルを削除
77            }
78        }
79        rmdir($testDir); // 空になったテストディレクトリを削除
80        echo "テストディレクトリ '{$testDir}' をクリーンアップしました。\n";
81    } catch (Throwable $e) {
82        echo "エラー: クリーンアップ中に問題が発生しました。({$e->getMessage()})\n";
83    }
84}
85
86// 関数の実行
87demonstrateFilesystemIteratorSkipDotsAndScandirComparison();

このサンプルコードは、PHPのFilesystemIteratorクラスで利用できるSKIP_DOTS定数の使い方を、scandir()関数との比較を通じて具体的に示しています。FilesystemIterator::SKIP_DOTSは、ディレクトリの内容を反復処理する際に、特殊なディレクトリであるカレントディレクトリ（.）と親ディレクトリ（..）を自動的にスキップするための定数です。引数はなく、戻り値もありません。

コードでは、まず一時的なテストディレクトリを作成し、その中にいくつかのファイルとサブディレクトリを配置します。次に、FilesystemIteratorをインスタンス化する際にFilesystemIterator::SKIP_DOTSフラグを渡してディレクトリの内容をリスト表示します。この場合、.と..は出力に含まれず、作成したファイルやサブディレクトリ名のみが表示されるため、不要なエントリをフィルタリングする手間なく実際のコンテンツに集中して処理を進められます。

比較のため、PHPの標準関数であるscandir()でも同じディレクトリの内容をリスト表示しています。scandir()の出力にはデフォルトで.と..が含まれるため、FilesystemIterator::SKIP_DOTSを使用した場合との違いが明確に理解できます。この定数を用いることで、ファイルシステムの操作がより簡潔かつ効率的に行えるようになります。最後に、作成したテストディレクトリとファイルを適切にクリーンアップしています。