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

Copy
1<?php
2
3// 一時ファイルを作成し、このサンプルコードで使用します。
4// __DIR__ は現在のスクリプトが格納されているディレクトリのパスを返します。
5$fileName = 'sample_file.txt';
6$filePath = __DIR__ . DIRECTORY_SEPARATOR . $fileName;
7
8// ファイルが存在しない場合は作成し、内容を書き込みます。
9if (!file_exists($filePath)) {
10    file_put_contents($filePath, 'This is a test file for SplFileObject::getPath method.');
11}
12
13try {
14    // SplFileObject クラスのインスタンスを作成し、ファイルを開きます。
15    // 'r' は読み込みモードを意味します。
16    $fileObject = new SplFileObject($filePath, 'r');
17
18    // getPath() メソッドを使用して、ファイル名を含まないディレクトリのパスを取得します。
19    // 例: /path/to/directory/sample_file.txt の場合、/path/to/directory を返します。
20    $directoryPath = $fileObject->getPath();
21
22    // getPathname() メソッドは、ファイル名を含む完全なパスを返します。
23    $fullPathname = $fileObject->getPathname();
24
25    echo "対象ファイルの完全なパス (getPathname): " . $fullPathname . "\n";
26    echo "ファイル名を含まないディレクトリパス (getPath): " . $directoryPath . "\n";
27
28} catch (RuntimeException $e) {
29    // ファイルのオープンに失敗した場合（ファイルが見つからない、アクセス権がないなど）のエラーを捕捉します。
30    echo "エラーが発生しました: " . $e->getMessage() . "\n";
31} finally {
32    // サンプルコードの実行後、作成した一時ファイルを削除してクリーンアップします。
33    if (file_exists($filePath)) {
34        unlink($filePath);
35    }
36}

PHPのSplFileObject::getPath()メソッドは、ファイル操作を専門とするSplFileObjectクラスのインスタンスから、対象ファイルのディレクトリパスを取得するために使用します。

このメソッドは引数を一切取りません。戻り値はstring型で、ファイル名を含まない、そのファイルが格納されているディレクトリの絶対パスを文字列として返します。例えば、/var/www/html/sample.txtというファイルに対してgetPath()を呼び出すと、/var/www/htmlというパスが返されます。

サンプルコードでは、一時ファイルを作成し、それをSplFileObjectで開いています。その後、getPath()メソッドを呼び出してディレクトリパスを取得し、その結果を表示しています。また、getPathname()メソッドも利用し、ファイル名を含む完全なパス（例: /var/www/html/sample.txt）と比較することで、両者の違いを明確に理解できるように構成されています。ファイルの具体的な場所を知りたい際に、このメソッドはファイルのパス情報からディレクトリ部分だけを効率的に抽出するのに役立ちます。