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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator の getFlags() および setFlags() メソッドの使用例を示します。
5 * このコードは、ディレクトリのイテレーション動作を制御するフラグをどのように設定し、
6 * その設定されたフラグをどのように取得するかを初心者にも分かりやすく解説します。
7 */
8function demonstrateRecursiveDirectoryIteratorFlags(): void
9{
10    // サンプルコードを実行するための一時的なディレクトリを作成します。
11    // __DIR__ は現在のスクリプトファイルがあるディレクトリを示します。
12    $tempDir = __DIR__ . '/temp_dir_for_iterator_example';
13
14    // ディレクトリが存在しない場合は作成します。
15    if (!file_exists($tempDir)) {
16        mkdir($tempDir);
17    }
18
19    try {
20        // RecursiveDirectoryIterator のインスタンスを作成します。
21        // 第1引数に操作対象のディレクトリパスを指定します。
22        $iterator = new RecursiveDirectoryIterator($tempDir);
23
24        echo "--- 初期フラグ値の確認 ---\n";
25        // getFlags() メソッドで現在のフラグ値を取得します。
26        // 初期状態では0 (フラグなし) の場合が多いですが、PHPのバージョンや環境により異なる場合があります。
27        $initialFlags = $iterator->getFlags();
28        echo "初期のフラグ値: " . $initialFlags . "\n\n";
29
30        echo "--- フラグの設定 (setFlags) ---\n";
31        // setFlags() メソッドで RecursiveDirectoryIterator の動作を変更するフラグを設定します。
32        // 複数のフラグを設定する場合は、ビットOR演算子 '|' を使用して組み合わせます。
33        //
34        // RecursiveDirectoryIterator::SKIP_DOTS:
35        //   "." (現在のディレクトリ) と ".." (親ディレクトリ) のエントリをスキップします。
36        // RecursiveDirectoryIterator::CURRENT_AS_FILEINFO:
37        //   イテレータの現在の要素を SplFileInfo オブジェクトとして返します。
38        //   (PHP 5.3.0 以降ではこれがデフォルトの動作です)
39        $newFlags = RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::CURRENT_AS_FILEINFO;
40
41        // 設定するフラグの定数値とその説明を表示し、初心者向けに分かりやすくします。
42        echo "設定するフラグ:\n";
43        echo "- SKIP_DOTS (" . RecursiveDirectoryIterator::SKIP_DOTS . "): '.' と '..' をスキップ\n";
44        echo "- CURRENT_AS_FILEINFO (" . RecursiveDirectoryIterator::CURRENT_AS_FILEINFO . "): 要素を SplFileInfo オブジェクトとして扱う\n";
45        echo "これらを組み合わせた値 (ビットOR): " . $newFlags . "\n";
46
47        $iterator->setFlags($newFlags);
48        echo "フラグが設定されました。\n\n";
49
50        echo "--- 設定後のフラグ値の取得 (getFlags) ---\n";
51        // getFlags() メソッドを再度呼び出し、setFlags() で設定した後のフラグ値を取得します。
52        $retrievedFlags = $iterator->getFlags();
53        echo "設定後に取得されたフラグ値: " . $retrievedFlags . "\n\n";
54
55        // 設定したフラグ値と取得したフラグ値が一致するか確認し、結果を表示します。
56        if ($retrievedFlags === $newFlags) {
57            echo "結果: フラグは正しく設定され、取得されました。\n";
58        } else {
59            echo "結果: エラー - 設定したフラグと取得したフラグが一致しません。\n";
60        }
61
62    } catch (UnexpectedValueException $e) {
63        // 指定されたディレクトリが存在しない、またはアクセスできない場合に発生する例外を捕捉します。
64        echo "エラー: " . $e->getMessage() . "\n";
65        echo "ディレクトリ '" . $tempDir . "' の存在とアクセス権を確認してください。\n";
66    } finally {
67        // 実行後に作成した一時ディレクトリを削除します。
68        // rmdir() は空のディレクトリしか削除できません。
69        // 今回はディレクトリ内に何も作成していないため、安全に削除できます。
70        if (file_exists($tempDir) && is_dir($tempDir)) {
71            // ディレクトリが空であることを念のため確認
72            $files = array_diff(scandir($tempDir), array('.', '..'));
73            if (empty($files)) {
74                rmdir($tempDir);
75            }
76        }
77    }
78}
79
80// 上記のデモンストレーション関数を実行します。
81demonstrateRecursiveDirectoryIteratorFlags();

