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

Copy
1<?php
2
3/**
4 * SplFileInfo::getPathInfo() メソッドの使用例を示します。
5 * このメソッドは、ファイルやディレクトリの親ディレクトリを表す SplFileInfo オブジェクトを返します。
6 *
7 * @return void
8 */
9function demonstrateSplFileInfoGetPathInfo(): void
10{
11    // 1. テスト用のファイルパスを準備します。
12    // システムの一時ディレクトリにユニークなファイルを作成し、そのパスを取得します。
13    $tempDir = sys_get_temp_dir();
14    $filePath = tempnam($tempDir, 'example_'); // 例: /tmp/example_xxxxxx
15    
16    // 一時ファイルの作成に失敗した場合は処理を終了します。
17    if ($filePath === false) {
18        echo "エラー: 一時ファイルの作成に失敗しました。\n";
19        return;
20    }
21
22    echo "--- SplFileInfo::getPathInfo() の使用例 ---\n";
23    echo "元のファイルパス: " . $filePath . "\n\n";
24
25    // 2. 作成した一時ファイルを SplFileInfo オブジェクトとしてラップします。
26    // SplFileInfo クラスはファイルやディレクトリに関する情報を提供するのに役立ちます。
27    $fileInfo = new SplFileInfo($filePath);
28
29    // 3. getPathInfo() メソッドを呼び出し、このファイルが含まれるディレクトリの情報を取得します。
30    // このメソッドは、親ディレクトリを表す新しい SplFileInfo オブジェクトを返します。
31    // もし親ディレクトリが存在しない場合（例: ルートディレクトリの場合）、nullを返します。
32    $parentDirInfo = $fileInfo->getPathInfo();
33
34    // 4. 取得した親ディレクトリの情報を表示します。
35    if ($parentDirInfo instanceof SplFileInfo) {
36        echo "getPathInfo() で取得した親ディレクトリの情報:\n";
37        echo "  パス名: " . $parentDirInfo->getPathname() . "\n";
38        echo "  ファイル名 (ディレクトリ名): " . $parentDirInfo->getFilename() . "\n";
39        echo "  パス (親の親ディレクトリ): " . $parentDirInfo->getPath() . "\n";
40    } else {
41        echo "親ディレクトリの情報は取得できませんでした (null が返されました)。\n";
42    }
43
44    echo "\n";
45
46    // 5. 使用した一時ファイルを削除してクリーンアップします。
47    if (file_exists($filePath)) {
48        unlink($filePath);
49        echo "一時ファイルを削除しました: " . $filePath . "\n";
50    }
51}
52
53// 上記の関数を実行して、SplFileInfo::getPathInfo() の動作を確認します。
54demonstrateSplFileInfoGetPathInfo();
55
56?>

PHPのSplFileInfo::getPathInfo()メソッドは、ファイルやディレクトリの親ディレクトリに関する情報を取得するために使用されます。このメソッドは、指定されたファイルやディレクトリが格納されている、一つ上の階層のディレクトリを表すSplFileInfoオブジェクトを返します。

引数$classはオプションで、親ディレクトリ情報を特定のSplFileInfoを継承したクラスのインスタンスとして取得したい場合に、そのクラス名を文字列で指定します。通常は省略され、デフォルトのSplFileInfoオブジェクトが返されます。

戻り値はSplFileInfoオブジェクト、または親ディレクトリが存在しない場合にnullとなります。例えば、WindowsのC:\のようなルートディレクトリやLinuxの/のようなルートディレクトリに対してgetPathInfo()を呼び出すとnullが返されます。

サンプルコードでは、まずシステムの一時ディレクトリに一時ファイルを作成し、そのパスを使ってSplFileInfoオブジェクトを生成しています。このオブジェクトはファイルに関する多様な情報へのアクセスを可能にします。次に、作成した$fileInfoオブジェクトに対してgetPathInfo()メソッドを呼び出し、そのファイルが属する親ディレクトリの情報を取得しています。取得した$parentDirInfoがSplFileInfoオブジェクトであれば、そのパス名やファイル名（ディレクトリ名）などの情報を表示し、親ディレクトリが正しく取得できたことを確認しています。この一連の処理により、プログラムでファイルパスから親ディレクトリの情報を効率的に取得し、操作できることがわかります。最後に、作成した一時ファイルを削除してクリーンアップを行っています。このメソッドは、ファイルシステムの階層構造をプログラムで扱う際に非常に役立ちます。