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

Copy
1<?php
2
3/**
4 * FilesystemIterator::NEW_CURRENT_AND_KEY 定数の動作を示すサンプルコード。
5 *
6 * この定数を使用すると、FilesystemIterator はファイルシステムを反復処理する際に、
7 * foreach ループのキーと値、および current() や key() メソッドの戻り値として、
8 * 現在の項目（ファイルまたはディレクトリ）の完全なパスを返します。
9 * 通常の動作とは異なり、キーはファイル名ではなくなり、値は SplFileInfo オブジェクトではなくなります。
10 */
11function demonstrateFilesystemIteratorNewCurrentAndKey(): void
12{
13    // 1. 一時ディレクトリを作成し、テストファイルを追加します。
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iterator_test_' . uniqid();
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        throw new RuntimeException(sprintf('一時ディレクトリ "%s" の作成に失敗しました。', $tempDir));
17    }
18
19    echo "一時ディレクトリを作成しました: " . $tempDir . PHP_EOL;
20
21    $file1Path = $tempDir . DIRECTORY_SEPARATOR . 'file1.txt';
22    $file2Path = $tempDir . DIRECTORY_SEPARATOR . 'sub_dir' . DIRECTORY_SEPARATOR . 'file2.txt';
23
24    // サブディレクトリを作成
25    if (!mkdir(dirname($file2Path), 0777, true) && !is_dir(dirname($file2Path))) {
26        throw new RuntimeException(sprintf('サブディレクトリ "%s" の作成に失敗しました。', dirname($file2Path)));
27    }
28
29    // テストファイルを作成
30    file_put_contents($file1Path, 'これはファイル1のコンテンツです。');
31    file_put_contents($file2Path, 'これはファイル2のコンテンツです。');
32
33    echo "テストファイルとディレクトリを作成しました: " . PHP_EOL;
34    echo "  - " . basename($file1Path) . PHP_EOL;
35    echo "  - " . basename(dirname($file2Path)) . DIRECTORY_SEPARATOR . basename($file2Path) . PHP_EOL . PHP_EOL;
36
37
38    // 2. FilesystemIterator を NEW_CURRENT_AND_KEY フラグ付きでインスタンス化します。
39    // このフラグにより、キーと値の両方がファイルのパス文字列になります。
40    echo "FilesystemIterator::NEW_CURRENT_AND_KEY を使用してイテレートします:" . PHP_EOL;
41    // FilesystemIterator::SKIP_DOTS も追加し、"." と ".." をスキップします。
42    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::NEW_CURRENT_AND_KEY | FilesystemIterator::SKIP_DOTS);
43
44    // 3. foreach ループでイテレートし、キーと値がファイルパスになっていることを確認します。
45    foreach ($iterator as $key => $current) {
46        echo "  キー: " . $key . PHP_EOL;       // 完全なファイルパス
47        echo "  値 (current): " . $current . PHP_EOL; // 完全なファイルパス
48        echo "  ---" . PHP_EOL;
49    }
50    echo PHP_EOL;
51
52    // 4. イテレータをリワインドし、current() と key() メソッドの戻り値も確認します。
53    echo "イテレータの current() および key() メソッドの戻り値を確認します:" . PHP_EOL;
54    $iterator->rewind(); // イテレータを最初の項目に戻します
55
56    if ($iterator->valid()) {
57        echo "  最初の項目:" . PHP_EOL;
58        echo "    key(): " . $iterator->key() . PHP_EOL;             // 完全なファイルパス
59        echo "    current(): " . $iterator->current() . PHP_EOL;     // 完全なファイルパス
60        // 比較のために、FilesystemIterator 自体が持つ SplFileInfo のメソッドも表示します。
61        echo "    getFilename(): " . $iterator->getFilename() . PHP_EOL; // ファイル名のみ
62        echo "    getPathname(): " . $iterator->getPathname() . PHP_EOL; // 完全なファイルパス
63    } else {
64        echo "ディレクトリが空か、イテレータが有効ではありません。" . PHP_EOL;
65    }
66    echo PHP_EOL;
67
68    // 5. 後処理：作成した一時ディレクトリとファイルを削除します。
69    // ディレクトリの中身を逆順で削除するため RecursiveDirectoryIterator を使います
70    $files = new RecursiveIteratorIterator(
71        new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
72        RecursiveIteratorIterator::CHILD_FIRST
73    );
74
75    foreach ($files as $fileinfo) {
76        $path = $fileinfo->getPathname();
77        if ($fileinfo->isDir()) {
78            rmdir($path); // ディレクトリを削除
79        } else {
80            unlink($path); // ファイルを削除
81        }
82    }
83    rmdir($tempDir); // 最上位の一時ディレクトリを削除
84    echo "一時ディレクトリとファイルをクリーンアップしました。" . PHP_EOL;
85}
86
87// 関数を実行します。
88demonstrateFilesystemIteratorNewCurrentAndKey();

PHP 8で提供されるFilesystemIterator::NEW_CURRENT_AND_KEYは、ファイルシステムを効率的に反復処理するFilesystemIteratorクラスで使用する定数です。この定数を指定することで、イテレータの振る舞いを変更し、ファイルパスの取得方法を簡素化できます。

通常、FilesystemIteratorをforeachループで使うと、キーにはファイル名が、値にはファイルの詳細情報を持つSplFileInfoオブジェクトが設定されます。しかし、NEW_CURRENT_AND_KEY定数を指定すると、この挙動が変わります。具体的には、foreachループのキーと値、そしてイテレータのcurrent()メソッドとkey()メソッドの戻り値の両方が、現在処理しているファイルやディレクトリの完全なパス文字列となります。これにより、直接ファイルパスを扱いたい場合にコードをよりシンプルに記述できます。

