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

Copy
1<?php
2
3/**
4 * このスクリプトは FilesystemIterator::getRealPath() メソッドの動作をデモンストレーションします。
5 * 特にシンボリックリンクが存在する場合に、getRealPath() がどのように実際のパスを解決するかを示します。
6 * これは、Laravelなどのフレームワークがデプロイ時に 'storage:link' のようなシンボリックリンクを使用する
7 * シナリオを理解するのに役立ちます。
8 */
9
10// デモンストレーション用の仮ディレクトリを定義
11$tempDir = __DIR__ . '/temp_files_example';
12
13/**
14 * 指定されたディレクトリとその内容を再帰的に削除するヘルパー関数
15 */
16function cleanUpTempDir(string $dir): void
17{
18    if (!is_dir($dir)) {
19        return;
20    }
21
22    // ディレクトリとファイルを再帰的に走査
23    // RecursiveDirectoryIterator::SKIP_DOTS で '.' と '..' をスキップ
24    // RecursiveIteratorIterator::CHILD_FIRST で子要素から先に処理 (ファイル削除後にディレクトリ削除)
25    $iterator = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS);
26    $files = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::CHILD_FIRST);
27
28    foreach ($files as $file) {
29        // getRealPath() が実際のパスを返すため、それを削除対象とする。
30        // ただし、getRealPath() が失敗した場合（例: 壊れたシンボリックリンク）、
31        // getPathname() で取得したパスを削除対象とする。
32        $pathToDelete = $file->getRealPath() ?: $file->getPathname();
33
34        if (is_dir($pathToDelete)) {
35            @rmdir($pathToDelete); // エラーを抑制してディレクトリを削除
36        } else {
37            @unlink($pathToDelete); // エラーを抑制してファイルを削除
38        }
39    }
40    @rmdir($dir); // エラーを抑制してルートディレクトリを削除
41    echo "一時ディレクトリ '{$dir}' をクリーンアップしました。\n";
42}
43
44// スクリプトの実行終了時に必ず一時ディレクトリをクリーンアップするように登録
45register_shutdown_function(fn() => cleanUpTempDir($tempDir));
46
47try {
48    // 1. 一時ディレクトリを作成
49    if (!is_dir($tempDir) && !mkdir($tempDir, 0777, true)) {
50        throw new RuntimeException("一時ディレクトリの作成に失敗しました: {$tempDir}");
51    }
52    echo "一時ディレクトリを作成しました: {$tempDir}\n";
53
54    // 2. いくつかのファイルとサブディレクトリを作成
55    file_put_contents("{$tempDir}/file1.txt", "file1 の内容.");
56    mkdir("{$tempDir}/sub_dir");
57    file_put_contents("{$tempDir}/sub_dir/file2.txt", "file2 の内容.");
58
59    // 3. シンボリックリンクの作成 (Laravel の storage:link のようなシナリオをシミュレート)
60    $symlinkTargetDir = "{$tempDir}/actual_storage_data";
61    $symlinkPath = "{$tempDir}/public_storage_link"; // 'public/storage' へのシンボリックリンクをシミュレート
62
63    if (!is_dir($symlinkTargetDir) && !mkdir($symlinkTargetDir, 0777, true)) {
64        throw new RuntimeException("シンボリックリンクのターゲットディレクトリ作成に失敗しました: {$symlinkTargetDir}");
65    }
66    file_put_contents("{$symlinkTargetDir}/important_data.txt", "これは重要なストレージデータです。");
67    echo "シンボリックリンクのターゲットディレクトリを作成しました: {$symlinkTargetDir}\n";
68
69    // 既存のシンボリックリンクがあれば削除
70    if (file_exists($symlinkPath) || is_link($symlinkPath)) {
71        @unlink($symlinkPath);
72    }
73    if (!symlink($symlinkTargetDir, $symlinkPath)) {
74        // Windows環境では、管理者権限がないとシンボリックリンクの作成に失敗する場合があります。
75        echo "警告: シンボリックリンクの作成に失敗しました。この環境ではサポートされていないか、権限が不足している可能性があります。\n";
76    } else {
77        echo "シンボリックリンクを作成しました: {$symlinkPath} -> {$symlinkTargetDir}\n\n";
78    }
79
80    echo "--- '{$tempDir}' を FilesystemIterator で走査 --- \n";
81    // FilesystemIterator を使用して一時ディレクトリを走査
82    // FilesystemIterator::SKIP_DOTS は '.' と '..' をスキップします。
83    // FilesystemIterator::KEY_AS_PATHNAME はキーとして完全なパス名を使用しますが、
84    // ここでは $fileInfo->getPathname() でパスを取得します。
85    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_PATHNAME);
86
87    foreach ($iterator as $fileInfo) {
88        $pathname = $fileInfo->getPathname(); // イテレータから見えるパス
89        $realPath = $fileInfo->getRealPath(); // 絶対パス、シンボリックリンクを解決した実際のパス
90
91        echo "  パス名 (pathname): {$pathname}\n";
92        echo "  実際のパス (realPath): " . ($realPath !== false ? $realPath : '実際のパスを解決できませんでした') . "\n";
93
94        // シンボリックリンクの場合、違いを強調表示
95        if ($fileInfo->isLink()) {
96            echo "    (これはシンボリックリンクです。getRealPath() はそのターゲットを解決します。)\n";
97        }
98        echo "--------------------------------------------------\n";
99    }
100
101} catch (RuntimeException $e) {
102    echo "エラー: " . $e->getMessage() . "\n";
103}
104
105// スクリプト終了時に register_shutdown_function に登録されたクリーンアップ関数が自動的に呼び出されます。
106
107?>

PHPのFilesystemIterator::getRealPath()メソッドは、ファイルシステムを効率的に走査する際に、各ファイルやディレクトリの「実際の物理パス」を取得するために使用されます。このメソッドは引数を取らずに呼び出され、成功した場合はそのファイルやディレクトリへの絶対パスを示す文字列を返します。もしパスの解決に失敗した場合はfalseを返します。

このメソッドの大きな特徴は、シンボリックリンクが存在する場合にそのリンク先を解決して、元の物理的なパスを教えてくれる点です。例えば、FilesystemIteratorがシンボリックリンクを見つけた際、getPathname()メソッドはシンボリックリンク自身のパスを返しますが、getRealPath()はシンボリックリンクが指し示している「本来の」ファイルやディレクトリのパスを特定してくれます。

これは、Laravelフレームワークでstorage:linkコマンドを使ってストレージディレクトリへのシンボリックリンクを作成するような、実際のWebアプリケーション開発のシナリオで役立ちます。リンクを介してファイルにアクセスする際に、その実体を正確に把握することで、ファイルの操作や権限の確認を誤りなく行うことが可能になります。このように、ファイルパスを正確に特定し、堅牢なシステムを構築する上でgetRealPath()は非常に重要な機能を提供します。