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

Copy
1<?php
2
3/**
4 * 一時ディレクトリとテスト用のファイル、サブディレクトリを作成します。
5 *
6 * @return string 作成された一時ディレクトリのパス。
7 */
8function createTestDirectory(): string
9{
10    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_rdit_test_' . uniqid();
11    if (!mkdir($tempDir, 0777, true)) {
12        die("テストディレクトリの作成に失敗しました: {$tempDir}\n");
13    }
14
15    // テストファイルを作成
16    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'これは最初のファイルです。');
17    
18    // サブディレクトリとそこに含まれるファイルを作成
19    $subDir = $tempDir . DIRECTORY_SEPARATOR . 'subdir';
20    mkdir($subDir);
21    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'file2.log', 'これはログファイルです。');
22    
23    // 空のサブディレクトリも作成
24    mkdir($tempDir . DIRECTORY_SEPARATOR . 'empty_dir');
25
26    return $tempDir;
27}
28
29/**
30 * 指定されたディレクトリとその内容を再帰的に削除します。
31 *
32 * @param string $dir 削除するディレクトリのパス。
33 */
34function cleanupTestDirectory(string $dir): void
35{
36    if (!is_dir($dir)) {
37        return;
38    }
39    // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して、子要素から順に削除します。
40    // SKIP_DOTS フラグは "." と ".." ディレクトリをスキップするために重要です。
41    $it = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS);
42    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
43    
44    foreach ($files as $file) {
45        if ($file->isDir()) {
46            rmdir($file->getPathname()); // ディレクトリを削除
47        } else {
48            unlink($file->getPathname()); // ファイルを削除
49        }
50    }
51    rmdir($dir); // 最上位のディレクトリを削除
52}
53
54/**
55 * RecursiveDirectoryIterator::CURRENT_AS_FILEINFO 定数の動作をデモンストレーションします。
56 * この定数を使用することで、イテレータの current() メソッドが SplFileInfo オブジェクトを返すようになります。
57 *
58 * @param string $basePath 走査するディレクトリのベースパス。
59 */
60function demonstrateRecursiveDirectoryIteratorCurrentAsFileInfo(string $basePath): void
61{
62    echo "--- RecursiveDirectoryIterator::CURRENT_AS_FILEINFO フラグなしの場合 ---\n";
63    echo "この場合、current() メソッドは要素のフルパスを表す『文字列』を返します。\n";
64    echo "------------------------------------------------------------------------\n";
65    try {
66        // SKIP_DOTS はカレントディレクトリ(.)と親ディレクトリ(..)のエントリをスキップします。
67        $iterator = new RecursiveDirectoryIterator(
68            $basePath,
69            RecursiveDirectoryIterator::SKIP_DOTS
70        );
71        // RecursiveIteratorIterator を使用して、ディレクトリを再帰的に走査します。
72        $recursiveIterator = new RecursiveIteratorIterator($iterator);
73
74        $count = 0;
75        foreach ($recursiveIterator as $path => $entry) {
76            echo "要素パス (キー): {$path}\n";
77            echo "current() の戻り値の型: " . gettype($entry) . "\n";
78            echo "current() の戻り値 (文字列パス): " . $entry . "\n";
79            echo "------------------------------\n";
80            $count++;
81            if ($count >= 2) { // 最初の2つの要素で動作を示すため、ここで停止
82                break;
83            }
84        }
85    } catch (UnexpectedValueException $e) {
86        echo "エラーが発生しました: " . $e->getMessage() . "\n";
87    }
88
89    echo "\n--- RecursiveDirectoryIterator::CURRENT_AS_FILEINFO フラグを使用した場合 ---\n";
90    echo "このフラグを指定すると、current() メソッドは『SplFileInfo オブジェクト』を返します。\n";
91    echo "SplFileInfo オブジェクトを使うと、ファイルやディレクトリの情報を取得する様々な便利なメソッドが利用できます。\n";
92    echo "------------------------------------------------------------------------------------\n";
93    try {
94        // CURRENT_AS_FILEINFO フラグを追加して RecursiveDirectoryIterator を作成
95        $iteratorWithFileInfo = new RecursiveDirectoryIterator(
96            $basePath,
97            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::CURRENT_AS_FILEINFO
98        );
99        $recursiveIteratorWithFileInfo = new RecursiveIteratorIterator($iteratorWithFileInfo);
100
101        $count = 0;
102        foreach ($recursiveIteratorWithFileInfo as $path => $fileInfo) {
103            echo "要素パス (キー): {$path}\n";
104            echo "current() の戻り値の型: " . gettype($fileInfo) . "\n";
105            echo "SplFileInfo オブジェクトであるか: " . ( $fileInfo instanceof SplFileInfo ? 'はい' : 'いいえ' ) . "\n";
106            
107            // SplFileInfo オブジェクトのメソッドを使用して詳細情報を取得
108            echo "ファイル名: " . $fileInfo->getFilename() . "\n";
109            echo "フルパス: " . $fileInfo->getPathname() . "\n";
110            echo "ディレクトリか: " . ($fileInfo->isDir() ? 'はい' : 'いいえ') . "\n";
111            echo "ファイルか: " . ($fileInfo->isFile() ? 'はい' : 'いいえ') . "\n";
112            echo "最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
113            echo "------------------------------\n";
114            $count++;
115            if ($count >= 2) { // 最初の2つの要素で動作を示すため、ここで停止
116                break;
117            }
118        }
119    } catch (UnexpectedValueException $e) {
120        echo "エラーが発生しました: " . $e->getMessage() . "\n";
121    }
122}
123
124// スクリプトの実行開始
125$testDirectoryPath = createTestDirectory(); // テストディレクトリを作成
126try {
127    // 定数の動作をデモンストレーションする関数を実行
128    demonstrateRecursiveDirectoryIteratorCurrentAsFileInfo($testDirectoryPath);
129} finally {
130    // スクリプトの実行が完了した後、必ず一時ディレクトリをクリーンアップ
131    cleanupTestDirectory($testDirectoryPath);
132    echo "\nテストディレクトリ ({$testDirectoryPath}) をクリーンアップしました。\n";
133}
134

