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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::SKIP_DOTS 定数の動作を示すサンプルコード。
5 *
6 * このコードは、一時ディレクトリを作成し、その中にファイルとサブディレクトリを配置します。
7 * その後、RecursiveDirectoryIterator を使ってディレクトリの内容をリストアップし、
8 * SKIP_DOTS フラグの有無による出力の違いを示します。
9 * 最後に、作成した一時ディレクトリとファイルをクリーンアップします。
10 */
11
12// 一時テストディレクトリのパスを定義
13$testDirPath = __DIR__ . '/temp_directory_for_skip_dots_example';
14
15/**
16 * 指定されたディレクトリとその内容を再帰的に削除するヘルパー関数。
17 *
18 * @param string $dir 削除するディレクトリのパス。
19 */
20function removeDirectory(string $dir): void
21{
22    if (!is_dir($dir)) {
23        return;
24    }
25
26    // ディレクトリ内のアイテムを走査
27    // FilesystemIterator を使用して、ファイルとディレクトリを効率的に取得
28    $items = new FilesystemIterator($dir);
29    foreach ($items as $item) {
30        if ($item->isDir() && !$item->isDot()) {
31            // ドットディレクトリ ('.' や '..') でないサブディレクトリの場合、再帰的に削除
32            removeDirectory($item->getPathname());
33        } elseif ($item->isFile()) {
34            // ファイルの場合、削除
35            unlink($item->getPathname());
36        }
37    }
38    // ディレクトリが空になったら削除
39    rmdir($dir);
40}
41
42// 既存のテストディレクトリがあればクリーンアップ（コードを複数回実行する場合のため）
43removeDirectory($testDirPath);
44
45// 1. テスト用のディレクトリとファイルを作成
46echo "--- テストディレクトリの準備 ---\n";
47// 親ディレクトリもまとめて作成 (recursive: true)
48mkdir($testDirPath, 0777, true); 
49file_put_contents($testDirPath . '/file1.txt', 'これはファイル1の内容です。');
50mkdir($testDirPath . '/sub_dir_a');
51file_put_contents($testDirPath . '/sub_dir_a/file2.txt', 'これはファイル2の内容です。');
52echo "テストディレクトリ '$testDirPath' と内容を作成しました。\n\n";
53
54// 2. RecursiveDirectoryIterator::SKIP_DOTS を使用しない場合
55echo "--- SKIP_DOTS を使用しない場合 (デフォルトの挙動) ---\n";
56echo "  ( '.' (カレントディレクトリ) と '..' (親ディレクトリ) が出力に含まれます )\n";
57try {
58    // RecursiveDirectoryIterator をフラグなしでインスタンス化
59    $iteratorNoSkip = new RecursiveDirectoryIterator($testDirPath);
60    foreach ($iteratorNoSkip as $item) {
61        echo "  " . $item->getPathname() . "\n";
62    }
63} catch (UnexpectedValueException $e) {
64    echo "エラー: ディレクトリを読み込めませんでした - " . $e->getMessage() . "\n";
65}
66echo "\n";
67
68// 3. RecursiveDirectoryIterator::SKIP_DOTS を使用する場合
69echo "--- RecursiveDirectoryIterator::SKIP_DOTS を使用する場合 ---\n";
70echo "  ( '.' と '..' が出力から除外されます )\n";
71try {
72    // RecursiveDirectoryIterator::SKIP_DOTS フラグを指定してインスタンス化
73    $iteratorWithSkip = new RecursiveDirectoryIterator($testDirPath, RecursiveDirectoryIterator::SKIP_DOTS);
74    foreach ($iteratorWithSkip as $item) {
75        echo "  " . $item->getPathname() . "\n";
76    }
77} catch (UnexpectedValueException $e) {
78    echo "エラー: ディレクトリを読み込めませんでした - " . $e->getMessage() . "\n";
79}
80echo "\n";
81
82// 4. テスト用ディレクトリとファイルのクリーンアップ
83echo "--- クリーンアップ ---\n";
84removeDirectory($testDirPath);
85echo "テストディレクトリ '$testDirPath' と内容を削除しました。\n";
86
87?>

