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

Copy
1<?php
2
3/**
4 * DirectoryIterator::getRealPath() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたディレクトリを走査し、各ファイルおよびディレクトリの
7 * 実際のパス（シンボリックリンクを解決した絶対パス）を表示します。
8 * Laravelプロジェクトなど、ファイルシステムを扱うアプリケーションにおいて、
9 * パス解決の理解を深めるのに役立ちます。
10 */
11function demonstrateGetRealPath(): void
12{
13    // テスト用のディレクトリとファイルを設定します。
14    // Laravelプロジェクトのstorage/appディレクトリやpublicディレクトリなどを
15    // 仮想的に作成するイメージです。
16    $testDir = __DIR__ . DIRECTORY_SEPARATOR . 'test_directory_for_getrealpath';
17    $file1Path = $testDir . DIRECTORY_SEPARATOR . 'file1.txt';
18    $subDirPath = $testDir . DIRECTORY_SEPARATOR . 'sub_directory';
19    $file2Path = $subDirPath . DIRECTORY_SEPARATOR . 'file2.txt';
20    $symlinkPath = $testDir . DIRECTORY_SEPARATOR . 'link_to_file1.txt';
21
22    // ヘルパー関数: ディレクトリを再帰的に削除します。
23    $deleteDirectory = function (string $dir) use (&$deleteDirectory): void {
24        if (!is_dir($dir)) {
25            return;
26        }
27        $items = new FilesystemIterator($dir, FilesystemIterator::SKIP_DOTS);
28        foreach ($items as $item) {
29            if ($item->isDir()) {
30                $deleteDirectory($item->getPathname());
31            } else {
32                // ファイルまたはシンボリックリンクを削除
33                unlink($item->getPathname());
34            }
35        }
36        rmdir($dir);
37    };
38
39    // 既存のテストディレクトリがあれば削除し、新しく作成します。
40    if (file_exists($testDir)) {
41        $deleteDirectory($testDir);
42    }
43
44    // テストディレクトリの作成
45    if (!mkdir($testDir, 0777, true)) {
46        echo "エラー: テストディレクトリ '{$testDir}' の作成に失敗しました。\n";
47        return;
48    }
49    if (!mkdir($subDirPath, 0777, true)) {
50        echo "エラー: サブディレクトリ '{$subDirPath}' の作成に失敗しました。\n";
51        $deleteDirectory($testDir); // 作成途中で失敗した場合のクリーンアップ
52        return;
53    }
54
55    // テストファイルの作成
56    file_put_contents($file1Path, 'これはファイル1の内容です。');
57    file_put_contents($file2Path, 'これはファイル2の内容です。');
58
59    // シンボリックリンクの作成
60    // Windows環境では管理者権限が必要な場合があります。
61    if (PHP_OS_FAMILY === 'Windows' && !@symlink($file1Path, $symlinkPath)) {
62        echo "警告: Windows環境でシンボリックリンク '{$symlinkPath}' の作成に失敗したか、サポートされていません。\n";
63        echo "      (管理者権限が必要な場合があります。この例では続行します。)\n";
64    } elseif (PHP_OS_FAMILY !== 'Windows') {
65        symlink($file1Path, $symlinkPath);
66    }
67
68
69    echo "ディレクトリ '{$testDir}' の内容を走査します:\n";
70    echo "--------------------------------------------------\n";
71
72    try {
73        $iterator = new DirectoryIterator($testDir);
74
75        foreach ($iterator as $fileinfo) {
76            // '.' (現在のディレクトリ) と '..' (親ディレクトリ) のエントリはスキップします。
77            if ($fileinfo->isDot()) {
78                continue;
79            }
80
81            $name = $fileinfo->getFilename();    // ファイルまたはディレクトリの名前
82            $path = $fileinfo->getPathname();    // そのエントリのパス (相対または絶対)
83
84            // getRealPath() はシンボリックリンクを解決し、
85            // そのエントリの実際の絶対パスを返します。
86            // 存在しないファイルやアクセスできない場合は false を返すことがあります。
87            $realPath = $fileinfo->getRealPath();
88
89            echo "ファイル名: " . $name . "\n";
90            echo "  パス (getPathname): " . $path . "\n";
91
92            if ($realPath === false) {
93                echo "  実際のパス (getRealPath): 取得失敗 (ファイルが存在しないか、アクセスできません)\n";
94            } else {
95                echo "  実際のパス (getRealPath): " . $realPath . "\n";
96            }
97
98            // エントリがシンボリックリンクであるか確認します。
99            if ($fileinfo->isLink()) {
100                echo "  (これはシンボリックリンクです。)\n";
101            }
102            echo "--------------------------------------------------\n";
103        }
104    } catch (UnexpectedValueException $e) {
105        // 指定されたパスがディレクトリでない場合や、存在しない場合に発生します。
106        echo "エラー: ディレクトリ '{$testDir}' が存在しないか、アクセスできません。\n";
107        echo "  詳細: " . $e->getMessage() . "\n";
108    } finally {
109        // テスト用ディレクトリとファイルをクリーンアップします。
110        echo "\nテスト環境をクリーンアップ中...\n";
111        $deleteDirectory($testDir);
112
113        if (!file_exists($testDir)) {
114            echo "クリーンアップが完了しました。\n";
115        } else {
116            echo "警告: クリーンアップに失敗したディレクトリが存在する可能性があります。\n";
117        }
118    }
119}
120
121// 関数の実行
122demonstrateGetRealPath();

DirectoryIterator::getRealPath()は、PHP 8で利用できるDirectoryIteratorクラスのメソッドです。このメソッドは、ファイルやディレクトリの「実際のパス」、つまりシンボリックリンクを解決した後の絶対パスを取得するために使用されます。

引数は不要で、戻り値は解決された絶対パスを示す文字列（string）か、ファイルが存在しない、またはアクセスできない場合にfalseを返します。例えば、Laravelプロジェクトなどでファイルシステム上のパスを扱う際、シンボリックリンクが設定されている場合にそのリンク先の実体パスを正確に把握したい場合に非常に役立ちます。

このメソッドを使用することで、見かけ上のパスではなく、オペレーティングシステムが認識する真の物理的な位置を特定できます。これにより、パスの誤解釈による予期せぬ問題を避け、アプリケーションの堅牢性を高めることが可能です。サンプルコードでは、シンボリックリンクを含むファイルを実際に作成し、getRealPath()がどのように真のパスを返すかを示しています。