RecursiveDirectoryIterator::CURRENT_AS_FILEINFOは、PHPのRecursiveDirectoryIteratorクラスで使用される定数です。この定数自体に特定の引数や戻り値はありませんが、RecursiveDirectoryIteratorのコンストラクタにフラグとして渡すことで、ディレクトリを走査する際の挙動を制御します。

通常、RecursiveDirectoryIteratorやそれを基にしたRecursiveIteratorIteratorを使ってディレクトリ内の要素をループ処理する際、current()メソッドは現在処理中のファイルやディレクトリのフルパスを表す「文字列」を返します。この文字列からファイル名や属性などの情報を取得するには、別途PHPのファイルシステム関数を用いる必要があります。

しかし、RecursiveDirectoryIterator::CURRENT_AS_FILEINFO定数をRecursiveDirectoryIteratorのコンストラクタの第二引数（フラグ）に含めて指定すると、current()メソッドは「SplFileInfoオブジェクト」を返すようになります。SplFileInfoオブジェクトは、ファイル名、パス、最終更新日時、ファイルの種類（ディレクトリかファイルか）など、ファイルやディレクトリに関する詳細な情報を取得するための便利なメソッドを多数持っています。これにより、ファイルシステムを操作するコードをより簡潔かつ効率的に記述できるようになります。

