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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator と getPathname メソッドの動作を示す関数。
5 * 一時ディレクトリを作成し、その中のファイルやディレクトリのパス名を表示後、クリーンアップします。
6 */
7function demonstrateGetPathname(): void
8{
9    // 一時ディレクトリのパスを定義します。
10    // __DIR__ は現在のスクリプトファイルが存在するディレクトリのパスを示します。
11    $tempDir = __DIR__ . '/temp_for_pathname_demo';
12
13    // 以前の実行で残ったディレクトリが存在する場合、完全に削除します。
14    // RecursiveIteratorIterator を使用して、サブディレクトリやファイルも全て削除します。
15    if (is_dir($tempDir)) {
16        echo "既存の一時ディレクトリ '{$tempDir}' をクリーンアップ中...\n";
17        // CHILD_FIRST を指定することで、ファイルやサブディレクトリを先に削除し、その後空になったディレクトリを削除します。
18        $it = new RecursiveIteratorIterator(
19            new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
20            RecursiveIteratorIterator::CHILD_FIRST
21        );
22        foreach ($it as $item) {
23            if ($item->isDir()) {
24                rmdir($item->getRealPath());
25            } else {
26                unlink($item->getRealPath());
27            }
28        }
29        rmdir($tempDir);
30        echo "クリーンアップが完了しました。\n";
31    }
32
33    // 一時ディレクトリを作成します。
34    // 0777 はディレクトリのアクセス権限（全てのユーザーが読み書き実行可能）を設定します。
35    // true は、必要であれば親ディレクトリも再帰的に作成することを示します。
36    if (!mkdir($tempDir, 0777, true)) {
37        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
38        return;
39    }
40    echo "一時ディレクトリ '{$tempDir}' を作成しました。\n";
41
42    // テスト用のファイルとサブディレクトリを作成します。
43    file_put_contents($tempDir . '/file1.txt', 'これはファイル1の内容です。');
44    mkdir($tempDir . '/subdir', 0777, true);
45    file_put_contents($tempDir . '/subdir/file2.txt', 'これはファイル2の内容です。');
46    mkdir($tempDir . '/subdir/empty_subdir', 0777, true); // 空のサブディレクトリも作成
47
48    echo "テスト用のファイルとサブディレクトリを作成しました。\n\n";
49
50    // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用してディレクトリを再帰的に走査します。
51    // RecursiveDirectoryIterator::SKIP_DOTS: '.' と '..' の特殊なディレクトリを除外します。
52    // RecursiveIteratorIterator::SELF_FIRST: ディレクトリ自体が走査の最初の項目として返され、次にその内容が返されます。
53    echo "一時ディレクトリ内の項目パス名:\n";
54    try {
55        $iterator = new RecursiveIteratorIterator(
56            new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
57            RecursiveIteratorIterator::SELF_FIRST
58        );
59
60        foreach ($iterator as $item) {
61            // getPathname() メソッドは、現在の要素のフルパス名（ベースディレクトリからの相対パス）を返します。
62            // 例えば、'temp_for_pathname_demo/file1.txt' や 'temp_for_pathname_demo/subdir' など。
63            echo " - " . $item->getPathname() . "\n";
64        }
65    } catch (UnexpectedValueException $e) {
66        // ディレクトリが見つからない、またはアクセスできない場合に発生する可能性があります。
67        echo "エラー: ディレクトリ '{$tempDir}' を開けませんでした。メッセージ: " . $e->getMessage() . "\n";
68    } finally {
69        // 関数終了時に必ず後処理として、作成したディレクトリとファイルを削除します。
70        echo "\n後処理: 作成したディレクトリとファイルを削除します。\n";
71        // CHILD_FIRST を指定し、ファイルやサブディレクトリを先に削除します。
72        $it = new RecursiveIteratorIterator(
73            new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
74            RecursiveIteratorIterator::CHILD_FIRST
75        );
76
77        foreach ($it as $item) {
78            if ($item->isDir()) {
79                rmdir($item->getRealPath()); // 空になったディレクトリを削除
80            } else {
81                unlink($item->getRealPath()); // ファイルを削除
82            }
83        }
84        rmdir($tempDir); // ルートディレクトリも削除
85        echo "一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
86    }
87}
88
89// 関数を実行します。
90demonstrateGetPathname();

PHP 8のRecursiveDirectoryIteratorクラスに属するgetPathnameメソッドは、ディレクトリ構造を再帰的に走査する際に、現在の要素（ファイルまたはサブディレクトリ）のパス名を取得するために利用されます。このメソッドは引数を一切取らず、現在の要素のパス名を表す文字列を返します。返されるパス名は、通常、走査を開始したベースディレクトリからの相対パスとして表現されます。

提供されたサンプルコードでは、一時的なディレクトリと複数のファイル、サブディレクトリを作成し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてその内容を走査しています。ループ処理の中で$item->getPathname()を呼び出すことで、例えば「temp_for_pathname_demo/file1.txt」や「temp_for_pathname_demo/subdir/file2.txt」のように、一時ディレクトリ内の各ファイルやサブディレクトリのパス名が取得され、画面に表示される様子を確認できます。この機能は、特定のディレクトリ以下にあるファイルやフォルダのパスを一覧表示したり、それらのパスを使ってさらなるファイル操作を行ったりする際に非常に便利です。ファイルシステムの内容を探索し、そのパス情報を取得する基本的な操作として広く活用されます。