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

Copy
1<?php
2
3/**
4 * FilesystemIterator::CURRENT_AS_PATHNAME 定数の使用例を示します。
5 * この定数を使用すると、FilesystemIterator はイテレート中に各要素をファイルのフルパス（文字列）として返します。
6 * 通常の SplFileInfo オブジェクトを返すデフォルトの挙動と比較して、直接パス文字列が欲しい場合に便利です。
7 */
8function demonstratePathnameIterator(): void
9{
10    // イテレータが処理する一時ディレクトリを作成します。
11    $tempDir = __DIR__ . '/iterator_test_dir';
12    if (!is_dir($tempDir)) {
13        mkdir($tempDir);
14    }
15
16    // テスト用のファイルをいくつか作成します。
17    file_put_contents($tempDir . '/report_2023.txt', 'Annual report data.');
18    file_put_contents($tempDir . '/image_001.jpg', 'Binary image data.');
19
20    echo "--- FilesystemIterator::CURRENT_AS_PATHNAME の使用例 ---\n";
21    echo "FilesystemIterator は、要素を直接ファイルのフルパス文字列として返します。\n";
22
23    try {
24        // FilesystemIterator を CURRENT_AS_PATHNAME モードで初期化します。
25        // これにより、foreach ループで取得される $path 変数は、各ファイルのフルパス文字列になります。
26        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::CURRENT_AS_PATHNAME);
27
28        foreach ($iterator as $path) {
29            // $path は既に文字列で、ファイルのフルパスを表します。
30            echo "見つかったパス: " . $path . "\n";
31            echo "データ型: " . gettype($path) . "\n";
32        }
33    } catch (UnexpectedValueException $e) {
34        // 指定されたディレクトリが存在しない場合などにエラーが発生します。
35        echo "エラー: ディレクトリ '{$tempDir}' を読み込めませんでした。" . $e->getMessage() . "\n";
36    } finally {
37        // 作成した一時ファイルとディレクトリをクリーンアップします。
38        if (is_dir($tempDir)) {
39            $files = array_diff(scandir($tempDir), ['.', '..']); // '.' と '..' を除外
40            foreach ($files as $file) {
41                unlink($tempDir . '/' . $file);
42            }
43            rmdir($tempDir);
44            echo "\n一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
45        }
46    }
47}
48
49// 関数を実行してデモンストレーションを開始します。
50demonstratePathnameIterator();

FilesystemIterator::CURRENT_AS_PATHNAMEは、PHPのFilesystemIteratorクラスで使用される定数です。この定数を使うと、ディレクトリ内のファイルやディレクトリを繰り返し処理する際、各要素を「ファイルのフルパスを表す文字列」として直接取得できるようになります。

通常、FilesystemIteratorは各要素をSplFileInfoというオブジェクトとして返しますが、FilesystemIterator::CURRENT_AS_PATHNAMEを指定してイテレータを初期化すると、foreachループなどで取得される値が、SplFileInfoオブジェクトではなく、ファイルやディレクトリのフルパス（例: /path/to/your/file.txt）という文字列型になります。これにより、ファイルパスを直接扱いたい場合に、SplFileInfoオブジェクトからパスを取り出す手間を省くことができます。

サンプルコードでは、まず一時的なディレクトリとテスト用のファイルを作成しています。その後、new FilesystemIterator($tempDir, FilesystemIterator::CURRENT_AS_PATHNAME)としてイテレータを初期化し、この定数を適用しています。foreach ($iterator as $path)のループでは、$path変数に各ファイルのフルパスが文字列として格納され、そのパスとデータ型を表示しています。このように、この定数はイテレータが返す値の形式を変更する役割を持っています。最後に、作成した一時ディレクトリとファイルを適切に削除し、クリーンアップを行っています。

Copy
1<?php
2
3/**
4 * 現在のディレクトリの内容をパス名としてリストアップします。
5 *
6 * FilesystemIterator::CURRENT_AS_PATHNAME 定数を使用すると、
7 * イテレータが各要素を SplFileInfo オブジェクトとしてではなく、
8 * 単純なパス名文字列として返すようになります。
9 * これは、ファイルパスだけを迅速に取得したい場合に便利です。
10 */
11function listCurrentDirectoryContentsAsPathname(): void
12{
13    echo "現在のディレクトリの内容 (パス名として表示):" . PHP_EOL;
14
15    try {
16        // FilesystemIterator を使用して現在のディレクトリ('.')を走査します。
17        // FilesystemIterator::CURRENT_AS_PATHNAME フラグを指定することで、
18        // 各要素がファイルやディレクトリのパス名文字列として取得されます。
19        $iterator = new FilesystemIterator('.', FilesystemIterator::CURRENT_AS_PATHNAME);
20
21        // イテレータを使ってディレクトリ内の各項目をループ処理します。
22        // $path にはファイルやディレクトリのパス名が直接入ります。
23        foreach ($iterator as $path) {
24            echo $path . PHP_EOL;
25        }
26    } catch (UnexpectedValueException $e) {
27        // ディレクトリが見つからない、またはアクセス許可がない場合の例外処理
28        echo "エラー: ディレクトリを読み込めませんでした。" . $e->getMessage() . PHP_EOL;
29    }
30}
31
32// 関数を実行して、現在のディレクトリの内容を表示します。
33listCurrentDirectoryContentsAsPathname();

PHP 8で提供されるFilesystemIterator::CURRENT_AS_PATHNAMEは、FilesystemIteratorクラスで使用する定数です。この定数自体に引数や戻り値はありませんが、FilesystemIteratorの動作を制御する役割を持ちます。通常、FilesystemIteratorはディレクトリ内の各項目をSplFileInfoオブジェクトとして返しますが、このCURRENT_AS_PATHNAME定数を指定することで、各項目をSplFileInfoオブジェクトではなく、ファイルやディレクトリの「パス名文字列」として直接取得できるようになります。

これは、ファイルパスの情報だけを簡潔に、かつ迅速に取得したい場合に非常に便利です。サンプルコードでは、listCurrentDirectoryContentsAsPathname関数が現在のディレクトリの内容をパス名として一覧表示します。new FilesystemIterator('.', FilesystemIterator::CURRENT_AS_PATHNAME)と記述することで、現在のディレクトリ（'.'）を走査する際に、各要素がパス名文字列として扱われるよう設定されています。そのため、foreachループで$iteratorを走査すると、$path変数には直接、ファイルやディレクトリのパス名が文字列として格納され、そのまま表示されます。もしディレクトリが見つからないなどの問題が発生した場合は、try-catchブロックによってエラーメッセージが表示されるようになっています。