サンプルコードは、この定数の有無によってRecursiveDirectoryIteratorのcurrent()メソッドが返す値の型が文字列からSplFileInfoオブジェクトへと変化し、その結果、ファイル情報を取得する手法がどのように変わるかを具体的に示しています。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::CURRENT_AS_FILEINFO 定数の使用例を示します。
5 *
6 * この定数を使用すると、RecursiveDirectoryIterator が返す各要素が
7 * ファイルパスの文字列ではなく、SplFileInfo オブジェクトになります。
8 * SplFileInfo オブジェクトは、ファイル名、サイズ、更新日時、タイプなどの
9 * 豊富なファイル情報にアクセスするための便利なメソッドを提供します。
10 *
11 * 例として、スクリプトの実行ディレクトリ内に一時的なディレクトリ構造を作成し、
12 * それを走査してファイル情報を表示します。
13 */
14function demonstrateRecursiveDirectoryIteratorWithFileInfo(): void
15{
16    // --- 1. テスト用のディレクトリとファイルを準備 ---
17    // スクリプトが単体で動作し、結果が予測可能であることを保証するため、
18    // 一時的なディレクトリを作成し、サンプルデータを配置します。
19    $testDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_recursive_dir_example';
20
21    // 既存のテストディレクトリがある場合は、一度クリーンアップします (念のため)。
22    if (is_dir($testDir)) {
23        // ディレクトリを再帰的に削除するためのイテレータ
24        $cleanupIterator = new RecursiveIteratorIterator(
25            new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
26            RecursiveIteratorIterator::CHILD_FIRST // 子要素から削除するためにCHILD_FIRSTを指定
27        );
28        foreach ($cleanupIterator as $item) {
29            if ($item->isDir()) {
30                rmdir($item->getPathname()); // ディレクトリが空になったら削除
31            } else {
32                unlink($item->getPathname()); // ファイルを削除
33            }
34        }
35        rmdir($testDir); // ルートディレクトリを削除
36    }
37
38    // 新しいディレクトリ構造の作成
39    mkdir($testDir, 0777, true); // true を指定することで、親ディレクトリも同時に作成
40    mkdir($testDir . DIRECTORY_SEPARATOR . 'subdir1');
41    mkdir($testDir . DIRECTORY_SEPARATOR . 'subdir2');
42    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file1');
43    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'subdir1' . DIRECTORY_SEPARATOR . 'file2.txt', 'Content for file2');
44    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'script.php', '<?php echo "Hello from PHP script!";');
45
46    echo "--- RecursiveDirectoryIterator::CURRENT_AS_FILEINFO 使用例 ---\n";
47    echo "テストディレクトリ: {$testDir}\n\n";
48
49    try {
50        // --- 2. RecursiveDirectoryIterator をインスタンス化 ---
51        // RecursiveDirectoryIterator::CURRENT_AS_FILEINFO 定数をOR演算子 (|) で指定することで、
52        // イテレータが各要素を SplFileInfo オブジェクトとして返します。
53        // RecursiveDirectoryIterator::SKIP_DOTS は、'.' (カレントディレクトリ) と '..' (親ディレクトリ) の
54        // エントリをスキップするために使用します。
55        $directoryIterator = new RecursiveDirectoryIterator(
56            $testDir,
57            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::CURRENT_AS_FILEINFO
58        );
59
60        // RecursiveIteratorIterator でラップすることで、サブディレクトリも再帰的に走査します。
61        // RecursiveIteratorIterator::SELF_FIRST は、親ディレクトリ自体を走査対象に含めることを意味します。
62        $recursiveIterator = new RecursiveIteratorIterator(
63            $directoryIterator,
64            RecursiveIteratorIterator::SELF_FIRST
65        );
66
67        // --- 3. ディレクトリを走査し、ファイル情報を表示 ---
68        foreach ($recursiveIterator as $fileInfo) {
69            // $fileInfo は SplFileInfo のインスタンスなので、そのメソッドを使って情報にアクセスできます。
70            // getDepth() は現在のディレクトリの深さを返します。
71            $indent = str_repeat('  ', $recursiveIterator->getDepth());
72
73            if ($fileInfo->isDir()) {
74                echo $indent . "[D] " . $fileInfo->getFilename() . " (パス: " . $fileInfo->getPathname() . ")\n";
75            } elseif ($fileInfo->isFile()) {
76                echo $indent . "[F] " . $fileInfo->getFilename() . " (サイズ: " . $fileInfo->getSize() . " bytes)\n";
77            }
78        }
79        echo "\n走査完了。\n";
80
81    } catch (UnexpectedValueException $e) {
82        // 指定されたディレクトリが見つからない場合などに発生
83        echo "エラー: 指定されたディレクトリが見つからないか、アクセスできません: " . $e->getMessage() . "\n";
84    } catch (Exception $e) {
85        // その他の予期せぬエラー
86        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
87    } finally {
88        // --- 4. テスト用のディレクトリとファイルをクリーンアップ ---
89        // スクリプトの実行後に作成された一時ファイルを削除し、環境をきれいに保ちます。
90        echo "\nテストディレクトリをクリーンアップ中...\n";
91        if (is_dir($testDir)) {
92            $cleanupIterator = new RecursiveIteratorIterator(
93                new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
94                RecursiveIteratorIterator::CHILD_FIRST
95            );
96            foreach ($cleanupIterator as $item) {
97                if ($item->isDir()) {
98                    rmdir($item->getPathname());
99                } else {
100                    unlink($item->getPathname());
101                }
102            }
103            rmdir($testDir); // 最後にルートディレクトリを削除
104            echo "クリーンアップ完了。\n";
105        }
106    }
107}
108
109// 関数を実行してデモンストレーションを開始します。
110demonstrateRecursiveDirectoryIteratorWithFileInfo();

PHP 8のRecursiveDirectoryIterator::CURRENT_AS_FILEINFOは、ファイルシステムを再帰的に走査する際に使うRecursiveDirectoryIteratorクラスで利用する定数です。この定数をRecursiveDirectoryIteratorのコンストラクタに指定することで、ディレクトリやファイルを走査した際に返される各要素の形式を変更できます。通常、要素はファイルパスの文字列ですが、この定数を用いるとSplFileInfoオブジェクトとして取得されます。SplFileInfoオブジェクトは、ファイル名、サイズ、更新日時、ファイルの種類（ディレクトリかファイルか）など、ファイルに関する豊富な情報にアクセスするための便利なメソッドを提供します。これにより、取得したファイルパスに対して別途情報を取得する手間を省き、より効率的にファイル操作を行えます。この定数自体は引数を取らず、戻り値もありません。サンプルコードでは、一時的なディレクトリ構造を作成し、RecursiveDirectoryIterator::CURRENT_AS_FILEINFOを適用してファイルを走査し、SplFileInfoオブジェクトからファイル名やサイズといった情報を取得・表示する具体的な使い方を示しています。