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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::getSubPathname の使用例を示す関数。
5 *
6 * この関数は、テスト用のディレクトリ構造を作成し、その中のファイルやディレクトリを再帰的に走査します。
7 * 各要素に対して RecursiveDirectoryIterator::getSubPathname メソッドを呼び出し、
8 * イテレーションの開始パスからの相対パス名を出力します。
9 * 最後に作成したテストディレクトリをクリーンアップします。
10 *
11 * システムエンジニアを目指す初心者の方へ:
12 * RecursiveDirectoryIterator は、ディレクトリ構造を再帰的に（つまり、サブディレクトリの中も）
13 * 走査するための PHP の組み込みクラスです。
14 * getSubPathname メソッドは、走査を開始したディレクトリからの相対パス（例: "subdir/file.txt"）を
15 * 返すため、特定のディレクトリ階層内でのファイルの場所を把握する際に非常に便利です。
16 */
17function demonstrateGetSubPathname(): void
18{
19    // 一時ディレクトリのベースパスを取得 (OSに依存しない一時ディレクトリパス)
20    $tempBaseDir = sys_get_temp_dir();
21    // テスト用のルートディレクトリを設定
22    // ユニークな名前を生成して、他のプロセスとの衝突を避けます
23    $testRootPath = $tempBaseDir . DIRECTORY_SEPARATOR . uniqid('php_recursive_test_', true);
24
25    echo "--- RecursiveDirectoryIterator::getSubPathname の使用例 ---\n\n";
26
27    // テスト用のディレクトリとファイル構造を作成
28    if (!createTestDirectoryStructure($testRootPath)) {
29        echo "エラー: テストディレクトリの作成に失敗しました。\n";
30        return;
31    }
32    echo "テストディレクトリ構造が作成されました: " . $testRootPath . "\n\n";
33
34    try {
35        // RecursiveDirectoryIterator を使用して指定されたパスからイテレーションを開始
36        // RecursiveDirectoryIterator::SKIP_DOTS は "." と ".." を無視するフラグです。
37        $directoryIterator = new RecursiveDirectoryIterator($testRootPath, RecursiveDirectoryIterator::SKIP_DOTS);
38
39        // RecursiveIteratorIterator を使用してディレクトリを再帰的に（サブディレクトリも）走査
40        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
41
42        echo "各要素の開始パスからの相対パス名 (getSubPathname) と絶対パス名 (getPathname):\n";
43        echo "---------------------------------------------------------\n";
44
45        foreach ($recursiveIterator as $fileInfo) {
46            // getSubPathname(): イテレータの開始パスからの相対パス名 (例: 'subdir1/file_c.php') を返します。
47            $subPathname = $fileInfo->getSubPathname();
48            // getPathname(): 要素の絶対パス名 (例: '/tmp/php_recursive_test_.../subdir1/file_c.php') を返します。
49            $pathname = $fileInfo->getPathname();
50
51            echo "  相対パス名 (getSubPathname): " . $subPathname . "\n";
52            echo "  絶対パス名 (getPathname):   " . $pathname . "\n";
53            echo "  ---------------------------------------------------------\n";
54        }
55    } catch (UnexpectedValueException $e) {
56        // ディレクトリが存在しない、またはアクセス権がない場合に発生する可能性があります。
57        echo "エラー: ディレクトリの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
58    } finally {
59        // テストディレクトリをクリーンアップ
60        if (cleanupTestDirectory($testRootPath)) {
61            echo "\nテストディレクトリ構造がクリーンアップされました: " . $testRootPath . "\n";
62        } else {
63            echo "\nエラー: テストディレクトリのクリーンアップに失敗しました: " . $testRootPath . "\n";
64        }
65    }
66}
67
68/**
69 * テスト用のディレクトリとファイル構造を作成するヘルパー関数。
70 *
71 * @param string $rootPath 作成するルートディレクトリのパス。
72 * @return bool 成功した場合は true、失敗した場合は false。
73 */
74function createTestDirectoryStructure(string $rootPath): bool
75{
76    // 既存のディレクトリがあれば削除してから作成（念のため）
77    if (is_dir($rootPath)) {
78        cleanupTestDirectory($rootPath);
79    }
80
81    // ルートディレクトリを作成 (true で再帰的にディレクトリを作成)
82    if (!mkdir($rootPath, 0777, true)) {
83        return false;
84    }
85
86    // ルートディレクトリ直下にファイルを作成
87    file_put_contents($rootPath . DIRECTORY_SEPARATOR . 'file_a.txt', '内容 A');
88    file_put_contents($rootPath . DIRECTORY_SEPARATOR . 'file_b.log', '内容 B');
89
90    // サブディレクトリ1を作成し、その中にファイルを作成
91    $subDir1 = $rootPath . DIRECTORY_SEPARATOR . 'subdir1';
92    if (!mkdir($subDir1, 0777, true)) { return false; }
93    file_put_contents($subDir1 . DIRECTORY_SEPARATOR . 'file_c.php', '<?php echo "ファイル C"; ?>');
94
95    // サブディレクトリ2を作成し、その中にファイルを作成
96    $subDir2 = $subDir1 . DIRECTORY_SEPARATOR . 'subdir2';
97    if (!mkdir($subDir2, 0777, true)) { return false; }
98    file_put_contents($subDir2 . DIRECTORY_SEPARATOR . 'file_d.json', '{"key": "value", "data": "D"}');
99
100    return true;
101}
102
103/**
104 * 指定されたディレクトリとその内容を再帰的に削除するヘルパー関数。
105 *
106 * @param string $dirPath 削除するディレクトリのパス。
107 * @return bool 成功した場合は true、失敗した場合は false。
108 */
109function cleanupTestDirectory(string $dirPath): bool
110{
111    // ディレクトリが存在しない場合は削除済みとみなして成功
112    if (!is_dir($dirPath)) {
113        return true;
114    }
115
116    // RecursiveIteratorIterator を使用してディレクトリ内のすべてのファイルとサブディレクトリを取得
117    // CHILD_FIRST は、子要素（ファイルやサブディレクトリ）から先に処理するために重要です。
118    $files = new RecursiveIteratorIterator(
119        new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::SKIP_DOTS),
120        RecursiveIteratorIterator::CHILD_FIRST
121    );
122
123    foreach ($files as $fileinfo) {
124        $path = $fileinfo->getRealPath();
125        if ($fileinfo->isDir()) {
126            // ディレクトリの場合、rmdir() で削除
127            if (!@rmdir($path)) { // @ suppresses "Directory not empty" warnings
128                return false;
129            }
130        } else {
131            // ファイルの場合、unlink() で削除
132            if (!@unlink($path)) { // @ suppresses "Permission denied" warnings
133                return false;
134            }
135        }
136    }
137
138    // すべての子要素を削除した後、ルートディレクトリを削除
139    return @rmdir($dirPath); // @ suppresses "Directory not empty" warnings
140}
141
142// サンプルコードを実行
143demonstrateGetSubPathname();
144
145?>

