Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

getPathnameメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getPathnameメソッドは、SplFileInfoクラスのインスタンスが表すファイルまたはディレクトリの完全なパス名を取得するメソッドです。SplFileInfoクラスはPHPの標準ライブラリ(SPL)の一部であり、ファイルシステム上のファイルやディレクトリに関する情報にオブジェクト指向のアプローチでアクセスするための機能を提供します。このgetPathnameメソッドは、対象となるファイルやディレクトリの絶対パスを、その名前まで含めて完全な文字列として返します。例えば、/var/www/html/index.phpC:\Users\username\Documents\report.docxのように、ファイルシステム上のルートからの正確な位置を示すパスを取得することができます。このメソッドは引数を必要とせず、常に文字列型のパス名を返します。ファイルの内容を読み込んだり、ファイルを別の場所に移動させたり、あるいは特定のファイルを削除したりするなど、ファイルシステムに対する様々な操作を行う際には、そのファイルの正確な完全パスが必要となります。getPathnameメソッドは、このような操作の際に、対象のファイルを曖昧さなく特定するための基盤となる情報を提供し、堅牢なファイル操作処理を実装する上で不可欠な要素です。

構文(syntax)

1<?php
2$fileInfo = new SplFileInfo('/var/www/html/index.php');
3$pathname = $fileInfo->getPathname();
4echo $pathname;
5?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

SplFileInfo::getPathnameは、SplFileInfoオブジェクトが表すファイルまたはディレクトリの絶対パスを文字列で返します。

サンプルコード

PHP SplFileInfo::getPathname でファイルパスを取得する

1<?php
2
3// 一時ファイルを作成し、SplFileInfoオブジェクトで使用する準備
4$tempFileName = 'example_file_' . uniqid() . '.txt';
5file_put_contents($tempFileName, 'This is a test file for SplFileInfo::getPathname.');
6
7// SplFileInfo クラスのインスタンスを作成
8// コンストラクタにファイルパスを渡します
9$fileInfo = new SplFileInfo($tempFileName);
10
11// getPathname() メソッドを呼び出し、ファイルまたはディレクトリのパス名を取得します
12// このメソッドは引数を取りません
13$pathname = $fileInfo->getPathname();
14
15// 取得したパス名を出力
16echo "ファイルのパス名: " . $pathname . PHP_EOL;
17
18// 作成した一時ファイルを削除し、環境をクリーンアップします
19unlink($tempFileName);
20
21?>

PHPのSplFileInfoクラスは、ファイルやディレクトリに関する様々な情報を取り扱うための便利な機能を提供します。このクラスを使うことで、ファイル名やパス、サイズなどの情報を簡単に取得できます。

SplFileInfo::getPathname()メソッドは、このSplFileInfoオブジェクトが指し示すファイルまたはディレクトリの完全なパス名を文字列として取得するために使用されます。このメソッドは一切引数を必要としません。呼び出すだけで、ファイルシステムのどこにそのファイルやディレクトリがあるかを示す、正確なパス名が文字列として返されます。

サンプルコードでは、まず一時ファイルを作成し、そのパスを使ってSplFileInfoクラスのインスタンスを作成しています。その後、$fileInfo->getPathname()を呼び出すことで、作成した一時ファイルの完全なパス名を取得し、画面に出力しています。このように、getPathname()メソッドは、ファイル操作を行う際に、対象となるファイルやディレクトリの正確な位置をプログラム内で把握したい場合に非常に役立ちます。戻り値は常に文字列型であり、ファイルの場所を示す情報として利用できます。

SplFileInfoのコンストラクタに渡すパスは、ファイルシステム上に実体がなくても動作します。getPathname()は、このコンストラクタに渡された文字列をそのまま返しますので、必ずしもファイルが存在する実体の絶対パスを示すわけではない点にご注意ください。ファイルが存在するかやディレクトリであるかは、isFile()isDir()などの他のメソッドで別途確認が必要です。サンプルコードのように一時ファイルを作成した際は、処理完了後にunlink()で確実に削除し、不要なファイルを残さないよう環境をクリーンアップする習慣をつけましょう。これにより、システムのリソース管理が適切に行えます。

関連コンテンツ