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

Copy
1<?php
2
3/**
4 * GlobIterator::getPathInfo() の使用例。
5 * 指定されたパターンに一致するファイルやディレクトリのパス情報を取得します。
6 *
7 * このスクリプトは、一時的なファイルとディレクトリを作成し、GlobIterator を使用して
8 * それらを反復処理し、getPathInfo() メソッドで各エントリのパス情報を表示します。
9 * 最後に、作成した一時ファイルをクリーンアップします。
10 */
11
12// 一時ファイルを生成するためのディレクトリパスを定義
13$tempDir = __DIR__ . '/temp_glob_files';
14
15// ディレクトリが存在しない場合は作成
16if (!is_dir($tempDir)) {
17    mkdir($tempDir);
18}
19
20// テスト用のファイルとディレクトリを作成
21file_put_contents($tempDir . '/example1.txt', 'This is a text file.');
22file_put_contents($tempDir . '/document.pdf', 'This is a PDF document.');
23if (!is_dir($tempDir . '/sub_dir')) {
24    mkdir($tempDir . '/sub_dir');
25}
26file_put_contents($tempDir . '/sub_dir/readme.md', 'README content.');
27
28echo "--- GlobIterator::getPathInfo() の基本使用例 ---\n";
29
30try {
31    // GlobIterator のインスタンスを作成
32    // temp_glob_files ディレクトリ内のすべてのファイルとディレクトリを対象とするパターンを指定
33    // GLOB_BRACE フラグを使用すると、パターン内で {pattern1,pattern2} のような指定が可能になります。
34    // ここでは、ディレクトリ全体を対象とするために '/*' を使用しています。
35    $iterator = new GlobIterator($tempDir . '/*', GlobIterator::KEY_AS_FILENAME);
36
37    // イテレータに有効なエントリがあるか確認
38    if (!$iterator->valid()) {
39        echo "指定されたパターンに一致するファイルやディレクトリは見つかりませんでした。\n";
40    }
41
42    // イテレータをループして各エントリを処理
43    foreach ($iterator as $filename => $fileInfo) {
44        // GlobIterator は SplFileInfo オブジェクトを返すため、$fileInfo 変数自体が SplFileInfo オブジェクトです。
45        // getPathInfo() メソッドも、現在の SplFileInfo オブジェクトを返します。
46        // これは、より一般的なイテレータ (例: DirectoryIterator) で SplFileInfo を取得する際に役立ちます。
47        $pathInfo = $iterator->getPathInfo();
48
49        if ($pathInfo) {
50            echo "ファイル/ディレクトリ名: " . $pathInfo->getFilename() . "\n";
51            echo "完全なパス: " . $pathInfo->getPathname() . "\n";
52            if ($pathInfo->isFile()) {
53                echo "種類: ファイル\n";
54                echo "拡張子: " . $pathInfo->getExtension() . "\n";
55            } elseif ($pathInfo->isDir()) {
56                echo "種類: ディレクトリ\n";
57            }
58            echo "---------------------------\n";
59        } else {
60            echo "パス情報が取得できませんでした: " . $filename . "\n";
61        }
62    }
63
64    // --- オプション引数 $class を使用した例 ---
65    // SplFileInfo を継承したカスタムクラスを定義
66    // getPathInfo() の $class 引数にこのクラス名を渡すと、
67    // 戻り値が CustomFileInfo のインスタンスになります。
68    class CustomFileInfo extends SplFileInfo {
69        public function getCustomInfo(): string {
70            return "カスタム情報: " . $this->getFilename() . " は " . $this->getSize() . " バイトです。";
71        }
72    }
73
74    echo "\n--- カスタムクラスを指定した GlobIterator::getPathInfo() の使用例 ---\n";
75    $customIterator = new GlobIterator($tempDir . '/*');
76
77    foreach ($customIterator as $filename => $fileInfo) {
78        // CustomFileInfo クラスのインスタンスとしてパス情報を取得
79        $customPathInfo = $customIterator->getPathInfo(CustomFileInfo::class);
80
81        if ($customPathInfo instanceof CustomFileInfo) {
82            echo "ファイル/ディレクトリ名: " . $customPathInfo->getFilename() . "\n";
83            echo $customPathInfo->getCustomInfo() . "\n"; // カスタムクラスのメソッドを呼び出し
84            echo "---------------------------\n";
85        } else {
86            echo "カスタムパス情報が取得できませんでした、または型が異なります: " . $filename . "\n";
87        }
88    }
89
90} catch (UnexpectedValueException $e) {
91    // GlobIterator のコンストラクタでパターンが見つからない場合などに発生
92    echo "エラー: " . $e->getMessage() . "\n";
93} finally {
94    // 後処理: 作成したファイルとディレクトリを削除してクリーンアップ
95    // RecursiveIteratorIterator を使用して、サブディレクトリ内のファイルも削除
96    $files = new RecursiveIteratorIterator(
97        new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
98        RecursiveIteratorIterator::CHILD_FIRST
99    );
100
101    foreach ($files as $fileinfo) {
102        // ファイルならunlink、ディレクトリならrmdirを実行
103        $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
104        $todo($fileinfo->getRealPath());
105    }
106    // 空になったルートディレクトリを削除
107    rmdir($tempDir);
108    echo "\n一時ファイルとディレクトリをクリーンアップしました。\n";
109}
110

