【PHP8.x】GlobIterator::CURRENT_AS_FILEINFO定数の使い方

Copy
1<?php
2
3/**
4 * GlobIterator::CURRENT_AS_FILEINFO 定数を使用したサンプルコード
5 *
6 * この定数はGlobIteratorがイテレーション中に返す要素の型を制御します。
7 * GlobIterator::CURRENT_AS_FILEINFO をフラグとして指定すると、
8 * イテレーションで得られる各要素はSplFileInfoオブジェクトとなります。
9 * SplFileInfoオブジェクトは、ファイルの名前、パス、サイズ、更新日時など、
10 * ファイルに関する詳細な情報にアクセスできる便利なクラスです。
11 *
12 * このコードは一時的なディレクトリとファイルを作成し、
13 * そのファイルに対してGlobIteratorを使用し、CURRENT_AS_FILEINFOフラグの効果を示します。
14 */
15
16// 1. テスト用のディレクトリとファイルを作成
17$tempDir = __DIR__ . '/php_glob_test_' . uniqid();
18if (!mkdir($tempDir) && !is_dir($tempDir)) {
19    echo "エラー: 一時ディレクトリの作成に失敗しました。\n";
20    exit(1);
21}
22file_put_contents($tempDir . '/document.txt', 'これはテストドキュメントです。');
23file_put_contents($tempDir . '/image.jpg', 'ダミーデータ'); // 実際の画像データではない
24mkdir($tempDir . '/subdir'); // サブディレクトリも作成（ただし、globパターンでマッチしない可能性あり）
25
26echo "--- GlobIterator::CURRENT_AS_FILEINFO の使用例 ---\n";
27echo "一時ディレクトリ: " . $tempDir . "\n\n";
28
29try {
30    // 2. GlobIteratorをインスタンス化し、CURRENT_AS_FILEINFOフラグを指定
31    // このフラグにより、イテレータはSplFileInfoオブジェクトを返します。
32    // SplFileInfoオブジェクトはファイルの様々な属性にアクセスできます。
33    $iterator = new GlobIterator(
34        $tempDir . '/*', // パターンにマッチするすべてのファイルとディレクトリ
35        GlobIterator::CURRENT_AS_FILEINFO // 現在の要素をSplFileInfoオブジェクトとして返すよう指定
36    );
37
38    // 3. イテレーションを行い、各要素の情報を表示
39    foreach ($iterator as $fullPath => $fileInfo) {
40        echo "見つかった項目:\n";
41        echo "  キー (globパターンにマッチした絶対パス): " . $fullPath . "\n";
42
43        // $fileInfo が SplFileInfo オブジェクトであることを確認し、そのメソッドを利用
44        if ($fileInfo instanceof SplFileInfo) {
45            echo "  値 (SplFileInfoオブジェクト):\n";
46            echo "    ファイル名: " . $fileInfo->getFilename() . "\n";
47            echo "    絶対パス: " . $fileInfo->getPathname() . "\n";
48            echo "    ファイルか: " . ($fileInfo->isFile() ? 'はい' : 'いいえ') . "\n";
49            echo "    ディレクトリか: " . ($fileInfo->isDir() ? 'はい' : 'いいえ') . "\n";
50            echo "    ファイルサイズ: " . ($fileInfo->isFile() ? $fileInfo->getSize() . ' バイト' : 'N/A') . "\n";
51            // SplFileInfoには他にも多くのメソッドがあります (例: getMTime(), getExtension() など)
52        } else {
53            echo "  エラー: 期待される SplFileInfo オブジェクトではありませんでした (" . gettype($fileInfo) . ")\n";
54        }
55        echo "\n";
56    }
57
58} catch (UnexpectedValueException $e) {
59    echo "エラー: GlobIterator の操作中に問題が発生しました - " . $e->getMessage() . "\n";
60} finally {
61    // 4. 一時的に作成したファイルとディレクトリをクリーンアップ
62    // Recursively delete directory contents
63    $files = new RecursiveIteratorIterator(
64        new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
65        RecursiveIteratorIterator::CHILD_FIRST
66    );
67    foreach ($files as $fileinfo) {
68        if ($fileinfo->isDir()) {
69            rmdir($fileinfo->getRealPath());
70        } else {
71            unlink($fileinfo->getRealPath());
72        }
73    }
74    rmdir($tempDir);
75    echo "一時ディレクトリがクリーンアップされました: " . $tempDir . "\n";
76}
77
78?>

PHPのGlobIterator::CURRENT_AS_FILEINFO定数は、GlobIteratorクラスがファイルシステムを探索する際に、見つかった各項目をどのような形式で返すかを指定するためのものです。この定数自体は整数値（int）を返しますが、これはGlobIteratorの振る舞いを制御するフラグとして機能します。

この定数をGlobIteratorのコンストラクタに指定すると、イテレーション中に得られる各要素がSplFileInfoオブジェクトとなります。SplFileInfoオブジェクトは、ファイルの名前、パス、サイズ、更新日時など、ファイルに関する詳細な情報にアクセスできる便利なクラスです。

提供されたサンプルコードでは、一時的なファイルやディレクトリを作成し、GlobIteratorでそれらを探索しています。GlobIteratorのインスタンス化時にCURRENT_AS_FILEINFO定数をフラグとして渡すことで、ループ内で取得される各項目はSplFileInfoオブジェクトとして扱われ、そのオブジェクトが持つメソッドを通じてファイル名やパス、ファイルサイズなどの属性を容易に取得し、表示しています。これにより、ファイルシステム上の項目をより詳細に、オブジェクト指向的に扱えるようになります。

