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

Copy
1<?php
2
3// GlobIterator::getFileInfo() メソッドの使用例を示す関数
4function demonstrateGlobIteratorGetFileInfo(): void
5{
6    // 1. GlobIterator で検索するためのテストファイルを作成します
7    $tempDir = sys_get_temp_dir() . '/glob_iterator_test_' . uniqid();
8    if (!mkdir($tempDir) && !is_dir($tempDir)) {
9        echo "一時ディレクトリの作成に失敗しました: $tempDir\n";
10        return;
11    }
12    echo "一時ディレクトリを作成しました: " . $tempDir . "\n";
13
14    $testFiles = [
15        $tempDir . '/document1.txt',
16        $tempDir . '/log_file.log',
17        $tempDir . '/report2.txt',
18    ];
19
20    foreach ($testFiles as $file) {
21        file_put_contents($file, 'これはテストファイルです。');
22        echo "テストファイルを作成しました: " . basename($file) . "\n";
23    }
24
25    // 2. GlobIterator を使用して特定のパターンに一致するファイルを反復処理します
26    // ここでは、作成した一時ディレクトリ内の .txt または .log ファイルを検索します。
27    $pattern = $tempDir . '/*.{txt,log}';
28    echo "\nGlobIterator を使ってパターン '{$pattern}' に一致するファイルを検索します。\n";
29
30    try {
31        // GlobIterator のインスタンス化
32        // FilesystemIterator::CURRENT_AS_FILEINFO フラグは、foreach ループで
33        // SplFileInfo オブジェクトを直接取得できるようにします。
34        $iterator = new GlobIterator($pattern, FilesystemIterator::CURRENT_AS_FILEINFO);
35
36        if (!$iterator->valid()) {
37            echo "指定されたパターンに一致するファイルが見つかりませんでした。\n";
38        } else {
39            echo "見つかったファイルの情報:\n";
40            // イテレータをループして各ファイル情報を取得
41            foreach ($iterator as $file) {
42                // getFileInfo() メソッドは、現在の要素（ファイルまたはディレクトリ）に対応する
43                // SplFileInfo オブジェクトを返します。
44                // FilesystemIterator::CURRENT_AS_FILEINFO フラグを使用している場合、
45                // $file 変数自体が SplFileInfo オブジェクトになりますが、
46                // このメソッドの機能を示すために明示的に呼び出します。
47                $fileInfo = $iterator->getFileInfo(); // SplFileInfo のインスタンスを返す
48
49                echo "  ファイル名: " . $fileInfo->getFilename() . "\n";
50                echo "  フルパス: " . $fileInfo->getPathname() . "\n";
51                echo "  ファイルサイズ: " . $fileInfo->getSize() . " バイト\n";
52                echo "  最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
53                echo "  タイプ: " . ($fileInfo->isFile() ? 'ファイル' : 'ディレクトリ') . "\n";
54                echo "  --------------------\n";
55            }
56        }
57    } catch (UnexpectedValueException $e) {
58        // パターンが無効な場合などに発生するエラーを捕捉します。
59        echo "GlobIterator の初期化エラー: " . $e->getMessage() . "\n";
60    } catch (Exception $e) {
61        // その他の予期せぬエラーを捕捉します。
62        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
63    } finally {
64        // 3. 後処理: 作成した一時ファイルとディレクトリを削除します
65        echo "\n一時ファイルとディレクトリをクリーンアップします。\n";
66        foreach ($testFiles as $file) {
67            if (file_exists($file)) {
68                unlink($file);
69                echo "ファイルを削除しました: " . basename($file) . "\n";
70            }
71        }
72        if (is_dir($tempDir)) {
73            rmdir($tempDir);
74            echo "ディレクトリを削除しました: " . $tempDir . "\n";
75        }
76    }
77}
78
79// 関数を実行して GlobIterator::getFileInfo() の動作を確認します
80demonstrateGlobIteratorGetFileInfo();

PHPのGlobIteratorクラスは、特定のパターン（例えば*.txtやimages/*.{jpg,png}など）に一致するファイルやディレクトリを検索し、一つずつ処理する際に利用される便利な機能です。

このGlobIterator::getFileInfo()メソッドは、GlobIteratorが現在指し示している要素、つまり現在処理中のファイルやディレクトリの詳細な情報を取得するために使われます。このメソッドを呼び出すと、SplFileInfoという種類のオブジェクトが戻り値として返されます。SplFileInfoオブジェクトには、ファイル名、ファイルのフルパス、サイズ、最終更新日時、ファイル種別（ファイルかディレクトリか）など、様々なファイルに関する詳細な情報が格納されており、これらを使ってプログラムで柔軟な処理が可能になります。

引数$classはオプションで、デフォルトではRecursiveDirectoryIterator::classが設定されています。これは、返される情報オブジェクトをSplFileInfoの代わりに、より詳細な機能を持つ特定のカスタムクラスのインスタンスにしたい場合に指定できますが、通常はデフォルトのSplFileInfoで十分な場合が多いです。

サンプルコードでは、一時ディレクトリ内の特定の拡張子のファイルに対してGlobIteratorを使い、getFileInfo()メソッドを通して各ファイルの具体的な情報（ファイル名、サイズ、更新日時など）を取得し、表示する一連の流れを示しています。これにより、ファイルシステム上の情報を効率的に取得し、システム開発に活用することができます。