このサンプルコードは、PHPのRecursiveDirectoryIterator::SKIP_DOTS定数の使い方と効果を示しています。この定数は、RecursiveDirectoryIteratorクラスを使ってディレクトリの内容を走査する際に、特殊なエントリである「.」（カレントディレクトリ）と「..」（親ディレクトリ）を結果から除外するために使用されます。

SKIP_DOTS定数自体に引数はなく、内部的には整数値（int）として扱われるフラグです。

コードでは、まずテスト用に一時的なディレクトリとファイルを準備します。次に、RecursiveDirectoryIteratorをSKIP_DOTS定数なしで初期化した場合と、SKIP_DOTS定数を指定して初期化した場合とで、それぞれディレクトリの内容をリストアップしています。SKIP_DOTSを使わない場合は「.」と「..」が出力に含まれますが、SKIP_DOTSを使用するとこれらが自動的に除外され、実際のファイルやサブディレクトリのみが表示されることが確認できます。これにより、不要な情報をフィルタリングして、より目的に合ったディレクトリ走査が可能になります。最後に、作成した一時ディレクトリとファイルをクリーンアップしています。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::SKIP_DOTS の使用例を示します。
5 * ディレクトリ内の '.' (カレントディレクトリ) と '..' (親ディレクトリ) エントリを
6 * スキップする方法を実演します。
7 * これは、scandir() 関数が提供するドットスキップ機能と似た挙動を、
8 * RecursiveDirectoryIterator で実現する際に役立ちます。
9 *
10 * @return void
11 */
12function demonstrateRecursiveDirectoryIteratorSkipDots(): void
13{
14    // テスト用の一時ディレクトリパスを定義。スクリプトと同じ階層に作成されます。
15    $testDirPath = __DIR__ . '/temp_recursive_iterator_test_dir';
16
17    // ----------------------------------------------------
18    // テスト用ディレクトリの準備
19    // ----------------------------------------------------
20    // 既存のテストディレクトリがある場合は、その内容を削除し、ディレクトリ自体も削除します。
21    if (file_exists($testDirPath)) {
22        // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して再帰的に削除します。
23        // ここでもSKIP_DOTSを使用することで、削除処理で'.'と'..'を誤って処理しないようにします。
24        $it = new RecursiveDirectoryIterator($testDirPath, RecursiveDirectoryIterator::SKIP_DOTS);
25        $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
26        foreach ($files as $file) {
27            if ($file->isDir()) {
28                rmdir($file->getRealPath()); // ディレクトリを削除
29            } else {
30                unlink($file->getRealPath()); // ファイルを削除
31            }
32        }
33        rmdir($testDirPath); // 空になったルートディレクトリを削除
34    }
35
36    // 新しいテスト用ディレクトリとファイルを作成します。
37    // 0777はテスト用権限です。本番環境ではセキュリティを考慮し、適切な権限を設定してください。
38    mkdir($testDirPath, 0777, true);
39    file_put_contents($testDirPath . '/file1.txt', 'これはファイル1の内容です。');
40    mkdir($testDirPath . '/subdir', 0777);
41    file_put_contents($testDirPath . '/subdir/subfile.txt', 'これはサブディレクトリ内のファイルです。');
42    file_put_contents($testDirPath . '/file2.txt', 'これはファイル2の内容です。');
43
44    echo "--- テスト用ディレクトリ '" . $testDirPath . "' を作成しました。---\n\n";
45
46    // ----------------------------------------------------
47    // RecursiveDirectoryIterator::SKIP_DOTS を使用しない場合
48    // ----------------------------------------------------
49    echo "■ RecursiveDirectoryIterator::SKIP_DOTS を使用しない場合:\n";
50    echo "  ( '.' と '..' エントリも出力されます )\n";
51    try {
52        // RecursiveDirectoryIterator をインスタンス化。SKIP_DOTS フラグは設定しません。
53        // FilesystemIterator::KEY_AS_PATHNAME: イテレータのキーをファイルのフルパス名にする
54        // FilesystemIterator::CURRENT_AS_FILEINFO: イテレータの値を SplFileInfo オブジェクトにする
55        $iteratorWithoutSkipDots = new RecursiveDirectoryIterator(
56            $testDirPath,
57            FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
58        );
59
60        foreach ($iteratorWithoutSkipDots as $path => $fileInfo) {
61            echo "  - " . $fileInfo->getFilename() . " (フルパス: " . $path . ") - " . ($fileInfo->isDir() ? "ディレクトリ" : "ファイル") . "\n";
62        }
63    } catch (UnexpectedValueException $e) {
64        echo "エラー: ディレクトリ '" . $testDirPath . "' にアクセスできません。詳細: " . $e->getMessage() . "\n";
65    }
66    echo "\n";
67
68    // ----------------------------------------------------
69    // RecursiveDirectoryIterator::SKIP_DOTS を使用する場合
70    // ----------------------------------------------------
71    echo "■ RecursiveDirectoryIterator::SKIP_DOTS を使用する場合:\n";
72    echo "  ( '.' と '..' エントリがスキップされます )\n";
73    try {
74        // RecursiveDirectoryIterator をインスタンス化。SKIP_DOTS フラグを設定します。
75        // フラグはビット OR (|) 演算子で複数指定できます。
76        $iteratorWithSkipDots = new RecursiveDirectoryIterator(
77            $testDirPath,
78            FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | RecursiveDirectoryIterator::SKIP_DOTS
79        );
80
81        foreach ($iteratorWithSkipDots as $path => $fileInfo) {
82            echo "  - " . $fileInfo->getFilename() . " (フルパス: " . $path . ") - " . ($fileInfo->isDir() ? "ディレクトリ" : "ファイル") . "\n";
83        }
84    } catch (UnexpectedValueException $e) {
85        echo "エラー: ディレクトリ '" . $testDirPath . "' にアクセスできません。詳細: " . $e->getMessage() . "\n";
86    }
87    echo "\n";
88
89    // ----------------------------------------------------
90    // テスト用ディレクトリのクリーンアップ
91    // ----------------------------------------------------
92    echo "--- テスト用ディレクトリをクリーンアップ中... ---\n";
93    // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して再帰的に削除します。
94    // ここでもSKIP_DOTSを使用することで、削除処理で'.'と'..'を誤って処理しないようにします。
95    $it = new RecursiveDirectoryIterator($testDirPath, RecursiveDirectoryIterator::SKIP_DOTS);
96    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
97    foreach ($files as $file) {
98        if ($file->isDir()) {
99            rmdir($file->getRealPath());
100        } else {
101            unlink($file->getRealPath());
102        }
103    }
104    rmdir($testDirPath); // 空になったルートディレクトリを削除
105    echo "--- テスト用ディレクトリ '" . $testDirPath . "' を削除しました。---\n";
106}
107
108// サンプルコードを実行します。
109demonstrateRecursiveDirectoryIteratorSkipDots();

