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

Copy
1<?php
2
3use GlobIterator;
4use FilesystemIterator;
5use SplFileObject;
6
7/**
8 * GlobIteratorを使用して、指定されたパターンに一致するファイルを検索し、
9 * 各ファイルをオープンして内容を読み込むサンプルコードです。
10 *
11 * GlobIteratorはSplFileInfoを継承しており、SplFileInfo::openFile()メソッドを通じて
12 * ファイルをSplFileObjectとして開くことができます。
13 * （注：リファレンス情報ではGlobIteratorのopenFile()が戻り値なしとありますが、
14 *      実際にはSplFileInfo::openFile()はSplFileObjectを返します。）
15 */
16
17// 作業用のディレクトリとファイルを一時的に作成します。
18$tempDir = __DIR__ . '/glob_temp';
19if (!is_dir($tempDir)) {
20    mkdir($tempDir);
21}
22
23// サンプルファイルをいくつか作成します。
24file_put_contents($tempDir . '/document.txt', "これは最初のドキュメントです。\n新しい行。\n");
25file_put_contents($tempDir . '/report.log', "アプリケーションログ：開始\nアプリケーションログ：終了\n");
26file_put_contents($tempDir . '/image.jpg', "ダミー画像ファイルの内容\n"); // 読み込み対象外
27
28echo "--- ファイル検索と内容表示 ---\n";
29
30try {
31    // GlobIteratorを作成し、指定されたパターン（.txtまたは.log）に一致するファイルを検索します。
32    // FilesystemIterator::CURRENT_AS_FILEINFO を使用すると、イテレータの各要素がSplFileInfoオブジェクトになります。
33    $iterator = new GlobIterator($tempDir . '/*.{txt,log}', FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO);
34
35    // 検索されたファイルを一つずつ処理します。
36    foreach ($iterator as $pathname => $fileInfo) {
37        echo "発見されたファイル: " . $fileInfo->getFilename() . "\n";
38        echo "フルパス: " . $pathname . "\n";
39
40        // SplFileInfo::openFile() メソッドを使用して、現在のファイルを読み込みモード 'r' で開きます。
41        // このメソッドはSplFileObjectのインスタンスを返します。
42        /** @var SplFileObject $fileObject */
43        $fileObject = $fileInfo->openFile('r');
44
45        echo "ファイル内容:\n";
46        // SplFileObjectを使ってファイルの内容を一行ずつ読み込み、表示します。
47        while (!$fileObject->eof()) {
48            echo "  " . trim($fileObject->fgets()) . "\n";
49        }
50        echo "---------------------------\n";
51    }
52
53    if ($iterator->count() === 0) {
54        echo "指定されたパターンに一致するファイルは見つかりませんでした。\n";
55    }
56
57} catch (Exception $e) {
58    echo "エラーが発生しました: " . $e->getMessage() . "\n";
59} finally {
60    // 後処理として、作成した一時ファイルとディレクトリを削除します。
61    echo "--- クリーンアップ中 ---\n";
62    if (is_dir($tempDir)) {
63        $files = glob($tempDir . '/*'); // ディレクトリ内のすべてのファイルを検索
64        foreach ($files as $file) {
65            if (is_file($file)) {
66                unlink($file); // ファイルを削除
67            }
68        }
69        rmdir($tempDir); // ディレクトリを削除
70    }
71    echo "クリーンアップが完了しました。\n";
72}

PHPのGlobIteratorは、指定されたパターンに一致するファイルを効率的に検索するためのクラスです。このサンプルコードは、GlobIteratorで見つかったファイルに対して、openFile()メソッドを使ってファイルを開き、その内容を読み込む方法を示しています。

openFile()メソッドは、GlobIteratorが継承するSplFileInfoクラスの機能であり、個々のファイルを開く際に利用します。第一引数$open_modeには、ファイルを読み込み ("r") や書き込み ("w") など、どのようなモードで開くかを文字列で指定します。第二引数$use_include_pathや第三引数$contextは、それぞれPHPのインクルードパス利用の有無やコンテキストオプションを制御しますが、通常はデフォルト値で問題ありません。

リファレンス情報では戻り値なしとありますが、実際にはSplFileObjectのインスタンスが返されます。このSplFileObjectを利用することで、ファイルの内容を一行ずつ読み込んだり、書き込んだりといった細かなファイル操作を簡単に行えるようになります。サンプルでは、.txtや.logファイルを検索し、それぞれのファイルを開いて内容を一行ずつ表示しており、ファイルシステムを操作する際の基本的な流れを理解できます。