RecursiveDirectoryIteratorクラスは、ディレクトリとそのサブディレクトリを再帰的に走査するための機能を提供します。その中のgetFlags()メソッドは、現在設定されているイテレータの動作を制御するフラグ値を取得するために使用されます。このメソッドは引数を取らずに呼び出され、現在のフラグの状態を表す整数値（int）を返します。

フラグは、ディレクトリ走査時に特定のファイル（例えば.や..）をスキップするかどうかや、各要素をどのようなオブジェクトとして扱うかなどを指定するために利用されます。これらのフラグはsetFlags()メソッドを使って設定され、複数のフラグを組み合わせる場合はビットOR演算子|を使用します。

サンプルコードでは、まずRecursiveDirectoryIteratorオブジェクトの初期フラグ値を取得し、次にsetFlags()メソッドでSKIP_DOTS（.と..をスキップする）とCURRENT_AS_FILEINFO（要素をSplFileInfoオブジェクトとして扱う）というフラグを設定しています。その後、再度getFlags()を呼び出すことで、setFlags()で設定された新しいフラグ値が正確に取得されることを確認しています。このように、getFlags()はイテレータの現在の設定状態を反映した整数値を返します。

Copy
1<?php
2
3// テスト用のディレクトリとファイルを作成するヘルパー関数
4function create_test_directory(string $path): void
5{
6    if (!is_dir($path)) {
7        mkdir($path, 0777, true);
8        file_put_contents($path . '/file1.txt', 'Test content 1');
9        mkdir($path . '/subdir', 0777, true);
10        file_put_contents($path . '/subdir/subfile.txt', 'Subdir content');
11    }
12}
13
14// テスト用のディレクトリとファイルをクリーンアップするヘルパー関数
15function cleanup_test_directory(string $path): void
16{
17    if (is_dir($path)) {
18        $it = new RecursiveIteratorIterator(
19            new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS),
20            RecursiveIteratorIterator::CHILD_FIRST
21        );
22        foreach ($it as $fileinfo) {
23            // ディレクトリ内のファイルとサブディレクトリを削除
24            if ($fileinfo->isDir()) {
25                rmdir($fileinfo->getRealPath());
26            } else {
27                unlink($fileinfo->getRealPath());
28            }
29        }
30        // ルートディレクトリを削除
31        rmdir($path);
32    }
33}
34
35/**
36 * RecursiveDirectoryIterator のフラグを設定 (setFlags) し、
37 * その後取得 (getFlags) する方法を示すサンプルコードです。
38 *
39 * この関数は、一時的なテストディレクトリを作成し、RecursiveDirectoryIterator を用いて
40 * 特定のフラグを設定し、そのフラグ値を取得・表示します。
41 * 設定したフラグがイテレーションにどのように影響するかも示します。
42 */
43function demonstrateRecursiveDirectoryIteratorFlags(): void
44{
45    $testDirPath = __DIR__ . '/recursive_iterator_test_dir';
46
47    // 1. テスト用のディレクトリとファイルを作成
48    create_test_directory($testDirPath);
49
50    echo "--- RecursiveDirectoryIterator のフラグ設定と取得のデモンストレーション ---\n\n";
51
52    try {
53        // 2. RecursiveDirectoryIterator のインスタンスを作成
54        //    初期状態では、デフォルトのフラグが設定されています。
55        $rdi = new RecursiveDirectoryIterator($testDirPath);
56
57        // 3. setFlags() メソッドでフラグを設定します。
58        //    複数のフラグを組み合わせるには、ビット OR (|) 演算子を使用します。
59        //    - RecursiveDirectoryIterator::CURRENT_AS_FILEINFO:
60        //      現在の要素を SplFileInfo オブジェクトとして返します。
61        //      これにより、isDir(), getFilename(), getSize() などのメソッドが利用可能になります。
62        //    - RecursiveDirectoryIterator::SKIP_DOTS:
63        //      特殊なディレクトリ "." (カレントディレクトリ) と ".." (親ディレクトリ) をスキップします。
64        $flagsToSet = RecursiveDirectoryIterator::CURRENT_AS_FILEINFO | RecursiveDirectoryIterator::SKIP_DOTS;
65        $rdi->setFlags($flagsToSet);
66        echo "設定しようとしたフラグ値: " . $flagsToSet . "\n";
67        echo "  (RecursiveDirectoryIterator::CURRENT_AS_FILEINFO | RecursiveDirectoryIterator::SKIP_DOTS)\n";
68
69        // 4. getFlags() メソッドで、現在のイテレータに設定されているフラグ値を取得します。
70        //    戻り値は整数 (int) です。
71        $retrievedFlags = $rdi->getFlags();
72        echo "getFlags() で取得したフラグ値: " . $retrievedFlags . "\n\n";
73
74        // 5. 設定したフラグと取得したフラグが一致するか確認
75        if ($flagsToSet === $retrievedFlags) {
76            echo "✔ フラグは正しく設定され、取得できました。\n";
77        } else {
78            echo "✖ フラグの設定または取得に問題が発生しました。\n";
79        }
80
81        echo "\n--- 設定されたフラグでのイテレーション結果 (CURRENT_AS_FILEINFO と SKIP_DOTS の効果) ---\n";
82        // RecursiveIteratorIterator を使ってディレクトリを再帰的に走査します。
83        // CHILDREN_ONLY フラグは、サブディレクトリ自体は返さず、その子要素のみを返します。
84        $rii = new RecursiveIteratorIterator($rdi, RecursiveIteratorIterator::CHILDREN_ONLY);
85
86        foreach ($rii as $path => $fileInfo) {
87            // CURRENT_AS_FILEINFO が設定されているため、$fileInfo は SplFileInfo オブジェクトです。
88            if ($fileInfo->isDir()) {
89                echo "[DIR] : " . $fileInfo->getFilename() . " (パス: " . $fileInfo->getPathname() . ")\n";
90            } else {
91                echo "[FILE]: " . $fileInfo->getFilename() . " (パス: " . $fileInfo->getPathname() . ", サイズ: " . $fileInfo->getSize() . "バイト)\n";
92            }
93        }
94        echo "\n";
95
96    } catch (UnexpectedValueException $e) {
97        // 指定されたディレクトリが見つからない場合などに発生するエラーを処理
98        echo "エラー: 指定されたディレクトリ '" . $testDirPath . "' が見つからないか、アクセスできません。\n";
99        echo "詳細: " . $e->getMessage() . "\n";
100    } finally {
101        // 6. テスト用のディレクトリとファイルをクリーンアップ
102        cleanup_test_directory($testDirPath);
103        echo "テストディレクトリ '" . $testDirPath . "' をクリーンアップしました。\n";
104    }
105}
106
107// 関数を実行してデモンストレーションを開始します。
108demonstrateRecursiveDirectoryIteratorFlags();