RecursiveDirectoryIterator::SKIP_DOTSは、PHPのRecursiveDirectoryIteratorクラスで使用する定数（フラグ）です。この定数は引数を取らず、整数値（int型）を返します。その主な役割は、ディレクトリを走査する際に、特殊なエントリである「.」（カレントディレクトリ）と「..」（親ディレクトリ）を自動的にスキップすることです。これは、scandir()関数が提供するドットエントリのスキップ機能と似ており、再帰的なファイルシステム操作においてこれらの不要なエントリを処理しないようにするために役立ちます。

サンプルコードでは、まず一時的なテスト用ディレクトリを作成し、その中にファイルやサブディレクトリを配置します。次に、RecursiveDirectoryIteratorのインスタンスを生成する際に、このSKIP_DOTSフラグを指定しない場合と指定した場合で、ディレクトリの内容を列挙し、その違いを比較しています。フラグを指定しない場合は「.」と「..」のエントリも出力されますが、SKIP_DOTSを指定するとこれらが自動的に除外され、実際のファイルやサブディレクトリのみが結果として表示されます。これにより、余分なエントリを意識せずに目的の項目のみを効率的に処理するコードを簡単に記述できるようになります。最後に、作成したテスト用ディレクトリは適切に削除され、クリーンな状態に戻ります。