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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとそのサブディレクトリ内のすべてのファイルおよびディレクトリのパス名を再帰的に一覧表示します。
5 *
6 * RecursiveDirectoryIterator::CURRENT_AS_PATHNAME 定数を使用することで、
7 * イテレータが SplFileInfo オブジェクトではなく、直接パス名の文字列を返すようになります。
8 * これにより、foreach ループ内で各要素がすぐに利用可能なパス名として取得されます。
9 *
10 * @param string $directoryPath 走査を開始するディレクトリのパス。デフォルトはカレントディレクトリ。
11 */
12function listRecursivePathsAsPathname(string $directoryPath = '.'): void
13{
14    echo "--- ディレクトリ '$directoryPath' 内のパス名一覧 ---\n";
15
16    try {
17        // RecursiveDirectoryIterator を使用してディレクトリを走査します。
18        // - SKIP_DOTS: "." (カレントディレクトリ) と ".." (親ディレクトリ) をスキップします。
19        // - CURRENT_AS_PATHNAME: イテレータが返す要素を SplFileInfo オブジェクトではなく、
20        //   ファイルやディレクトリのパス名（文字列）にします。
21        $directoryIterator = new RecursiveDirectoryIterator(
22            $directoryPath,
23            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::CURRENT_AS_PATHNAME
24        );
25
26        // RecursiveIteratorIterator を使用して、サブディレクトリも含めて再帰的に走査します。
27        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
28
29        // 各要素をイテレートし、パス名を表示します。
30        foreach ($recursiveIterator as $path) {
31            // CURRENT_AS_PATHNAME フラグのおかげで、$path は直接ファイルやディレクトリのパス名（文字列）になります。
32            echo $path . "\n";
33        }
34    } catch (UnexpectedValueException $e) {
35        // 指定されたパスがディレクトリでない場合や、アクセス権がない場合などのエラーを捕捉します。
36        echo "エラー: ディレクトリ '$directoryPath' を開けませんでした。メッセージ: " . $e->getMessage() . "\n";
37    }
38
39    echo "----------------------------------------\n";
40}
41
42// 例: このスクリプトが実行されているカレントディレクトリを走査します。
43listRecursivePathsAsPathname();
44
45// 特定のディレクトリを走査する例 (必要に応じてコメント解除して使用)
46// listRecursivePathsAsPathname('/tmp');

PHPのRecursiveDirectoryIterator::CURRENT_AS_PATHNAME定数は、ディレクトリを再帰的に走査する際に、イテレータが返す値の形式を指定するためのものです。この定数をRecursiveDirectoryIteratorのコンストラクタに渡して使用すると、通常であればファイルやディレクトリの詳細な情報を保持するSplFileInfoオブジェクトが返される代わりに、直接ファイルやディレクトリのパス名を表す文字列が返されるようになります。

