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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各ファイルシステムエントリの完全なパスとファイル名を表示します。
5 *
6 * DirectoryIterator は、ディレクトリの内容を反復処理するためのイテレータを提供します。
7 * getPathname() メソッドは、ファイルまたはディレクトリの完全なパスと名前（例: /path/to/file.txt）を返します。
8 *
9 * @param string $directoryPath 処理するディレクトリのパス。
10 */
11function displayDirectoryPathnames(string $directoryPath): void
12{
13    echo "ディレクトリ '{$directoryPath}' の内容:\n";
14
15    try {
16        // DirectoryIterator のインスタンスを作成し、指定されたディレクトリを反復処理します。
17        // ここで指定するパスは、絶対パスでも相対パスでも構いません。
18        $iterator = new DirectoryIterator($directoryPath);
19
20        // ディレクトリ内の各ファイルシステムエントリをループ処理します。
21        foreach ($iterator as $fileInfo) {
22            // getPathname() メソッドを呼び出し、エントリの完全なパスとファイル名（またはディレクトリ名）を取得します。
23            // 例: /var/www/html/index.php や /var/www/html/images
24            echo "  " . $fileInfo->getPathname() . "\n";
25        }
26    } catch (UnexpectedValueException $e) {
27        // 指定されたディレクトリパスが無効な場合（例: 存在しない、アクセス権がない）に発生する例外をキャッチします。
28        echo "エラー: ディレクトリ '{$directoryPath}' を開けませんでした。\n";
29        echo "詳細: " . $e->getMessage() . "\n";
30    }
31}
32
33// このスクリプトが実行されている現在のディレクトリのパスを取得します。
34// これにより、スクリプトがどの場所で実行されても機能します。
35$currentDirectory = __DIR__;
36
37// 関数を呼び出し、現在のディレクトリ内のエントリのパス名を表示します。
38displayDirectoryPathnames($currentDirectory);
39
40?>

PHPのDirectoryIteratorクラスに属するgetPathname()メソッドは、ディレクトリ内の各エントリ（ファイルやサブディレクトリ）の完全なパスと名前を文字列として取得します。引数は不要です。

サンプルコードでは、DirectoryIteratorを使って指定ディレクトリ内のコンテンツを順に処理します。その際、getPathname()は、各エントリ（例: /var/www/html/index.php）の絶対パスと名前を文字列で取得し、表示しています。これは、ファイル操作などで正確なフルパス情報が必要な場合に役立ちます。

DirectoryIteratorでディレクトリを効率的に走査し、getPathname()で個々のエントリのパス情報を取得します。また、存在しないディレクトリの場合のエラー処理も示されており、堅牢なプログラム作成の基本を学べます。