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

Copy
1<?php
2
3/**
4 * FilesystemIterator::CURRENT_AS_FILEINFO 定数の使用例を示す関数です。
5 *
6 * この定数は、FilesystemIterator がイテレーション時に返す値を SplFileInfo オブジェクトとして
7 * 扱うように指定します。これにより、ファイル名だけでなく、ファイルサイズ、更新日時、
8 * ファイルタイプなどの詳細情報に簡単にアクセスできるようになります。
9 * システムエンジニアを目指す初心者の方に、ファイルシステムの内容を効率的に
10 * 取得し、その情報にアクセスする方法を理解してもらうことを目的としています。
11 */
12function demonstrateFilesystemIteratorCurrentAsFileInfo(): void
13{
14    // 1. 一時ディレクトリとテストファイルを作成します。
15    // システムの一時ディレクトリパスを取得し、ユニークな名前で一時ディレクトリを作成します。
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_fs_iterator_test_');
17
18    if (!mkdir($tempDir, 0777, true)) {
19        echo "エラー: 一時ディレクトリの作成に失敗しました。\n";
20        return;
21    }
22    echo "一時ディレクトリを作成しました: " . $tempDir . "\n";
23
24    // ディレクトリ内にいくつかのテストファイルを作成します。
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'This is a sample document.');
26    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'image.jpg', 'fake_image_content'); // ダミーコンテンツ
27    mkdir($tempDir . DIRECTORY_SEPARATOR . 'empty_folder'); // 空のサブディレクトリも作成
28
29    echo "テストファイルとサブディレクトリを作成しました。\n";
30
31    // 2. FilesystemIterator を FilesystemIterator::CURRENT_AS_FILEINFO フラグ付きでインスタンス化します。
32    // SKIP_DOTS フラグも追加し、'.' と '..' のエントリをスキップします。
33    try {
34        $iterator = new FilesystemIterator(
35            $tempDir,
36            FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
37        );
38
39        echo "\nFilesystemIterator を使用してディレクトリを走査します (CURRENT_AS_FILEINFO):\n";
40        echo "--------------------------------------------------\n";
41
42        // 3. イテレータでディレクトリ内の各要素をループし、SplFileInfo オブジェクトの情報を表示します。
43        foreach ($iterator as $fileInfo) {
44            // $fileInfo は SplFileInfo オブジェクトなので、その豊富なメソッドを利用できます。
45            echo "要素名: " . $fileInfo->getFilename() . "\n";
46            echo "フルパス: " . $fileInfo->getPathname() . "\n";
47            echo "種類: " . ($fileInfo->isFile() ? "ファイル" : ($fileInfo->isDir() ? "ディレクトリ" : "その他")) . "\n";
48
49            if ($fileInfo->isFile()) {
50                echo "サイズ: " . $fileInfo->getSize() . " バイト\n";
51                echo "最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
52            }
53            echo "--------------------------------------------------\n";
54        }
55    } catch (UnexpectedValueException $e) {
56        echo "エラー: イテレータの作成または使用中に問題が発生しました: " . $e->getMessage() . "\n";
57    } finally {
58        // 4. クリーンアップ: 作成した一時ファイルとディレクトリを削除します。
59        echo "\nクリーンアップ中...\n";
60
61        // 一時ディレクトリ内のファイルを削除します。
62        // ここでも FilesystemIterator を使用して各要素を取得します。
63        $cleanIterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
64        foreach ($cleanIterator as $item) {
65            if ($item->isFile()) {
66                unlink($item->getPathname());
67            } elseif ($item->isDir()) {
68                // サブディレクトリが空であることを確認してから削除します。
69                rmdir($item->getPathname());
70            }
71        }
72        // 最後に一時ディレクトリ自体を削除します。
73        if (rmdir($tempDir)) {
74            echo "一時ディレクトリを削除しました: " . $tempDir . "\n";
75        } else {
76            echo "エラー: 一時ディレクトリの削除に失敗しました: " . $tempDir . "\n";
77        }
78    }
79}
80
81// 関数を実行してデモンストレーションを開始します。
82demonstrateFilesystemIteratorCurrentAsFileInfo();

PHPのFilesystemIterator::CURRENT_AS_FILEINFOは、ファイルシステムを扱うFilesystemIteratorクラスで使用される定数です。この定数は、ディレクトリ内のファイルやフォルダを順に処理する（イテレーションする）際に、各項目に関する情報をSplFileInfoオブジェクトとして返すようFilesystemIteratorに指示します。

サンプルコードでは、この定数を使って一時ディレクトリ内のファイルやサブディレクトリを走査しています。FilesystemIterator::CURRENT_AS_FILEINFOを指定することで、イテレーション中に得られる各要素はSplFileInfoオブジェクトになります。このオブジェクトは、単なるファイル名だけでなく、ファイルの種類（ファイルかディレクトリか）、サイズ、最終更新日時、フルパスなど、ファイルに関する詳細な情報にアクセスするための多くのメソッドを提供します。例えば、$fileInfo->getFilename()でファイル名、$fileInfo->getSize()でサイズを取得するといった使い方ができます。

