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

Copy
1<?php
2
3// このサンプルコードは、FilesystemIterator::openFile() メソッドを使用して、
4// 指定されたディレクトリ内のファイルを読み込む方法を示します。
5// 実行のために一時的なファイルを作成し、終了後に削除します。
6
7// 一時ディレクトリのパスを定義
8$tempDir = __DIR__ . '/temp_filesystem_iterator_example';
9$file1Path = $tempDir . '/example_file1.txt';
10$file2Path = $tempDir . '/example_file2.txt';
11
12// 一時ディレクトリが存在しない場合は作成 (再帰的に作成し、全権限を付与)
13if (!is_dir($tempDir)) {
14    mkdir($tempDir, 0777, true);
15}
16
17// テスト用のファイルを作成し、内容を書き込む
18file_put_contents($file1Path, "これはファイル1の最初の行です。\n2行目。\n最終行です。\n");
19file_put_contents($file2Path, "ファイル2の内容。\n短い内容です。\n");
20
21echo "--- FilesystemIterator::openFile() の使用例 ---\n\n";
22
23try {
24    // FilesystemIterator をインスタンス化し、一時ディレクトリを指定
25    // FilesystemIterator::SKIP_DOTS フラグで特殊ディレクトリ '.' と '..' をスキップ
26    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
27
28    // ディレクトリ内の各ファイルをループ処理
29    foreach ($iterator as $fileInfo) {
30        // 現在のファイル名を取得して表示
31        echo "ファイル名: " . $fileInfo->getFilename() . "\n";
32
33        // FilesystemIterator::openFile() メソッドを使って SplFileObject を取得
34        // 第一引数 'r' は読み込みモードを指定 (デフォルト値ですが明示的に渡しています)
35        $fileObject = $fileInfo->openFile('r');
36
37        // SplFileObject のフラグを設定して、読み込み動作を調整
38        // SplFileObject::READ_AHEAD: ファイルを先読みしてパフォーマンス向上
39        // SplFileObject::SKIP_EMPTY: 空行をスキップ
40        // SplFileObject::DROP_NEW_LINE: 行末の改行文字を削除
41        $fileObject->setFlags(SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE);
42
43        echo "  内容:\n";
44        // SplFileObject を foreach でループすると、ファイルの内容を行ごとに読み込めます
45        foreach ($fileObject as $line) {
46            echo "    " . $line . "\n";
47        }
48        echo "\n"; // 各ファイルの出力後に空行を追加して見やすくする
49    }
50} catch (UnexpectedValueException $e) {
51    // 指定されたディレクトリが存在しない場合などに発生するエラーをキャッチ
52    echo "エラーが発生しました: " . $e->getMessage() . "\n";
53} finally {
54    // スクリプトの実行が成功しても失敗しても、作成した一時ファイルを確実に削除
55    if (file_exists($file1Path)) {
56        unlink($file1Path);
57    }
58    if (file_exists($file2Path)) {
59        unlink($file2Path);
60    }
61    if (is_dir($tempDir)) {
62        rmdir($tempDir); // ディレクトリも削除
63    }
64    echo "--- クリーンアップ完了 ---\n";
65}

PHP 8のFilesystemIterator::openFile()メソッドは、ディレクトリ内のファイル情報を走査するFilesystemIteratorと組み合わせて使用されます。このメソッドは、FilesystemIteratorによって取得された各ファイル情報（SplFileInfoオブジェクト）に対して呼び出され、そのファイルの内容を読み書きするためのSplFileObjectインスタンスを返します。

第一引数の$modeには、ファイルを開くモードを文字列で指定します。例えば'r'は読み込みモードを意味し、デフォルト値も読み込みモードです。第二引数の$useIncludePathは、include_pathを使ってファイルを探すかどうかを決定し、第三引数の$contextはファイル操作のコンテキストを指定しますが、これらは通常デフォルト値で十分です。

戻り値として得られるSplFileObjectは、ファイルの内容を行ごとにループ処理したり、setFlags()メソッドを用いて空行のスキップや改行文字の削除など、ファイルの読み込み動作を柔軟に制御できる非常に便利なオブジェクトです。

このサンプルコードでは、一時的に作成したディレクトリとファイルを使用し、FilesystemIteratorでディレクトリ内の各ファイルを効率的に巡回する方法を示しています。openFile()で取得したSplFileObjectを通じて、ファイルの内容を一行ずつ読み込み、その挙動を具体的に確認できます。処理後には作成したファイルとディレクトリが適切に削除され、クリーンな状態に戻されます。