【PHP8.x】RecursiveDirectoryIterator::getSubPath()メソッドの使い方

Copy
1<?php
2
3/**
4 * テスト用のディレクトリとファイルを作成します。
5 *
6 * @param string $baseDir ベースとなるディレクトリのパス
7 */
8function createTestDirectory(string $baseDir): void
9{
10    // ベースディレクトリが存在しない場合は作成します
11    if (!is_dir($baseDir)) {
12        mkdir($baseDir, 0777, true);
13    }
14
15    // サブディレクトリとファイルを作成します
16    mkdir($baseDir . '/project_root', 0777);
17    mkdir($baseDir . '/project_root/src', 0777);
18    file_put_contents($baseDir . '/project_root/src/index.php', '<?php echo "Hello";');
19    mkdir($baseDir . '/project_root/src/Controller', 0777);
20    file_put_contents($baseDir . '/project_root/src/Controller/UserController.php', '<?php class UserController {}');
21    mkdir($baseDir . '/project_root/config', 0777);
22    file_put_contents($baseDir . '/project_root/config/app.ini', '[app]');
23    file_put_contents($baseDir . '/project_root/.env', 'APP_ENV=dev');
24
25    echo "--- テストディレクトリ構造を生成しました ---\n";
26    echo "以下の構造で一時ディレクトリが作成されました:\n";
27    echo $baseDir . "\n";
28    echo "└── project_root/\n";
29    echo "    ├── src/\n";
30    echo "    │   ├── index.php\n";
31    echo "    │   └── Controller/\n";
32    echo "    │       └── UserController.php\n";
33    echo "    ├── config/\n";
34    echo "    │   └── app.ini\n";
35    echo "    └── .env\n\n";
36}
37
38/**
39 * テスト用のディレクトリとファイルを再帰的に削除します。
40 *
41 * @param string $dir 削除するディレクトリのパス
42 */
43function deleteTestDirectory(string $dir): void
44{
45    if (!is_dir($dir)) {
46        return;
47    }
48
49    // ディレクトリ内のすべての要素を再帰的に取得
50    $files = new RecursiveIteratorIterator(
51        new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
52        RecursiveIteratorIterator::CHILD_FIRST // 子要素から削除するためにCHILD_FIRSTを指定
53    );
54
55    foreach ($files as $fileinfo) {
56        // ディレクトリであれば削除し、ファイルであればリンクを解除
57        if ($fileinfo->isDir()) {
58            rmdir($fileinfo->getRealPath());
59        } else {
60            unlink($fileinfo->getRealPath());
61        }
62    }
63    // 空になった親ディレクトリを削除
64    rmdir($dir);
65    echo "\n--- テストディレクトリを削除しました ---: " . $dir . "\n";
66}
67
68/**
69 * RecursiveDirectoryIterator::getSubPath() メソッドの動作をデモンストレーションします。
70 *
71 * getSubPath() は、RecursiveDirectoryIterator の基点ディレクトリからの相対パスのうち、
72 * 現在の要素（ファイルまたはディレクトリ）の「名前」より上位のディレクトリパスを返します。
73 * 例えば、基点が '/base' でファイルが '/base/dir1/dir2/file.txt' の場合、
74 * getSubPath() は 'dir1/dir2' を返します。
75 */
76function demonstrateGetSubPath(): void
77{
78    // 一時的なディレクトリ名を定義します
79    $tempBaseDir = __DIR__ . '/php_getsubpath_example';
80    $targetDir = $tempBaseDir . '/project_root'; // イテレータの基点となるディレクトリ
81
82    // テスト用のディレクトリ構造を作成します
83    createTestDirectory($tempBaseDir);
84
85    try {
86        echo "--- RecursiveDirectoryIterator::getSubPath() の出力 --- \n";
87        echo "（イテレータの基点 ('" . $targetDir . "') からの相対パスのうち、\n";
88        echo "   現在の要素のファイル名や最終ディレクトリ名を除いた上位パスを示します）\n\n";
89
90        // RecursiveDirectoryIterator を初期化します。
91        // $targetDir を基準としてディレクトリを走査します。
92        // SKIP_DOTS は . と .. をスキップします。
93        $iterator = new RecursiveIteratorIterator(
94            new RecursiveDirectoryIterator($targetDir, RecursiveDirectoryIterator::SKIP_DOTS),
95            RecursiveIteratorIterator::SELF_FIRST // ディレクトリ自身も走査対象に含めます
96        );
97
98        // ディレクトリ内のすべてのファイルとディレクトリを走査します
99        foreach ($iterator as $path => $fileInfo) {
100            // 現在の要素のフルパス
101            $pathname = $fileInfo->getPathname();
102            // 現在の要素のファイル名またはディレクトリ名
103            $filename = $fileInfo->getFilename();
104            // getSubPath() メソッドを呼び出し、基点からの相対パスの上位部分を取得します
105            $subPath = $fileInfo->getSubPath();
106
107            echo "要素名: " . $filename . "\n";
108            echo "フルパス: " . $pathname . "\n";
109            echo "getSubPath() の結果: '" . $subPath . "'\n"; // シングルクォートで囲むことで空文字列が視覚的に分かりやすくなります
110            echo "--------------------------------------------------\n";
111        }
112    } catch (UnexpectedValueException $e) {
113        // ディレクトリが存在しないなどのエラーが発生した場合のハンドリング
114        echo "エラーが発生しました: " . $e->getMessage() . "\n";
115    } finally {
116        // テスト用のディレクトリ構造を必ず削除します
117        deleteTestDirectory($tempBaseDir);
118    }
119}
120
121// デモンストレーション関数を実行します
122demonstrateGetSubPath();
123

PHP 8で提供されるRecursiveDirectoryIteratorクラスのgetSubPath()メソッドは、ディレクトリ構造を再帰的に走査する際に、現在の要素がどのサブディレクトリに位置しているかを示す相対パスを取得するために使用されます。このメソッドは引数を必要とせず、常に文字列を戻り値として返します。

具体的には、getSubPath()は、RecursiveDirectoryIteratorが走査を開始した基点ディレクトリからの相対パスのうち、現在処理しているファイルまたはディレクトリ自身の名前を除いた上位のディレクトリパスを返します。例えば、イテレータの基点が「project_root」で、現在の要素が「project_root/src/Controller/UserController.php」の場合、getSubPath()は「src/Controller」という文字列を返します。もし現在の要素が基点ディレクトリ直下に存在する場合、上位パスは存在しないため、空の文字列が返されます。

この機能は、アプリケーションのファイル構造を解析したり、特定の階層にあるファイルを識別して処理を行うなど、ディレクトリツリーを扱う多くの場面で役立ちます。サンプルコードでは、実際のディレクトリ構造を作成し、その中の各ファイルやディレクトリに対してgetSubPath()がどのような値を返すかを具体的に示しており、メソッドの挙動を明確に理解できます。