サンプルコードでは、listRecursivePathsAsPathname関数内でRecursiveDirectoryIterator::SKIP_DOTS定数と組み合わせてCURRENT_AS_PATHNAME定数を使用しています。これにより、カレントディレクトリと親ディレクトリをスキップしつつ、指定されたディレクトリとそのサブディレクトリ内のすべてのファイルやディレクトリのパスが、foreachループで $path 変数に直接文字列として取得され、表示されます。オブジェクトからパス名を抽出する手間が省けるため、コードが簡潔になります。この定数自体には引数や直接の戻り値はありませんが、RecursiveDirectoryIteratorの挙動を制御し、パス名処理をシンプルにする効果があります。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::CURRENT_AS_PATHNAME 定数の使用例を示します。
5 *
6 * この定数を RecursiveDirectoryIterator のフラグとして使用すると、
7 * イテレーション中に返される要素が SplFileInfo オブジェクトではなく、
8 * 直接ファイルやディレクトリのパス名（文字列）になります。
9 * これにより、取得した要素をそのままパスとして利用できます。
10 *
11 * @param string $directory 走査する開始ディレクトリのパス。デフォルトはカレントディレクトリ。
12 * @return void
13 */
14function walkDirectoryWithPaths(string $directory = '.'): void
15{
16    echo "指定されたディレクトリ '$directory' を走査し、パス名を出力します。\n";
17    echo "--------------------------------------------------------\n";
18
19    try {
20        // RecursiveDirectoryIterator をインスタンス化します。
21        // 第2引数には、以下のフラグを OR (|) で結合して渡します。
22        // - RecursiveDirectoryIterator::SKIP_DOTS: "." と ".." ディレクトリをスキップします。
23        // - RecursiveDirectoryIterator::CURRENT_AS_PATHNAME:
24        //   これにより、イテレーション中に返す要素が SplFileInfo オブジェクトではなく、
25        //   ファイルやディレクトリのパス名（文字列）になります。
26        $dirIterator = new RecursiveDirectoryIterator(
27            $directory,
28            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::CURRENT_AS_PATHNAME
29        );
30
31        // RecursiveIteratorIterator で RecursiveDirectoryIterator をラップすることで、
32        // サブディレクトリも再帰的に走査できるようになります。
33        $iterator = new RecursiveIteratorIterator($dirIterator);
34
35        $count = 0;
36        foreach ($iterator as $path) {
37            // CURRENT_AS_PATHNAME フラグのおかげで、$path は直接ファイルまたはディレクトリのパス名（文字列）です。
38            echo "  - " . $path . "\n";
39            $count++;
40        }
41
42        if ($count === 0) {
43            echo "  (指定されたディレクトリ内にファイルやサブディレクトリが見つかりませんでした。)\n";
44        }
45
46    } catch (UnexpectedValueException $e) {
47        // 指定されたディレクトリが存在しない、またはアクセス権がない場合に発生します。
48        echo "エラー: ディレクトリ '$directory' に問題があります - " . $e->getMessage() . "\n";
49    } catch (Exception $e) {
50        // その他の予期せぬエラーを捕捉します。
51        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
52    }
53
54    echo "--------------------------------------------------------\n";
55    echo "処理が完了しました。\n";
56}
57
58// --- サンプルコードの実行 ---
59// このスクリプトが実行されるカレントディレクトリとそのサブディレクトリを走査します。
60// 実行前に、このスクリプトと同じディレクトリ内にいくつかのファイルやサブディレクトリを作成すると、
61// 出力を通じて動作をより明確に確認できます。
62//
63// 例: スクリプトと同じディレクトリに以下の構造を作成した場合
64//   - my_directory/
65//     - file1.txt
66//     - sub_folder/
67//       - file2.php
68//
69// 上記の場合の出力例:
70//   - my_directory
71//   - my_directory/file1.txt
72//   - my_directory/sub_folder
73//   - my_directory/sub_folder/file2.php
74
75walkDirectoryWithPaths();

PHP 8のRecursiveDirectoryIteratorクラスの定数CURRENT_AS_PATHNAMEは、ディレクトリの再帰的走査で、返される要素をファイルやディレクトリのフルパス名（文字列）として直接取得する際に使用します。通常は詳細情報を含むSplFileInfoオブジェクトが返されますが、この定数をRecursiveDirectoryIteratorのコンストラクタにフラグとして指定すると、取得した値をそのままパスとして利用でき、コードを簡潔に記述できます。

サンプルコードのwalkDirectoryWithPaths関数は、引数で指定されたディレクトリ（デフォルトはカレントディレクトリ）を再帰的に走査し、見つかった全パス名を出力します。RecursiveDirectoryIteratorのコンストラクタにRecursiveDirectoryIterator::SKIP_DOTSとCURRENT_AS_PATHNAMEを渡すことで、foreachループで取得される$path変数は直接文字列のパスとなります。この関数は、走査するディレクトリのパスを引数として受け取りますが、戻り値はありません（void）。RecursiveIteratorIteratorと併用することで、サブディレクトリ内部も効率的に深く走査することが可能です。