RecursiveDirectoryIteratorは、PHPでディレクトリを再帰的に走査するためのクラスであり、その動作を制御するために「フラグ」と呼ばれるオプションを設定できます。getFlagsメソッドは、このRecursiveDirectoryIteratorインスタンスに現在設定されているフラグの整数値を取得するために使用されます。引数はなく、設定されているフラグがビット演算で結合された単一の整数（int）を戻り値として返します。

サンプルコードでは、まず一時的なディレクトリを作成し、RecursiveDirectoryIteratorのインスタンスを生成します。次に、setFlagsメソッドを用いて、イテレーション中に要素をSplFileInfoオブジェクトとして扱うCURRENT_AS_FILEINFOフラグや、特殊なディレクトリ.と..をスキップするSKIP_DOTSフラグを設定します。

フラグを設定した後、getFlagsメソッドを呼び出すことで、イテレータに現在適用されているフラグの正確な整数値を取得し、設定値と取得値が一致することを確認しています。この取得したフラグ値は、イテレータの挙動を判断するために利用できます。最後に、設定されたフラグの効果として、.や..がスキップされ、ファイルやディレクトリの情報がSplFileInfoオブジェクトとして詳細に取得できる様子が示されており、getFlagsがイテレータの現在の設定状態をプログラムで確認するのに役立つことが分かります。