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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator の setFlags メソッドの使用例を示します。
5 *
6 * setFlags メソッドは、イテレータの挙動を制御するフラグを設定するために使用されます。
7 * 例えば、隠しファイルやディレクトリ（'.' と '..' など）をスキップするか、
8 * イテレータが返す要素の形式（ファイル情報オブジェクトか、単なるパス文字列か）を
9 * 設定することができます。
10 *
11 * この関数は、指定されたパスに一時的なディレクトリとファイルを作成し、
12 * setFlags の異なる設定でディレクトリを走査する様子をデモンストレーションし、
13 * 最後に作成した一時ファイルをクリーンアップします。
14 *
15 * @param string $directoryPath 走査およびテスト用のディレクトリのパス
16 * @return void
17 */
18function demonstrateRecursiveDirectoryIteratorSetFlags(string $directoryPath): void
19{
20    echo "--- RecursiveDirectoryIterator::setFlags のデモンストレーション ---\n\n";
21
22    // 存在しないディレクトリの場合は作成
23    if (!is_dir($directoryPath)) {
24        mkdir($directoryPath, 0777, true);
25        echo "テストディレクトリ '{$directoryPath}' を作成しました。\n";
26    }
27
28    // テスト用のファイルとディレクトリを作成
29    $testFiles = [
30        $directoryPath . '/file1.txt' => 'Content of file1',
31        $directoryPath . '/.hidden_file.txt' => 'Content of hidden file', // ドットファイル
32        $directoryPath . '/subdir', // サブディレクトリ
33        $directoryPath . '/subdir/file2.txt' => 'Content of file2',
34    ];
35
36    foreach ($testFiles as $path => $content) {
37        if (is_string($content)) {
38            file_put_contents($path, $content);
39        } else {
40            mkdir($path, 0777, true);
41        }
42    }
43    echo "テスト用のファイルとディレクトリを作成しました。\n\n";
44
45    // ---------------------------------------------------------------------
46    // RecursiveDirectoryIterator 単体での setFlags の挙動
47    // (現在のディレクトリの直接の子要素のみを走査)
48    // ---------------------------------------------------------------------
49
50    // 1. RecursiveDirectoryIterator 単体でのデフォルトの挙動
51    //    (CURRENT_AS_FILEINFO | SKIP_DOTS)
52    echo "--- 1. RecursiveDirectoryIterator 単体 (デフォルト設定) ---\n";
53    echo "  - 要素は SplFileInfo オブジェクトとして取得されます。\n";
54    echo "  - '.' と '..' はスキップされます。\n";
55    try {
56        $iterator = new RecursiveDirectoryIterator($directoryPath);
57        // setFlags を明示的に呼び出さなくても、これがデフォルトの挙動です。
58        // $iterator->setFlags(RecursiveDirectoryIterator::CURRENT_AS_FILEINFO | RecursiveDirectoryIterator::SKIP_DOTS);
59
60        echo "  直接の子要素:\n";
61        foreach ($iterator as $path => $fileinfo) {
62            echo "    パス: " . $path . " -> ファイル名: " . $fileinfo->getFilename() . "\n";
63        }
64    } catch (UnexpectedValueException $e) {
65        echo "エラー: " . $e->getMessage() . "\n";
66    }
67    echo "\n";
68
69    // 2. RecursiveDirectoryIterator 単体でドットファイルをスキップしない設定
70    //    (SKIP_DOTS フラグを無効化)
71    echo "--- 2. RecursiveDirectoryIterator 単体 (SKIP_DOTS を無効化) ---\n";
72    echo "  - 要素は SplFileInfo オブジェクトとして取得されます。\n";
73    echo "  - '.' と '..' が含まれます。\n";
74    try {
75        $iterator = new RecursiveDirectoryIterator($directoryPath);
76        // SKIP_DOTS を設定しない (または 0 を指定して無効にする) ことで、
77        // ドットファイルや隠しファイルも表示されるようになります。
78        $iterator->setFlags(RecursiveDirectoryIterator::CURRENT_AS_FILEINFO);
79
80        echo "  直接の子要素 (ドットファイルを含む):\n";
81        foreach ($iterator as $path => $fileinfo) {
82            echo "    パス: " . $path . " -> ファイル名: " . $fileinfo->getFilename() . "\n";
83        }
84    } catch (UnexpectedValueException $e) {
85        echo "エラー: " . $e->getMessage() . "\n";
86    }
87    echo "\n";
88
89    // ---------------------------------------------------------------------
90    // RecursiveIteratorIterator と組み合わせた setFlags の挙動
91    // (ディレクトリを再帰的に走査)
92    // ---------------------------------------------------------------------
93
94    // 3. RecursiveIteratorIterator と組み合わせたデフォルトの挙動
95    //    (CURRENT_AS_FILEINFO | SKIP_DOTS)
96    echo "--- 3. RecursiveIteratorIterator と組み合わせ (デフォルト設定) ---\n";
97    echo "  - ディレクトリを再帰的に走査します。\n";
98    echo "  - 要素は SplFileInfo オブジェクトとして取得されます。\n";
99    echo "  - '.' と '..' はスキップされます。\n";
100    try {
101        $iterator = new RecursiveDirectoryIterator($directoryPath);
102        $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::SELF_FIRST);
103
104        echo "  再帰的に走査された要素:\n";
105        foreach ($recursiveIterator as $path => $fileinfo) {
106            echo "    パス: " . $path . " -> ファイル名: " . $fileinfo->getFilename() . "\n";
107            echo "      タイプ: " . ($fileinfo->isDir() ? 'ディレクトリ' : 'ファイル') . "\n";
108        }
109    } catch (UnexpectedValueException $e) {
110        echo "エラー: " . $e->getMessage() . "\n";
111    }
112    echo "\n";
113
114    // 4. RecursiveIteratorIterator と組み合わせ、パス名として要素を取得する設定
115    //    (CURRENT_AS_PATHNAME)
116    echo "--- 4. RecursiveIteratorIterator と組み合わせ (CURRENT_AS_PATHNAME) ---\n";
117    echo "  - ディレクトリを再帰的に走査します。\n";
118    echo "  - 要素はパス文字列として取得されます。\n";
119    echo "  - '.' と '..' はスキップされます。\n";
120    try {
121        $iterator = new RecursiveDirectoryIterator($directoryPath);
122        // setFlags で CURRENT_AS_PATHNAME を指定すると、イテレータは SplFileInfo オブジェクトの代わりに
123        // ファイルまたはディレクトリのパス名 (文字列) を返します。
124        $iterator->setFlags(RecursiveDirectoryIterator::CURRENT_AS_PATHNAME | RecursiveDirectoryIterator::SKIP_DOTS);
125        $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::SELF_FIRST);
126
127        echo "  再帰的に走査された要素 (パス名として取得):\n";
128        foreach ($recursiveIterator as $path => $pathname) {
129            echo "    パス: " . $path . " -> 取得された値: " . $pathname . "\n";
130        }
131    } catch (UnexpectedValueException $e) {
132        echo "エラー: " . $e->getMessage() . "\n";
133    }
134    echo "\n";
135
136
137    // クリーンアップ: 作成した一時ディレクトリとファイルを削除します。
138    echo "--- クリーンアップ ---\n";
139    // ディレクトリとその内容を再帰的に削除します。
140    // RecursiveDirectoryIterator::SKIP_DOTS を指定することで、'.' と '..' を
141    // 削除処理の対象から外して安全にクリーンアップします。
142    $files = new RecursiveIteratorIterator(
143        new RecursiveDirectoryIterator($directoryPath, RecursiveDirectoryIterator::SKIP_DOTS),
144        RecursiveIteratorIterator::CHILD_FIRST
145    );
146
147    foreach ($files as $fileinfo) {
148        if ($fileinfo->isDir()) {
149            rmdir($fileinfo->getRealPath());
150        } else {
151            unlink($fileinfo->getRealPath());
152        }
153    }
154    rmdir($directoryPath); // 最上位のディレクトリを削除
155    echo "一時ディレクトリ '{$directoryPath}' とその内容を削除しました。\n";
156}
157
158// スクリプトが直接実行された場合にデモンストレーション関数を呼び出します。
159// 一時ディレクトリ名に一意なIDを付与し、他の実行と競合しないようにします。
160if (php_sapi_name() === 'cli') {
161    $tempDir = __DIR__ . '/temp_test_dir_' . uniqid();
162    demonstrateRecursiveDirectoryIteratorSetFlags($tempDir);
163}
164

PHPのRecursiveDirectoryIterator::setFlagsメソッドは、ディレクトリを走査するイテレータの挙動を細かく制御するために使用されます。このメソッドはint $flagsという単一の引数を受け取ります。この$flagsには、複数の定数をビット論理和（|）で組み合わせて指定することで、イテレータの動作を設定します。例えば、特殊なディレクトリである「.」（カレントディレクトリ）や「..」（親ディレクトリ）をスキップするかどうか、またはイテレータが返す要素をファイル情報オブジェクト（SplFileInfo）として取得するか、単なるパス名文字列として取得するかなどを設定できます。このメソッドはオブジェクトの状態を変更するだけで、戻り値はありません。

サンプルコードでは、一時的なディレクトリとファイルを作成し、setFlagsメソッドで異なるフラグを設定した場合のディレクトリ走査結果の変化を具体的に示しています。RecursiveDirectoryIterator::SKIP_DOTSフラグを指定しないことで隠しファイルや.、..が表示されるようになることや、RecursiveDirectoryIterator::CURRENT_AS_PATHNAMEフラグによって要素がパス文字列として取得される様子を確認できます。これにより、システムの要件に合わせて柔軟なファイルやディレクトリの操作が可能になることを理解いただけます。