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

Copy
1<?php
2
3// GlobIterator を使用して、指定されたパターンに一致するファイルやディレクトリをイテレートするサンプルコードです。
4// このスクリプトを実行する前に、同じディレクトリにいくつかのファイルやサブディレクトリを作成しておくと、出力が確認しやすくなります。
5// 例:
6// - test_file1.txt
7// - script.php (このファイル自体)
8// - sub_directory/
9// - sub_directory/nested_file.log
10
11try {
12    // 現在のスクリプトがあるディレクトリ内の全てのファイルとディレクトリを対象とするGlobIteratorを作成します。
13    // パターン '__DIR__/*' は、カレントディレクトリの直接の子要素（ファイルおよびディレクトリ）にマッチします。
14    $iterator = new GlobIterator(__DIR__ . '/*');
15
16    echo "--- GlobIterator::getPathname() の使用例 ---\n";
17    echo "現在のディレクトリ内の各要素のパス名:\n";
18
19    if ($iterator->count() > 0) {
20        // イテレータをループし、各要素の情報を取得します。
21        // $fileInfo は SplFileInfo のインスタンスであり、ファイルやディレクトリの情報を提供します。
22        foreach ($iterator as $fileInfo) {
23            // getPathname() メソッドは、現在の要素（ファイルまたはディレクトリ）のフルパス名
24            // （ディレクトリとファイル名を合わせたもの）を文字列で返します。
25            echo $fileInfo->getPathname() . "\n";
26        }
27    } else {
28        echo "指定されたパターンに一致するファイルやディレクトリは見つかりませんでした。\n";
29    }
30
31} catch (Exception $e) {
32    // GlobIterator の作成時などに発生する可能性のある例外を捕捉します。
33    echo "エラーが発生しました: " . $e->getMessage() . "\n";
34}
35
36?>

このPHPサンプルコードは、GlobIteratorクラスとそのメソッドであるgetPathname()を使って、指定されたパターンに一致するファイルやディレクトリのパス名を取得する方法を示しています。GlobIteratorは、ファイルシステムの特定のパターンに合致する要素を効率的に走査（イテレート）するための便利なクラスです。

まず、new GlobIterator(__DIR__ . '/*')という記述で、現在のスクリプトがあるディレクトリ直下の全てのファイルとサブディレクトリを対象とするイテレータを作成しています。__DIR__は、現在のスクリプトのディレクトリパスを示すPHPの定数です。

次に、foreachループを使用して、イテレータが見つけた各要素を順に処理します。このループ内で$fileInfo変数として取得されるのはSplFileInfoというオブジェクトで、これによりファイルやディレクトリに関する様々な詳細情報にアクセスできます。

ここで$fileInfo->getPathname()メソッドが使われています。このメソッドは引数を一切必要とせず、現在の要素（ファイルまたはディレクトリ）の完全なパス名、つまりルートディレクトリからファイル名（またはディレクトリ名）までを含んだ文字列を返します。例えば、C:\xampp\htdocs\my_project\test_file1.txtや/var/www/html/sub_directoryといった形式のパスです。この戻り値を利用することで、プログラム内で対象のファイルやディレクトリがどこにあるのかを正確に把握し、その後のファイル操作や処理に活用できます。getPathname()は、ファイルシステムを扱う上で非常に基本的ながら重要な役割を果たすメソッドです。