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

Copy
1<?php
2
3/**
4 * プログラミング言語: PHP 8
5 * リファレンス情報: FilesystemIterator::getPath
6 *
7 * FilesystemIterator::getPath() メソッドは、FilesystemIterator が現在指している
8 * ファイルまたはディレクトリが属する親ディレクトリのパスを返します。
9 * このパスには、ファイル名やディレクトリ名自体は含まれません。
10 */
11
12/**
13 * 一時ディレクトリを作成し、サンプルファイルとサブディレクトリを配置します。
14 *
15 * @param string $baseDir 一時ディレクトリを作成するベースパス
16 * @return string 作成された一時ディレクトリのフルパス
17 * @throws RuntimeException ディレクトリやファイルの作成に失敗した場合
18 */
19function createTempDirectoryAndFiles(string $baseDir): string
20{
21    // ユニークな名前で一時ディレクトリを作成
22    $tempDir = $baseDir . DIRECTORY_SEPARATOR . 'temp_fs_example_' . uniqid();
23    if (!mkdir($tempDir, 0777, true)) {
24        throw new RuntimeException("一時ディレクトリの作成に失敗しました: " . $tempDir);
25    }
26
27    // サンプルファイルを作成
28    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはテストドキュメントです。');
29    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'image.jpg', '画像ファイルです（内容なし）。');
30
31    // サブディレクトリを作成し、その中にファイルを作成
32    $subDir = $tempDir . DIRECTORY_SEPARATOR . 'subfolder';
33    if (!mkdir($subDir, 0777, true)) {
34        throw new RuntimeException("一時サブディレクトリの作成に失敗しました: " . $subDir);
35    }
36    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'report.pdf', 'PDFレポートです（内容なし）。');
37
38    return $tempDir;
39}
40
41/**
42 * 指定されたディレクトリとその内容を再帰的に削除します。
43 *
44 * @param string $dir 削除するディレクトリのパス
45 * @return bool 削除が成功したかどうか
46 */
47function deleteDirectory(string $dir): bool
48{
49    if (!file_exists($dir)) {
50        return true;
51    }
52    if (!is_dir($dir)) {
53        return unlink($dir); // ディレクトリではない場合はファイルを削除
54    }
55
56    // ディレクトリ内のすべてのファイルとサブディレクトリを削除
57    $files = array_diff(scandir($dir), ['.', '..']);
58    foreach ($files as $file) {
59        $path = $dir . DIRECTORY_SEPARATOR . $file;
60        (is_dir($path)) ? deleteDirectory($path) : unlink($path);
61    }
62    return rmdir($dir); // 空になったディレクトリを削除
63}
64
65$tempDirectoryPath = null;
66try {
67    // システムの一時ディレクトリ内に、サンプル用のディレクトリとファイルを作成
68    $baseTempDir = sys_get_temp_dir();
69    $tempDirectoryPath = createTempDirectoryAndFiles($baseTempDir);
70
71    echo "--- FilesystemIterator を使用したディレクトリ内の情報取得 ---\n";
72    echo "対象ディレクトリ: " . $tempDirectoryPath . "\n\n";
73
74    // FilesystemIterator を使用して、指定されたディレクトリ内の各項目（ファイル/ディレクトリ）を反復処理します。
75    // 各項目は SplFileInfo オブジェクトとして取得でき、ファイルパスに関する様々な情報を提供します。
76    $iterator = new FilesystemIterator($tempDirectoryPath);
77
78    foreach ($iterator as $fileInfo) {
79        echo "--------------------------------------------------\n";
80
81        // getPath():
82        // 現在の項目 (ファイルまたはディレクトリ) が存在する親ディレクトリのパスを返します。
83        // ファイル名やディレクトリ名自体は含まれません。
84        echo "親ディレクトリのパス (getPath):      " . $fileInfo->getPath() . "\n";
85
86        // getFilename():
87        // 現在の項目 (ファイルまたはディレクトリ) の名前を返します。（例: document.txt, subfolder）
88        echo "ファイル名/ディレクトリ名 (getFilename): " . $fileInfo->getFilename() . "\n";
89
90        // getRealPath():
91        // 現在の項目 (ファイルまたはディレクトリ) の正規化された絶対パスを返します。
92        // シンボリックリンクなども解決された実際のパスです。
93        echo "完全な絶対パス (getRealPath):      " . ($fileInfo->getRealPath() ?: '取得不可') . "\n";
94
95        // 参考: pathinfo() 関数との関連
96        // pathinfo($fileInfo->getRealPath(), PATHINFO_DIRNAME) は getPath() とほぼ同じ結果を返します。
97        // pathinfo($fileInfo->getRealPath(), PATHINFO_BASENAME) は getFilename() とほぼ同じ結果を返します。
98    }
99    echo "--------------------------------------------------\n";
100
101} catch (RuntimeException $e) {
102    echo "エラーが発生しました: " . $e->getMessage() . "\n";
103} catch (UnexpectedValueException $e) {
104    // FilesystemIterator のコンストラクタが失敗した場合 (例: 指定されたディレクトリが存在しない)
105    echo "ファイルシステム操作エラー: " . $e->getMessage() . "\n";
106} finally {
107    // スクリプトの実行後、作成した一時ディレクトリとその内容を確実に削除
108    if ($tempDirectoryPath && file_exists($tempDirectoryPath)) {
109        deleteDirectory($tempDirectoryPath);
110        echo "\n一時ディレクトリとその内容を削除しました: " . $tempDirectoryPath . "\n";
111    }
112}
113

