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

Copy
1<?php
2
3// このコードは、DirectoryIterator クラスとその openFile メソッドを使って
4// ディレクトリ内のファイルを開き、内容を読み込む方法を示します。
5// システムエンジニアを目指す初心者の方にも分かりやすいよう、
6// 一時的なファイルを作成してデモンストレーションを行います。
7
8/**
9 * DirectoryIterator::openFile メソッドの使用例
10 * 一時ディレクトリにファイルを作成し、それを DirectoryIterator で見つけて開きます。
11 */
12function demonstrateDirectoryIteratorOpenFile(): void
13{
14    // 1. 一時ディレクトリとテストファイルの準備
15    //    本番環境では、既存のディレクトリパスとファイルパスを指定します。
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_open_file_example_' . uniqid();
17    // ディレクトリを作成
18    if (!mkdir($tempDir) && !is_dir($tempDir)) {
19        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
20        return;
21    }
22
23    $testFileName = 'example.txt';
24    $testFilePath = $tempDir . DIRECTORY_SEPARATOR . $testFileName;
25    $fileContent = "これは DirectoryIterator::openFile のテストファイルです。\n"
26                 . "2行目の内容です。\n"
27                 . "最終行です。";
28
29    // テストファイルを作成し、内容を書き込む
30    if (file_put_contents($testFilePath, $fileContent) === false) {
31        echo "エラー: テストファイル '{$testFilePath}' の作成に失敗しました。\n";
32        // クリーンアップ
33        if (is_dir($tempDir)) {
34            rmdir($tempDir);
35        }
36        return;
37    }
38
39    echo "一時ディレクトリを作成しました: {$tempDir}\n";
40    echo "テストファイルを作成しました: {$testFilePath}\n\n";
41
42    // 2. DirectoryIterator を使用してファイルを開く
43    try {
44        // DirectoryIterator のインスタンスを作成
45        // 指定されたディレクトリ内の項目（ファイルやサブディレクトリ）をイテレートできます。
46        $iterator = new DirectoryIterator($tempDir);
47        echo "ディレクトリ '{$tempDir}' 内を検索中...\n";
48
49        $fileOpened = false;
50
51        // ディレクトリ内の各項目をループ処理
52        foreach ($iterator as $fileInfo) {
53            // 現在の項目が通常のファイルであり、かつ目的のファイル名であるかチェック
54            if ($fileInfo->isFile() && $fileInfo->getFilename() === $testFileName) {
55                echo "目的のファイル '{$fileInfo->getFilename()}' を見つけました。\n";
56
57                // openFile() メソッドを使用して SplFileObject を取得します。
58                // 引数 'r' はファイルを読み込み専用モードで開くことを意味します。
59                // 戻り値は SplFileObject で、ファイル操作に便利なメソッドを提供します。
60                $fileObject = $fileInfo->openFile('r');
61
62                echo "ファイルが正常に開かれました。内容:\n";
63                echo "----------------------------------------\n";
64
65                // SplFileObject を使用してファイルの内容を1行ずつ読み込み、表示
66                while (!$fileObject->eof()) {
67                    echo $fileObject->fgets(); // ファイルから1行読み込む
68                }
69                echo "----------------------------------------\n";
70                echo "ファイルの内容の読み込みが完了しました。\n";
71                $fileOpened = true;
72                break; // 目的のファイルを見つけて処理したのでループを終了
73            }
74        }
75
76        if (!$fileOpened) {
77            echo "エラー: ディレクトリ内で '{$testFileName}' が見つかりませんでした。\n";
78        }
79
80    } catch (Exception $e) {
81        // ファイルが見つからない、ディレクトリが存在しないなどのエラーを捕捉
82        echo "処理中にエラーが発生しました: " . $e->getMessage() . "\n";
83    } finally {
84        // 3. クリーンアップ
85        //    作成した一時ディレクトリとファイルを削除します。
86        echo "\nクリーンアップ中...\n";
87        if (file_exists($testFilePath)) {
88            unlink($testFilePath); // テストファイルを削除
89            echo "テストファイルを削除しました: {$testFilePath}\n";
90        }
91        if (is_dir($tempDir)) {
92            rmdir($tempDir); // 一時ディレクトリを削除
93            echo "一時ディレクトリを削除しました: {$tempDir}\n";
94        }
95        echo "クリーンアップが完了しました。\n";
96    }
97}
98
99// 関数を実行
100demonstrateDirectoryIteratorOpenFile();
101
102?>

このコードは、PHPのDirectoryIteratorクラスとそのopenFileメソッドを使って、ディレクトリ内の特定のファイルを見つけて開く方法を示しています。まず、DirectoryIteratorは指定されたディレクトリ内のファイルやサブディレクトリの情報を一つずつ取得するためのクラスです。foreachループを使うことで、ディレクトリ内の各項目を順に処理できます。

サンプルコードでは、一時ディレクトリ内にexample.txtというテストファイルを作成し、内容を書き込みます。次に、DirectoryIteratorでこの一時ディレクトリを走査し、目的のテストファイルを見つけます。ファイル情報を示すSplFileInfoオブジェクト（DirectoryIteratorの各項目）が見つかったら、そのオブジェクトのopenFile()メソッドを呼び出します。

openFile()メソッドの最初の引数$modeには、ファイルを「読み込み専用」で開くことを意味する'r'を指定しています。このメソッドは、ファイル操作に便利な機能を持つSplFileObjectクラスのインスタンスを戻り値として返します。返されたSplFileObjectを使用すると、whileループとfgets()メソッドでファイルの内容を1行ずつ簡単に読み込むことができます。

このようにして、ディレクトリ内のファイルを安全に特定し、内容を処理することが可能です。処理の最後には、作成した一時ファイルとディレクトリを削除してクリーンアップしています。この方法は、ファイルシステムを操作する上で重要な基本的な機能の一つです。