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

Copy
1<?php
2
3// このスクリプトが動作するために一時的なディレクトリとファイルを作成します。
4$baseDir = __DIR__ . '/temp_php_open_file_test';
5if (!is_dir($baseDir)) {
6    mkdir($baseDir, 0777, true);
7}
8file_put_contents($baseDir . '/file1.txt', "これはファイル1の内容です。\n2行目も含まれます。");
9file_put_contents($baseDir . '/file2.log', "ログエントリ1\nログエントリ2\nログエントリ3");
10if (!is_dir($baseDir . '/subdir')) {
11    mkdir($baseDir . '/subdir', 0777, true);
12}
13file_put_contents($baseDir . '/subdir/nested_file.txt', "サブディレクトリ内のファイルの内容です。");
14file_put_contents($baseDir . '/subdir/empty_file.txt', "");
15
16try {
17    // RecursiveDirectoryIterator のインスタンスを作成します。
18    // RecursiveDirectoryIterator::SKIP_DOTS フラグは、"." (カレントディレクトリ) と ".." (親ディレクトリ) を
19    // イテレーションからスキップするために使用します。
20    $directoryIterator = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
21
22    // RecursiveIteratorIterator を使用してディレクトリを再帰的に走査します。
23    // 各 $fileInfo は RecursiveDirectoryIterator のインスタンスであり、SplFileInfo を継承しています。
24    // これにより、isFile() や getPathname() などのメソッドが利用可能になります。
25    foreach (new RecursiveIteratorIterator($directoryIterator) as $fileInfo) {
26        // 現在の要素がファイルであるかを確認します。
27        if ($fileInfo->isFile()) {
28            echo "--- ファイル処理中: " . $fileInfo->getPathname() . " ---" . PHP_EOL;
29
30            try {
31                // RecursiveDirectoryIterator::openFile() メソッドを呼び出して SplFileObject を取得します。
32                // このメソッドは、現在のファイルを表す SplFileObject インスタンスを返します。
33                // 引数:
34                //   $mode: ファイルを開くモード ('r' は読み込み専用を意味します)。
35                //   $useIncludePath: PHPの include_path を検索するかどうか (通常は false)。
36                //   $context: ストリームコンテキスト (通常は null)。
37                $splFileObject = $fileInfo->openFile('r');
38
39                // SplFileObject を使ってファイルの内容を1行ずつ読み込みます。
40                echo "内容:" . PHP_EOL;
41                while (!$splFileObject->eof()) {
42                    $line = $splFileObject->fgets();
43                    echo "> " . rtrim($line) . PHP_EOL; // 行末の改行文字を削除して表示
44                }
45            } catch (RuntimeException $e) {
46                // ファイルのオープンや読み込み中にエラーが発生した場合に捕捉します。
47                echo "エラー: ファイル '" . $fileInfo->getPathname() . "' のオープンまたは読み込み中に問題が発生しました: " . $e->getMessage() . PHP_EOL;
48            }
49            echo PHP_EOL; // ファイル間の区切りとして空行を出力
50        }
51    }
52} catch (UnexpectedValueException $e) {
53    // 指定されたディレクトリが存在しないなど、RecursiveDirectoryIterator の構築時にエラーが発生した場合に捕捉します。
54    echo "エラー: ディレクトリイテレータの作成中に問題が発生しました: " . $e->getMessage() . PHP_EOL;
55} finally {
56    // スクリプトの実行後、作成した一時ファイルとディレクトリをクリーンアップします。
57    // RecursiveIteratorIterator を RecursiveIteratorIterator::CHILD_FIRST モードで使用すると、
58    // 子要素 (ファイル) から先に処理され、その後に空になったディレクトリが削除されます。
59    $files = new RecursiveIteratorIterator(
60        new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS),
61        RecursiveIteratorIterator::CHILD_FIRST
62    );
63    foreach ($files as $file) {
64        if ($file->isDir()) {
65            rmdir($file->getRealPath()); // ディレクトリを削除
66        } else {
67            unlink($file->getRealPath()); // ファイルを削除
68        }
69    }
70    // 最上位のディレクトリを削除
71    rmdir($baseDir);
72    echo "クリーンアップ完了: 一時ディレクトリ '$baseDir' が削除されました。" . PHP_EOL;
73}

RecursiveDirectoryIterator::openFileメソッドは、ディレクトリを再帰的に探索する過程で発見された個々のファイルを、操作可能なSplFileObjectインスタンスとして開く役割を果たします。これにより、ファイルの内容を読み込んだり、書き込んだりする準備が整います。

引数$modeは、ファイルを「読み込み専用 ('r')」や「書き込み専用 ('w')」など、どのような目的で開くかを指定します。$useIncludePathは、PHPのインクルードパスも検索対象とするかを指定し、通常はfalseです。$contextは、より詳細なストリーム設定を行う際に使用しますが、多くの場合nullで問題ありません。

このメソッドは、開かれたファイルを表すSplFileObjectを返します。このSplFileObjectを用いることで、ファイルの内容を一行ずつ読み込む（サンプルコードのfgets()のように）、ポインタを移動する、書き込みを行うなど、ファイルに対する多様な操作が可能になります。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使ってディレクトリ内のファイルを再帰的に走査し、isFile()でファイルであることを確認した上で、openFile('r')を呼び出しています。そして、取得したSplFileObjectを活用し、ファイルの内容を一行ずつ画面に出力する具体的な処理を示しています。本メソッドは、ディレクトリ探索とファイル操作を連携させる際に非常に有用です。