PHP 8で提供されるFilesystemIteratorは、指定されたディレクトリ内のファイルやサブディレクトリを順番に処理する際に非常に便利な機能です。このFilesystemIteratorクラスが提供するgetPath()メソッドは、現在処理しているファイルやディレクトリが属する親ディレクトリのパスを文字列として取得します。このメソッドは引数を必要としません。戻り値は、ファイル名やディレクトリ名自体を含まず、あくまで上位のディレクトリまでのパスのみを返します。例えば、/usr/local/bin/phpというパスを持つ項目に対してgetPath()を呼び出すと、/usr/local/binが返されます。サンプルコードでは、一時的に作成したディレクトリ内の各ファイルやサブディレクトリに対してgetPath()を使用し、それぞれの親ディレクトリのパスを表示しています。これは、ファイルやディレクトリの「名前」を返すgetFilename()や、「絶対パス全体」を返すgetRealPath()とは異なり、階層構造における位置を特定するのに役立ちます。また、PHPの組み込み関数pathinfo()でPATHINFO_DIRNAMEを指定した際とほぼ同じ情報を得ることができます。

Copy
1<?php
2
3/**
4 * FilesystemIterator::getPath メソッドの使用例を示します。
5 *
6 * この関数は一時ディレクトリとファイルを作成し、FilesystemIterator を使用してそれらを走査します。
7 * 各ファイルまたはディレクトリについて、getPath() メソッドと getPathname() メソッドの結果を表示し、
8 * それぞれがどのようなパスを返すかを示します。
9 *
10 * システムエンジニアを目指す初心者の方にも理解しやすいよう、
11 * 単体で動作し、必要に応じて一時リソースを作成・削除するよう設計されています。
12 */
13function demonstrateFilesystemIteratorGetPath(): void
14{
15    // 1. 一時ディレクトリの作成
16    // システムの一時ディレクトリ内にユニークな名前でディレクトリを作成します。
17    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_sample_fsiter_');
18    if (!mkdir($tempDir)) {
19        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
20        return;
21    }
22
23    // 2. 一時ファイルの作成
24    // 作成した一時ディレクトリ内にテスト用のファイルをいくつか作成します。
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはドキュメントの内容です。');
26    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'log_data.log', 'ログエントリ1\nログエントリ2');
27
28    echo "--- FilesystemIterator::getPath のデモンストレーション ---\n";
29    echo "スキャン対象ディレクトリ: {$tempDir}\n\n";
30
31    try {
32        // 3. FilesystemIterator の初期化
33        // FilesystemIterator を使用して、指定されたディレクトリを走査します。
34        // FilesystemIterator::SKIP_DOTS フラグは、'.' (現在のディレクトリ) と '..' (親ディレクトリ) をスキップします。
35        // デフォルトでは、イテレータの各要素は SplFileInfo オブジェクトとなり、
36        // getPath() や getPathname() などのメソッドが利用可能です。
37        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
38
39        // 4. ディレクトリの走査とメソッドの出力
40        foreach ($iterator as $fileInfo) {
41            echo "----------------------------------------\n";
42            echo "アイテム名 (getFilename): " . $fileInfo->getFilename() . "\n";
43
44            // FilesystemIterator::getPath() メソッドは、
45            // 現在のアイテム（ファイルまたはディレクトリ）が属するディレクトリのパスを返します。
46            // この例では、FilesystemIterator が走査している対象ディレクトリの絶対パスが返されます。
47            echo "ディレクトリパス (getPath): " . $fileInfo->getPath() . "\n";
48
49            // 参考情報: SplFileInfo::getPathname() メソッドは、
50            // ファイル名またはディレクトリ名を含む完全なパスを返します。
51            // getPath() との違いを理解するのに役立ちます。
52            echo "完全なパス (getPathname): " . $fileInfo->getPathname() . "\n";
53        }
54        echo "----------------------------------------\n";
55
56    } catch (UnexpectedValueException $e) {
57        // 指定されたパスがディレクトリでない場合や、読み取り権限がない場合に発生します。
58        echo "エラー: ディレクトリの読み込みに失敗しました - " . $e->getMessage() . "\n";
59    } finally {
60        // 5. 後処理: 作成した一時ファイルとディレクトリの削除
61        // デモンストレーション後にリソースをクリーンアップします。
62        // glob() を使用してディレクトリ内のすべてのファイルパスを取得し、unlink() で削除します。
63        // この例ではサブディレクトリを作成していないため、この方法で安全に削除できます。
64        foreach (glob($tempDir . DIRECTORY_SEPARATOR . '*') as $file) {
65            if (is_file($file)) {
66                unlink($file);
67            }
68        }
69        // ディレクトリが空になったら、rmdir() で削除します。
70        rmdir($tempDir);
71        echo "\n一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
72    }
73}
74
75// 関数を実行してデモンストレーションを開始します。
76demonstrateFilesystemIteratorGetPath();
77

PHP 8のFilesystemIterator::getPathメソッドは、ファイルシステムを走査する際に、現在のファイルやディレクトリが存在する親ディレクトリのパスを文字列で取得するために使用されます。このメソッドは引数を必要とせず、絶対パス形式の文字列を返します。

提供されたサンプルコードでは、一時ディレクトリ内に複数のファイルを生成し、FilesystemIteratorを用いてこれらを走査しています。foreachループ内で各ファイル情報（SplFileInfoオブジェクト）からgetPath()を呼び出すことで、ファイルが格納されているディレクトリのパスが表示されます。

特に、getPath()が返すのは親ディレクトリのパスであるのに対し、サンプルコードで比較されているSplFileInfo::getPathname()はファイル名やディレクトリ名を含むアイテム自身の完全なパスを返すため、両者の違いを理解することが重要です。例えば、/tmp/my_dir/document.txtというファイルに対しgetPath()は/tmp/my_dirを、getPathname()は/tmp/my_dir/document.txtを返します。このメソッドは、ファイルやディレクトリの場所を特定し、パス情報を効率的に扱うシステム開発において基本的な役割を果たします。