この定数自体に引数はなく、内部的にはFilesystemIteratorの動作モードを指定するための整数値が返されます。

Copy
1<?php
2
3// ファイルシステムを反復処理するためのFilesystemIteratorの使用例を示す関数です。
4// この関数は、システムエンジニアを目指す初心者の方にも理解しやすいように設計されています。
5function demonstrateFilesystemIteratorUsage(): void
6{
7    // テストのための一時ディレクトリを作成します。
8    // PHPの`sys_get_temp_dir()`関数でシステムの一時ディレクトリのパスを取得し、
9    // `uniqid()`で一意な名前を生成してディレクトリの衝突を防ぎます。
10    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_test_' . uniqid();
11    if (!mkdir($tempDir) && !is_dir($tempDir)) {
12        echo "エラー: 一時ディレクトリの作成に失敗しました。\n";
13        return;
14    }
15
16    // 作成したディレクトリ内にテストファイルをいくつか作成します。
17    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはテストドキュメントです。');
18    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'log.log', 'ログエントリ1\nログエントリ2');
19    mkdir($tempDir . DIRECTORY_SEPARATOR . 'sub_folder'); // サブフォルダも作成して、イテレータがディレクトリも検出することを示します。
20
21    echo "テスト対象ディレクトリ: " . $tempDir . "\n\n";
22
23    // FilesystemIterator::NEW_CURRENT_AND_KEY 定数を使ってイテレータを初期化します。
24    // `new FilesystemIterator(...)` の構文は、PHPでクラスの新しいインスタンスを生成する際に使用され、
25    // 丸括弧 `()` 内にコンストラクタの引数を渡します。
26    //
27    // FilesystemIterator::NEW_CURRENT_AND_KEY フラグは、イテレーション中に
28    // キー（`foreach ($iterator as $key => ...)` の `$key` 部分）としてファイル名（文字列）を、
29    // 値（`... => $fileInfo)` の `$fileInfo` 部分）としてSplFileInfoオブジェクト（ファイルの詳細情報を持つオブジェクト）を
30    // 返すようにFilesystemIteratorに指示します。
31    try {
32        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::NEW_CURRENT_AND_KEY);
33
34        echo "--- FilesystemIterator::NEW_CURRENT_AND_KEY を使用した出力 ---\n";
35        foreach ($iterator as $key => $fileInfo) {
36            // $key にはファイル名（文字列）、$fileInfo にはファイル情報を持つ SplFileInfo オブジェクトが格納されます。
37            echo sprintf(
38                "  キー: '%s', ファイル名: '%s', タイプ: %s\n",
39                $key,
40                $fileInfo->getFilename(), // SplFileInfoオブジェクトからファイル名を取得します。
41                $fileInfo->isDir() ? 'ディレクトリ' : 'ファイル' // ファイルがディレクトリか否かを判定します。
42            );
43        }
44        echo "-------------------------------------------------------\n";
45
46    } catch (UnexpectedValueException $e) {
47        // 指定されたパスが無効な場合（存在しない、アクセス権がないなど）に発生する例外をキャッチします。
48        echo "エラー: 指定されたパスにアクセスできません。詳細: " . $e->getMessage() . "\n";
49    } finally {
50        // テスト後に作成した一時ディレクトリとその内容を削除するクリーンアップ処理です。
51        // 再帰的にディレクトリを削除するヘルパー関数をこのスコープ内に定義します。
52        function removeDirRecursive(string $dirPath): void
53        {
54            if (!is_dir($dirPath)) {
55                return;
56            }
57            // FilesystemIteratorを使ってディレクトリ内のすべての項目を反復処理します。
58            $items = new FilesystemIterator($dirPath);
59            foreach ($items as $item) {
60                // ディレクトリであり、かつ特別なディレクトリ（'.'と'..'）でない場合、再帰的に削除します。
61                if ($item->isDir() && !$item->isDot()) {
62                    removeDirRecursive($item->getPathname());
63                } else {
64                    // ファイルまたはシンボリックリンクの場合は直接削除します。
65                    unlink($item->getPathname());
66                }
67            }
68            // すべての項目が削除された後、空になったディレクトリ自体を削除します。
69            rmdir($dirPath);
70        }
71        removeDirRecursive($tempDir);
72        echo "\n一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
73    }
74}
75
76// 上記のデモンストレーション関数を実行します。
77demonstrateFilesystemIteratorUsage();

PHPのFilesystemIterator::NEW_CURRENT_AND_KEYは、ファイルシステム上のディレクトリやファイルを反復処理するFilesystemIteratorクラスで利用される定数です。この定数には引数がなく、戻り値は整数型（int）です。

この定数をFilesystemIteratorのコンストラクタに指定することで、ディレクトリ内の項目をforeachループで処理する際のデータの受け取り方が変わります。具体的には、foreach ($iterator as $key => $fileInfo) の形式で反復する際、$key変数には現在のファイルの「ファイル名（文字列）」が、$fileInfo変数にはそのファイルに関する詳細情報を持つ「SplFileInfoオブジェクト」が格納されるようになります。

サンプルコードの new FilesystemIterator($tempDir, FilesystemIterator::NEW_CURRENT_AND_KEY) では、newキーワードと丸括弧 () を使ってFilesystemIteratorの新しいインスタンスを生成し、引数として対象パスとこの定数を渡しています。この設定により、ファイル名やファイルの種類（ファイルかディレクトリか）といった情報を簡単に取得・利用でき、ファイルシステム操作のコードを効率的かつ簡潔に記述できるようになります。