この定数自体に引数はありません。内部的には整数値（int）を持っており、FilesystemIteratorの振る舞いを設定するためのフラグとして機能します。システムエンジニアを目指す方にとって、ファイルシステムの情報を効率的かつ詳細に取得し、プログラムで活用するための基本的な方法を理解する上で非常に役立つ定数です。

Copy
1<?php
2
3/**
4 * FilesystemIterator::CURRENT_AS_FILEINFO 定数を使用して、
5 * ディレクトリ内のファイルを SplFileInfo オブジェクトとして取得するサンプルコードです。
6 */
7function demonstrateFilesystemIteratorWithCurrentAsFileInfo(): void
8{
9    // サンプルが単体で動作するように、一時ディレクトリとテストファイルを作成します。
10    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iterator_test_' . uniqid();
11    if (!mkdir($tempDir) && !is_dir($tempDir)) {
12        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
13        return;
14    }
15
16    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Hello PHP!');
17    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'another_file.log', 'Log entry.');
18    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'empty.csv', '');
19
20    echo "ディレクトリ '{$tempDir}' 内のファイルを列挙します:\n";
21
22    try {
23        // FilesystemIterator をインスタンス化します。
24        // FilesystemIterator::CURRENT_AS_FILEINFO フラグは、イテレータが現在の要素を
25        // SplFileInfo オブジェクトとして返すように指定します。
26        // これにより、ファイルパス、サイズ、更新日時などのファイル情報にアクセスできます。
27        // このフラグはデフォルトで設定されていますが、明示的に指定することでコードの意図が明確になります。
28        // FilesystemIterator::SKIP_DOTS フラグも追加し、特殊なディレクトリ'.' と '..' をスキップします。
29        $iterator = new FilesystemIterator(
30            $tempDir,
31            FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
32        );
33
34        foreach ($iterator as $fileInfo) {
35            // $fileInfo は SplFileInfo クラスのインスタンスです。
36            // これにより、ファイルに関する詳細な情報に簡単にアクセスできます。
37            if ($fileInfo->isFile()) { // ディレクトリではなくファイルの場合のみ処理
38                echo "  ファイル名: " . $fileInfo->getFilename() . "\n";
39                echo "  フルパス: " . $fileInfo->getPathname() . "\n";
40                echo "  サイズ: " . $fileInfo->getSize() . " バイト\n";
41                echo "  最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
42                echo "  --------------------\n";
43            }
44        }
45    } catch (UnexpectedValueException $e) {
46        echo "エラー: ディレクトリ '{$tempDir}' にアクセスできません: " . $e->getMessage() . "\n";
47    } finally {
48        // 使用後の一時ファイルとディレクトリをクリーンアップします。
49        if (is_dir($tempDir)) {
50            $files = array_diff(scandir($tempDir), array('.', '..'));
51            foreach ($files as $file) {
52                $filePath = $tempDir . DIRECTORY_SEPARATOR . $file;
53                if (is_file($filePath)) { // ファイルのみを削除
54                    unlink($filePath);
55                }
56            }
57            rmdir($tempDir);
58            echo "\n一時ディレクトリ '{$tempDir}' をクリーンアップしました。\n";
59        }
60    }
61}
62
63// サンプル関数を実行します。
64demonstrateFilesystemIteratorWithCurrentAsFileInfo();

PHP 8のFilesystemIterator::CURRENT_AS_FILEINFOは、FilesystemIteratorクラスに属する定数です。この定数は整数値を取り、ディレクトリ内のファイルを反復処理する際に、現在の要素をSplFileInfoオブジェクトとして返すように指定します。通常、イテレータはファイルパスなどの文字列を返しますが、この定数を指定すると、より詳細なファイル情報を扱えるSplFileInfoオブジェクトとして要素が取得できるようになります。SplFileInfoオブジェクトを利用することで、ファイルのフルパス、ファイル名、サイズ、最終更新日時など、ファイルに関する豊富な情報に簡単にアクセスできます。

サンプルコードでは、一時ディレクトリを作成し、その中のファイルをFilesystemIteratorで列挙しています。FilesystemIterator::CURRENT_AS_FILEINFO定数をFilesystemIteratorのコンストラクタに渡すことで、foreachループ内で取得される$fileInfo変数がSplFileInfoオブジェクトとなります。これにより、$fileInfo->getFilename()や$fileInfo->getSize()といったメソッドを呼び出して、各ファイルの具体的な情報を取得し表示しています。この定数はファイル情報を効率的に扱うための重要な機能です。