Copy
1<?php
2
3/**
4 * GlobIterator::CURRENT_AS_FILEINFO 定数を使用して、
5 * glob パターンに一致するファイルやディレクトリの情報を取得するサンプルコード。
6 *
7 * この定数を GlobIterator のコンストラクタのフラグとして渡すと、
8 * イテレータが返す各要素が SplFileInfo オブジェクトになります。
9 * SplFileInfo オブジェクトは、ファイルやディレクトリに関する詳細な情報（パス、ファイル名、種類など）
10 * を取得するためのメソッドを提供します。
11 */
12
13// --------------------------------------------------
14// 1. テスト用のファイルとディレクトリの準備
15// --------------------------------------------------
16
17// 一時的なディレクトリ名を生成
18$testDir = __DIR__ . '/_temp_glob_example_' . uniqid();
19
20// テスト用ディレクトリを作成
21if (!mkdir($testDir)) {
22    die("エラー: テスト用ディレクトリ '{$testDir}' の作成に失敗しました。\n");
23}
24// テスト用ファイルを作成
25file_put_contents($testDir . '/document1.txt', 'This is document 1.');
26file_put_contents($testDir . '/image.jpg', 'Dummy image content.');
27// テスト用サブディレクトリを作成
28if (!mkdir($testDir . '/subfolder')) {
29    die("エラー: テスト用サブディレクトリの作成に失敗しました。\n");
30}
31file_put_contents($testDir . '/subfolder/report.pdf', 'Dummy PDF content.');
32
33echo "--- テスト用ファイルシステム構造を準備しました ---\n";
34echo "ディレクトリ: {$testDir}\n";
35echo " - document1.txt\n";
36echo " - image.jpg\n";
37echo " - subfolder/\n";
38echo "   - report.pdf\n\n";
39
40// --------------------------------------------------
41// 2. GlobIterator::CURRENT_AS_FILEINFO の使用例
42// --------------------------------------------------
43
44try {
45    // GlobIterator を初期化し、glob パターンとフラグを指定します。
46    // GlobIterator::CURRENT_AS_FILEINFO を指定することで、
47    // イテレータが SplFileInfo オブジェクトを返します。
48    // '*' は、指定されたディレクトリ内の全てのファイルとディレクトリにマッチします。
49    $iterator = new GlobIterator(
50        $testDir . '/*',
51        GlobIterator::CURRENT_AS_FILEINFO // ここで定数を使用
52    );
53
54    echo "--- GlobIterator を使用してファイル情報を列挙します ---\n";
55
56    // イテレータをループして、各要素のファイル情報を表示します。
57    foreach ($iterator as $pathname => $fileInfo) {
58        // $fileInfo は SplFileInfo オブジェクトです。
59        echo "取得元パス (イテレータキー): " . $pathname . "\n";
60        echo "ファイル名: " . $fileInfo->getFilename() . "\n";
61        echo "フルパス: " . $fileInfo->getPathname() . "\n";
62        echo "種類: " . ($fileInfo->isDir() ? 'ディレクトリ' : 'ファイル') . "\n";
63        echo "サイズ: " . ($fileInfo->isFile() ? $fileInfo->getSize() . ' バイト' : 'N/A') . "\n";
64        echo "最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
65        echo "--------------------------\n";
66    }
67
68} catch (UnexpectedValueException $e) {
69    echo "エラー: 指定されたパスが見つからないか、アクセスできません。" . $e->getMessage() . "\n";
70} catch (Exception $e) {
71    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
72} finally {
73    // --------------------------------------------------
74    // 3. テスト用のファイルとディレクトリのクリーンアップ
75    // --------------------------------------------------
76    // 実際のアプリケーションでは、一時ファイルを適切に管理し、不要になったら削除します。
77
78    // ディレクトリとその内容を再帰的に削除するヘルパー関数
79    $rrmdir = function (string $dir) use (&$rrmdir): void {
80        if (!file_exists($dir)) {
81            return;
82        }
83        foreach (new FilesystemIterator($dir, FilesystemIterator::SKIP_DOTS) as $file) {
84            if ($file->isDir()) {
85                $rrmdir($file->getPathname());
86            } else {
87                unlink($file->getPathname());
88            }
89        }
90        rmdir($dir);
91    };
92
93    $rrmdir($testDir);
94    echo "--- テスト用ディレクトリ '{$testDir}' をクリーンアップしました ---\n";
95}
96
97?>

PHP 8のGlobIterator::CURRENT_AS_FILEINFOは、ファイルシステムを探索するGlobIteratorクラスで利用される定数です。この定数自体は引数を持ちませんが、int型の整数値として定義されており、GlobIteratorのコンストラクタの第2引数に渡すことで、イテレータが返す要素の形式を制御します。

この定数の主な役割は、GlobIteratorが返す各要素を単なるファイルパスの文字列ではなく、ファイルやディレクトリに関する詳細な情報を持つSplFileInfoオブジェクトとして提供することです。SplFileInfoオブジェクトは、ファイル名、フルパス、ファイルの種類（ファイルかディレクトリか）、サイズ、最終更新日時など、ファイルに関する豊富な情報を取得するためのメソッドを提供します。

サンプルコードでは、テスト用のファイルやディレクトリを準備した後、GlobIteratorの初期化時にこの定数を指定しています。これにより、イテレータから取得されるSplFileInfoオブジェクトを使って、それぞれのファイルやディレクトリの詳細な属性情報を表示しています。この定数を利用することで、ファイルシステムからの情報取得と操作が、より柔軟かつ効率的に行えるようになります。