GlobIterator::getPathInfo()メソッドは、PHPでファイルシステム上のファイルやディレクトリを走査するGlobIteratorが現在指し示している要素のパス情報を取得するために使用されます。このメソッドは、ファイル名、パス、種類（ファイルかディレクトリか）、サイズといった詳細な情報をまとめたSplFileInfoという特別なオブジェクトを返します。

引数$classにSplFileInfoを継承した独自のクラス名を指定すると、そのカスタムクラスのインスタンスとして情報を取得できるため、独自の処理を追加する際に便利です。戻り値はSplFileInfoまたは指定したカスタムクラスのインスタンスですが、パス情報の取得に失敗した場合はfalseを返します。

サンプルコードでは、まず一時的なファイルやディレクトリを作成し、GlobIteratorでそれらを検索します。その後、foreachループで各要素を順に処理し、getPathInfo()を使って得られたSplFileInfoオブジェクトから、ファイル名や種類などの情報を画面に表示しています。また、カスタムクラスを指定して、より柔軟にパス情報を扱う応用例も示しています。このメソッドを使うことで、ファイルシステムのエントリ情報を効率的に取得し、プログラム内で活用することができます。

Copy
1<?php
2
3// GlobIterator::getPathInfo() メソッドのサンプルコード
4// このスクリプトは、GlobIterator を使ってファイルパスを走査し、
5// GlobIterator::getPathInfo() で取得した SplFileInfo オブジェクトから
6// SplFileInfo::getPathname() を使ってフルパスを表示します。
7// システムエンジニアを目指す初心者が理解しやすいように、単体で動作する簡潔なコードです。
8
9$tempDir = __DIR__ . '/glob_test_files';
10
11// 実行前に一時ディレクトリとファイルを作成します
12if (!is_dir($tempDir)) {
13    mkdir($tempDir, 0777, true);
14}
15file_put_contents($tempDir . '/document.txt', 'これはテストドキュメントです。');
16file_put_contents($tempDir . '/report.pdf', 'これはテストレポートです。');
17
18// サブディレクトリを作成し、その中にファイルを作成します
19if (!is_dir($tempDir . '/subfolder')) {
20    mkdir($tempDir . '/subfolder', 0777, true);
21}
22file_put_contents($tempDir . '/subfolder/image.jpg', 'これはテスト画像です。');
23
24echo "GlobIterator を使用して一時ディレクトリ内のファイル情報を取得します。\n";
25echo "GlobIterator::getPathInfo() メソッドと SplFileInfo::getPathname() メソッドの連携に注目してください。\n\n";
26
27try {
28    // GlobIterator を初期化します。
29    // パターン '$tempDir/*' は、指定ディレクトリ直下のファイルとディレクトリを対象とします。
30    $iterator = new GlobIterator($tempDir . '/*');
31
32    if (!$iterator->valid()) {
33        echo "指定されたパターンに一致するファイルやディレクトリは見つかりませんでした。\n";
34    } else {
35        // イテレータをループして、各要素（ファイルまたはディレクトリ）を処理します。
36        foreach ($iterator as $item) { // $item は SplFileInfo オブジェクトです
37            // GlobIterator::getPathInfo() メソッドを呼び出し、現在の要素の SplFileInfo オブジェクトを取得します。
38            // 引数を省略すると、デフォルトの SplFileInfo オブジェクトが返されます。
39            $fileInfo = $iterator->getPathInfo();
40
41            // getPathInfo() が false を返す可能性があるため、エラーチェックを行います。
42            if ($fileInfo === false) {
43                echo "エラー: 現在の要素のファイル情報の取得に失敗しました。\n";
44                continue;
45            }
46
47            // SplFileInfo オブジェクトの getPathname() メソッドを使用して、
48            // ファイルまたはディレクトリのフルパス（パス名）を取得し、表示します。
49            echo "取得されたパス名: " . $fileInfo->getPathname() . "\n";
50            echo "----------------------------------------\n";
51        }
52    }
53} catch (UnexpectedValueException $e) {
54    // GlobIterator の初期化時などに発生する可能性のあるエラーをキャッチします。
55    echo "エラーが発生しました: " . $e->getMessage() . "\n";
56} finally {
57    // 後処理: 作成した一時ファイルとディレクトリをすべて削除してクリーンアップします。
58    // ディレクトリを再帰的に削除するためのヘルパー関数です。
59    function deleteTemporaryDirectory(string $dirPath): void
60    {
61        if (!is_dir($dirPath)) {
62            return;
63        }
64        // . と .. をスキップするため FilesystemIterator::SKIP_DOTS を使用します。
65        $items = new FilesystemIterator($dirPath, FilesystemIterator::SKIP_DOTS);
66        foreach ($items as $item) {
67            // ディレクトリであれば再帰的に削除し、そうでなければファイルを削除します。
68            if ($item->isDir() && !$item->isLink()) {
69                deleteTemporaryDirectory($item->getPathname());
70            } else {
71                unlink($item->getPathname());
72            }
73        }
74        // ディレクトリが空になったら削除します。
75        rmdir($dirPath);
76    }
77
78    deleteTemporaryDirectory($tempDir);
79    echo "\n一時ディレクトリとファイルをクリーンアップしました。\n";
80}

PHP 8のGlobIterator::getPathInfo()メソッドは、GlobIteratorが走査している現在のファイルやディレクトリに関する詳細な情報を提供する目的で使用されます。このメソッドは、ファイルシステム上の各要素の情報をカプセル化したSplFileInfoオブジェクトを返します。

引数$classはオプションで、SplFileInfoを継承するカスタムクラス名を文字列で指定できますが、通常は省略してデフォルトのSplFileInfoオブジェクトを取得します。戻り値は、現在の要素の情報を格納したSplFileInfoオブジェクト、または情報取得に失敗した場合にはfalseです。

サンプルコードでは、GlobIteratorが一時ディレクトリ内のファイルやサブディレクトリを走査する際に、ループ内で$iterator->getPathInfo()を呼び出しています。これにより、現在処理中の要素のSplFileInfoオブジェクトを取得します。その後、取得したSplFileInfoオブジェクトのgetPathname()メソッドを利用して、そのファイルまたはディレクトリのフルパス（パス名）を簡単に取得し、画面に表示しています。このように、getPathInfo()はGlobIteratorで取得したファイルやディレクトリのパスやその他の詳細情報を操作する際の基盤となる、重要なメソッドです。