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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリを再帰的に走査し、各ファイル/ディレクトリのリアルパスを表示します。
5 *
6 * システムエンジニアを目指す初心者向けに、PHPのファイルシステム操作の基本である
7 * RecursiveDirectoryIterator と getRealPath() メソッドの使用法を示します。
8 *
9 * Laravelのようなフレームワークを使用している場合でも、基盤となるPHPのファイルシステム機能は
10 * 同様に利用できます。例えば、Laravelプロジェクト内の 'public' ディレクトリや
11 * 'storage/app' ディレクトリの内容を走査し、シンボリックリンクを解決した
12 * 実際のファイルパス（リアルパス）を取得する際に役立ちます。
13 *
14 * @param string $directoryPath 走査するディレクトリのパス
15 * @return void
16 */
17function walkDirectoryAndGetRealPaths(string $directoryPath): void
18{
19    // 指定されたパスがディレクトリでない場合はエラーメッセージを表示して終了
20    if (!is_dir($directoryPath)) {
21        echo "エラー: 指定されたパス '{$directoryPath}' は有効なディレクトリではありません。\n";
22        echo "このサンプルを実行する前に、存在するディレクトリパスを指定してください。\n";
23        echo "例: Laravelプロジェクトの 'public' ディレクトリ ('/path/to/your-laravel-app/public')\n";
24        return;
25    }
26
27    echo "ディレクトリ '{$directoryPath}' 内のアイテムとリアルパス:\n";
28
29    try {
30        // RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査します。
31        // RecursiveDirectoryIterator::SKIP_DOTS は '.' (現在のディレクトリ) と '..' (親ディレクトリ) をスキップします。
32        $directoryIterator = new RecursiveDirectoryIterator($directoryPath, RecursiveDirectoryIterator::SKIP_DOTS);
33
34        // RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて
35        // ディレクトリツリー全体（サブディレクトリ含む）を深く走査するために使用します。
36        // RecursiveIteratorIterator::SELF_FIRST は、サブディレクトリの内容より先に
37        // ディレクトリ自体を返すようにします。
38        $iterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
39
40        foreach ($iterator as $item) {
41            // RecursiveDirectoryIterator::getRealPath() は、現在のイテレータが指す
42            // ファイルまたはディレクトリのシンボリックリンクを解決した完全な物理パスを返します。
43            // パスが存在しない、またはアクセス権がない場合は false を返します。
44            $realPath = $item->getRealPath();
45
46            // リアルパスが正常に取得できたか確認
47            if ($realPath !== false) {
48                // ファイルまたはディレクトリのパス名とリアルパスを表示
49                // getPathname() は元のパス、getRealPath() は解決された物理パスです。
50                echo "  - オリジナルパス: " . $item->getPathname() . "\n";
51                echo "    リアルパス:     " . $realPath . "\n";
52            } else {
53                // リアルパスの取得に失敗した場合
54                echo "  - オリジナルパス: " . $item->getPathname() . "\n";
55                echo "    リアルパスの取得に失敗しました (ファイルが存在しないかアクセス権の問題の可能性)。\n";
56            }
57        }
58    } catch (RuntimeException $e) {
59        // ディレクトリへのアクセス権がない、またはその他のファイルシステムエラーを捕捉
60        echo "エラーが発生しました: " . $e->getMessage() . "\n";
61    }
62}
63
64// -----------------------------------------------------------------------------
65// サンプル実行
66// -----------------------------------------------------------------------------
67
68// ここに、実際に存在するディレクトリのパスを指定してください。
69// 例として、このスクリプトが存在するディレクトリをデフォルトとしますが、
70// 実際にはLaravelプロジェクト内のパスなどに変更してください。
71//
72// 例: Laravelプロジェクトの `public` ディレクトリ
73// $targetDirectory = '/path/to/your-laravel-app/public';
74//
75// テストのために、以下のコマンドで一時的なディレクトリとファイルを作成してから実行すると便利です。
76// (Linux/macOSの場合)
77// mkdir -p /tmp/my_test_dir/sub_folder
78// touch /tmp/my_test_dir/file1.txt
79// touch /tmp/my_test_dir/sub_folder/file2.log
80// ln -s /tmp/my_test_dir/file1.txt /tmp/my_test_dir/symlink_to_file1.txt
81//
82// その後、$targetDirectory を '/tmp/my_test_dir' に設定して実行してください。
83$targetDirectory = __DIR__; 
84
85// 関数を呼び出してディレクトリを走査し、リアルパスを取得します。
86walkDirectoryAndGetRealPaths($targetDirectory);

PHPのgetRealPath()メソッドは、RecursiveDirectoryIteratorクラスに属し、ファイルやディレクトリのシンボリックリンクを解決した実際の物理パス（リアルパス）を取得する際に利用されます。このメソッドは引数を取りません。戻り値は、リアルパスが正常に取得できた場合は文字列としてパスを返し、失敗した場合はfalseを返します。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使い、指定されたディレクトリをサブディレクトリ含め再帰的に走査します。走査中に見つかる各ファイルやディレクトリに対してgetRealPath()を呼び出し、元のパス名とシンボリックリンクが解決された後の物理的なパスを表示しています。これにより、シンボリックリンクを含む複雑なファイル構造であっても、ファイルやディレクトリの実際の保存場所を正確に把握することが可能です。Laravelなどのフレームワークを利用したプロジェクトでも、ファイルの物理的な位置を特定する基礎的な機能として活用できます。