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

Copy
1<?php
2
3// このサンプルスクリプトは、PHPのFilesystemIteratorクラスを使用して、
4// 指定されたディレクトリ内のファイルやサブディレクトリの完全なパス名を取得する方法を示します。
5// 実行すると一時的なディレクトリとファイルが作成され、処理後にクリーンアップされます。
6
7// 1. サンプル用のディレクトリとファイルを準備
8// 一意な名前の一時ディレクトリを作成し、衝突を避けます。
9$tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'sample_dir_' . uniqid();
10$tempSubDir = $tempDir . DIRECTORY_SEPARATOR . 'subdir';
11$tempFile1 = $tempDir . DIRECTORY_SEPARATOR . 'file1.txt';
12$tempFile2 = $tempSubDir . DIRECTORY_SEPARATOR . 'file2.log';
13
14// 一時ディレクトリとサブディレクトリを作成します。
15// 0777はディレクトリのパーミッション、trueは親ディレクトリも再帰的に作成する指定です。
16if (!mkdir($tempSubDir, 0777, true)) {
17    echo "エラー: ディレクトリ '{$tempSubDir}' の作成に失敗しました。\n";
18    exit(1);
19}
20
21// サンプルファイルをそれぞれのディレクトリに作成します。
22if (file_put_contents($tempFile1, "これはファイル1の内容です。") === false) {
23    echo "エラー: ファイル '{$tempFile1}' の作成に失敗しました。\n";
24    // エラー発生時は作成済みのディレクトリを削除して終了します。
25    rmdir($tempSubDir);
26    rmdir($tempDir);
27    exit(1);
28}
29if (file_put_contents($tempFile2, "これはファイル2の内容です。") === false) {
30    echo "エラー: ファイル '{$tempFile2}' の作成に失敗しました。\n";
31    // エラー発生時は作成済みのファイルとディレクトリを削除して終了します。
32    unlink($tempFile1);
33    rmdir($tempSubDir);
34    rmdir($tempDir);
35    exit(1);
36}
37
38echo "--- ディレクトリ '{$tempDir}' 内のパス一覧 ---\n";
39
40try {
41    // FilesystemIterator のインスタンスを作成します。
42    // これにより、指定されたディレクトリ ($tempDir) の直下の要素（ファイルやサブディレクトリ）を
43    // イテレート（順に処理）できるようになります。
44    $iterator = new FilesystemIterator($tempDir);
45
46    // イテレータをループし、各要素の情報を取得します。
47    // $fileInfo は SplFileInfo クラスのインスタンスとなり、ファイルに関する様々な情報を提供します。
48    foreach ($iterator as $fileInfo) {
49        // getPathname() メソッドは、現在の要素の完全なパス名（ディレクトリ名 + ファイル名）を
50        // 文字列として返します。
51        echo "完全なパス名: " . $fileInfo->getPathname() . "\n";
52    }
53
54} catch (UnexpectedValueException $e) {
55    // FilesystemIterator のコンストラクタが無効なパスなどで失敗した場合の例外を捕捉します。
56    echo "エラー: ディレクトリ '{$tempDir}' の走査中に問題が発生しました。 " . $e->getMessage() . "\n";
57} finally {
58    // 2. サンプル用のディレクトリとファイルをクリーンアップ（後処理）
59    // 処理の成功・失敗に関わらず、一時的に作成したものを削除します。
60    echo "\n--- クリーンアップ中 ---\n";
61    if (file_exists($tempFile1)) {
62        unlink($tempFile1); // ファイルを削除
63        echo "ファイルを削除しました: " . basename($tempFile1) . "\n";
64    }
65    if (file_exists($tempFile2)) {
66        unlink($tempFile2); // ファイルを削除
67        echo "ファイルを削除しました: " . basename($tempFile2) . "\n";
68    }
69    if (is_dir($tempSubDir)) {
70        rmdir($tempSubDir); // サブディレクトリを削除
71        echo "サブディレクトリを削除しました: " . basename($tempSubDir) . "\n";
72    }
73    if (is_dir($tempDir)) {
74        rmdir($tempDir); // メインの一時ディレクトリを削除
75        echo "ディレクトリを削除しました: " . basename($tempDir) . "\n";
76    }
77}
78
79echo "--- 処理が完了しました ---\n";
80
81?>

PHPのFilesystemIterator::getPathnameメソッドは、ファイルシステムを走査する際に、現在処理しているファイルやディレクトリの完全なパス名を取得するために利用されます。このメソッドは、FilesystemIteratorクラスのインスタンスが返すSplFileInfoオブジェクトに対して使用します。

提供されたサンプルコードでは、まずプログラムの実行用に一時的なディレクトリとファイルをいくつか作成しています。その後、new FilesystemIterator($tempDir)としてインスタンスを作成し、作成したディレクトリの内容を一つずつ処理できるように準備します。foreachループでディレクトリ内の各要素を順番に取得し、$fileInfoという変数にSplFileInfoオブジェクトが格納されます。

この$fileInfoオブジェクトからgetPathname()メソッドを呼び出すことで、そのファイルやディレクトリがファイルシステム上のどこにあるのかを、例えば/path/to/sample_dir/file1.txtのように、完全なパスとして文字列で取得できます。getPathname()メソッドは引数を必要とせず、常に現在の要素の完全なパス名を文字列（string）として返します。これにより、プログラムは各ファイルの正確な位置を把握し、その後の処理に活用できます。コードの最後では、一時的に作成したディレクトリやファイルが適切に削除され、環境をクリーンに保っています。このメソッドは、ファイル一覧の作成や特定のファイルを検索する際などに非常に便利です。