このPHPサンプルコードは、RecursiveDirectoryIteratorクラスのgetSubPathnameメソッドの利用方法を具体的に示しています。RecursiveDirectoryIteratorは、PHPでディレクトリ構造を再帰的に（つまり、サブディレクトリの中まで）効率良く走査するためのクラスです。

getSubPathnameメソッドは、所属クラスがRecursiveDirectoryIteratorであり、引数はなく、現在の要素（ファイルまたはディレクトリ）のパスを文字列として返します。このメソッドの大きな特徴は、イテレーションを開始したルートディレクトリからの「相対パス名」を返す点にあります。

コードでは、まず一時的なテストディレクトリ構造を作成します。次に、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてこのテストディレクトリを再帰的に走査します。foreachループの中で各ファイルやディレクトリ情報（$fileInfo）を取得し、$fileInfo->getSubPathname()を呼び出しています。これにより、例えばイテレーションの開始パスが/var/www/htmlで、対象ファイルが/var/www/html/assets/image.pngの場合、getSubPathnameはassets/image.pngのような相対パスを返します。この結果を絶対パスと比較しながら出力することで、相対パスの概念を明確に理解できます。この機能は、特定のディレクトリ階層におけるファイルの相対的な位置情報を取得したい場合に非常に役立ちます。最後に、作成したテストディレクトリはクリーンアップされます。