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

Copy
1<?php
2
3// このスクリプトは、SplFileObject::getRealPath() メソッドの使用方法を示します。
4// 特に、ファイルパスがシンボリックリンクである場合に、そのリンクが指す
5// ファイルの実体（物理的な）パスを取得するシナリオを想定しています。
6// Laravelアプリケーションでは、storage/app/public ディレクトリが public/storage にシンボリックリンクされることがあります。
7// そのような状況で、ファイルの真のパスを知りたい場合に役立つでしょう。
8
9// 一時ファイルのパスを定義します。スクリプトが実行されるディレクトリに作成されます。
10$originalFilePath = __DIR__ . '/temp_original_file.txt';
11$symlinkPath = __DIR__ . '/temp_symlink_for_test.txt';
12
13// --- 前準備: テスト用のファイルとシンボリックリンクを作成 ---
14
15// 1. 元となるファイルを作成します。
16if (file_put_contents($originalFilePath, 'This is a test file content.') === false) {
17    echo "エラー: 元ファイル '{$originalFilePath}' を作成できませんでした。\n";
18    exit(1);
19}
20echo "元ファイルを作成しました: {$originalFilePath}\n";
21
22// 2. 作成したファイルへのシンボリックリンクを作成します。
23// 注意: Windows環境では、シンボリックリンクの作成に管理者権限が必要な場合があります。
24// また、使用しているファイルシステムがシンボリックリンクをサポートしていない可能性もあります。
25$isSymlinkCreated = false;
26if (symlink($originalFilePath, $symlinkPath)) {
27    $isSymlinkCreated = true;
28    echo "シンボリックリンクを作成しました: {$symlinkPath} -> {$originalFilePath}\n";
29} else {
30    echo "警告: シンボリックリンク '{$symlinkPath}' を作成できませんでした。\n";
31    echo "管理者権限がないか、環境がシンボリックリンクをサポートしていない可能性があります。\n";
32    echo "この場合、getRealPath() はシンボリックリンクを解決せず、シンボリックリンクのパスを返すか、元のファイルのパスを直接開くことになります。\n";
33    // シンボリックリンクが作成できなかった場合、元のファイルを直接開くようにフォールバックします。
34    $symlinkPath = $originalFilePath;
35}
36
37echo "----------------------------------------\n";
38
39// --- SplFileObject::getRealPath() の使用例 ---
40try {
41    // SplFileObject でシンボリックリンク（または元のファイル）を開きます。
42    // ここで開くファイルオブジェクトはシンボリックリンクを指しているかもしれませんが、
43    // getRealPath() はそのリンクが指す実体ファイルのパスを返します。
44    $fileObject = new SplFileObject($symlinkPath);
45
46    // getRealPath() メソッドでファイルの実際の絶対パスを取得します。
47    // シンボリックリンクが存在し、それが解決可能であれば、実体ファイルのパスを返します。
48    // 解決に失敗した場合は false を返します。
49    $realPath = $fileObject->getRealPath();
50
51    if ($realPath !== false) {
52        echo "SplFileObjectで開いたパス: {$fileObject->getPathname()}\n";
53        echo "getRealPath() で取得した実際のパス: {$realPath}\n";
54
55        // 比較のために、PHPの標準関数 realpath() で元のファイルの実際のパスも取得します。
56        $expectedRealPath = realpath($originalFilePath);
57
58        if ($realPath === $expectedRealPath) {
59            echo "結果: getRealPath() は元ファイル '{$originalFilePath}' のパスを正しく解決しました。\n";
60        } else {
61            echo "結果: 取得されたパスは元ファイルと一致しませんでした。解決に問題があった可能性があります。\n";
62        }
63    } else {
64        echo "エラー: getRealPath() がファイルの実体パスを取得できませんでした。\n";
65    }
66
67} catch (Exception $e) {
68    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
69} finally {
70    // --- 後処理: 作成したファイルとシンボリックリンクを削除 ---
71    echo "----------------------------------------\n";
72    // シンボリックリンクが実際に作成された場合にのみ削除します。
73    if ($isSymlinkCreated && file_exists($symlinkPath)) {
74        unlink($symlinkPath);
75        echo "シンボリックリンクを削除しました: {$symlinkPath}\n";
76    }
77    // 元ファイルを削除します。
78    if (file_exists($originalFilePath)) {
79        unlink($originalFilePath);
80        echo "元ファイルを削除しました: {$originalFilePath}\n";
81    }
82}

PHPのSplFileObject::getRealPath()メソッドは、ファイルの実体（物理的な）パスを取得するために使用します。このメソッドは、特にファイルパスがシンボリックリンク（別のファイルを指し示す特殊なファイル）である場合に真価を発揮し、そのシンボリックリンクが実際に指しているファイルの絶対パスを解決して返します。例えば、Laravelアプリケーションでpublic/storageがstorage/app/publicへのシンボリックリンクになっている場合など、リンク先の真のパスを知りたい時に非常に役立ちます。

このメソッドはSplFileObjectクラスのインスタンスから呼び出し、引数は必要ありません。ファイルの実体パスの取得に成功すると、解決された絶対パスを文字列として返しますが、パスの解決に失敗した場合やファイルが存在しない場合は、falseを返します。

サンプルコードでは、まずテスト用の元ファイルとそれへのシンボリックリンクを作成しています。その後、このシンボリックリンクをSplFileObjectで開き、getRealPath()メソッドを呼び出すことで、シンボリックリンクではなく元ファイルの絶対パスが正確に取得できることを示しています。これにより、開いているファイルがシンボリックリンクであっても、その実体ファイルを確実に特定できることが確認できます。