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

Copy
1<?php
2
3// 一時ファイルを作成し、SplFileInfo::getRealPath() メソッドの動作を確認するサンプルコード
4
5/**
6 * SplFileInfo::getRealPath() メソッドの使用例を示します。
7 * このメソッドは、ファイルやディレクトリのシンボリックリンクや相対パスを解決し、
8 * 実際の絶対パスを返します。
9 * LaravelのUploadedFileオブジェクト（SplFileInfoを継承）でも同様に利用可能です。
10 */
11
12// スクリプトが実行されているディレクトリを取得
13$currentDir = __DIR__;
14// 一時ファイル名
15$tempFileName = 'example_file.txt';
16// 一時ファイルのフルパス
17$tempFilePath = $currentDir . DIRECTORY_SEPARATOR . $tempFileName;
18
19// テスト用の一時ファイルを作成
20// このファイルは、getRealPath() の対象となります。
21file_put_contents($tempFilePath, 'このファイルはテスト用です。');
22
23// SplFileInfoオブジェクトを、作成した一時ファイルのパスでインスタンス化
24$fileInfo = new SplFileInfo($tempFilePath);
25
26// getRealPath() メソッドを呼び出し、ファイルの実際のパスを取得
27// 取得に失敗した場合は false を返します。
28$realPath = $fileInfo->getRealPath();
29
30// 戻り値が false でないかを確認し、結果を出力
31if ($realPath !== false) {
32    echo "ファイルの実際のパス (getRealPath()): " . $realPath . PHP_EOL;
33    echo "元の指定パス: " . $fileInfo->getPathname() . PHP_EOL;
34} else {
35    // ファイルが存在しない、またはアクセス権がない場合などに発生
36    echo "エラー: ファイルの実際のパスを取得できませんでした。" . PHP_EOL;
37}
38
39// 作成した一時ファイルを削除してクリーンアップ
40if (file_exists($tempFilePath)) {
41    unlink($tempFilePath);
42}
43
44?>

SplFileInfo::getRealPath()メソッドは、PHP 8で提供されるファイルやディレクトリの情報を扱うための機能です。このメソッドは、ファイルやディレクトリのシンボリックリンクや相対パスを解決し、その実体が存在する場所の絶対パスを文字列として返します。引数は必要ありません。ファイルが存在しない場合やアクセス権がない場合など、何らかの理由で実際のパスの取得に失敗した際には、戻り値としてfalseを返します。

サンプルコードでは、まずスクリプト実行ディレクトリ内に一時ファイルを作成し、その一時ファイルのパスからSplFileInfoオブジェクトを生成しています。その後、getRealPath()メソッドを呼び出して、この一時ファイルの実際の絶対パスを取得し、その結果を出力しています。これにより、相対パスやシンボリックリンクなどが含まれるパス指定であっても、常にファイルの正確な物理的位置を知ることができます。例えば、LaravelのUploadedFileオブジェクトもSplFileInfoを継承しているため、アップロードされたファイルの実際のパスを取得する際にも、このメソッドを同様に利用可能です。最後に、作成した一時ファイルを削除してクリーンアップを行っています。このメソッドは、確実なファイルパス情報を得るために非常に有用です。