【PHP8.x】GlobIterator::CURRENT_AS_PATHNAME定数の使い方

Copy
1<?php
2
3/**
4 * GlobIterator::CURRENT_AS_PATHNAME 定数の使用例を示します。
5 *
6 * この定数を使用すると、GlobIterator はイテレーション時に SplFileInfo オブジェクトの代わりに、
7 * マッチしたファイルの完全なパス名の文字列を直接返します。
8 * システムエンジニアを目指す初心者の方にとって、特定のパターンに一致するファイルのパスを
9 * 文字列として直接取得したい場合に役立ちます。
10 */
11function demonstrateGlobIteratorCurrentAsPathname(): void
12{
13    // 一時ディレクトリを作成し、テスト用のファイルを用意します。
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_glob_example_' . uniqid();
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        echo "エラー: 一時ディレクトリの作成に失敗しました: {$tempDir}\n";
17        return;
18    }
19
20    $filesToCreate = ['document.txt', 'report.pdf', 'image.jpg', 'archive.zip'];
21    foreach ($filesToCreate as $fileName) {
22        file_put_contents($tempDir . DIRECTORY_SEPARATOR . $fileName, "Dummy content for {$fileName}");
23    }
24
25    echo "--- GlobIterator::CURRENT_AS_PATHNAME を使用したファイルパスの列挙 ---\n";
26    echo "対象ディレクトリ: {$tempDir}\n";
27    echo "検索パターン: {$tempDir}/*.{txt,pdf,jpg}\n\n";
28
29    try {
30        // GlobIterator をインスタンス化し、GlobIterator::CURRENT_AS_PATHNAME フラグを指定します。
31        // このフラグにより、foreach ループで取得される各要素がファイルパスの文字列になります。
32        $iterator = new GlobIterator(
33            $tempDir . '/*.{txt,pdf,jpg}', // ワイルドカードとブレース展開で特定の拡張子を検索
34            GlobIterator::CURRENT_AS_PATHNAME | GlobIterator::SKIP_DOTS // ドットファイルはスキップ
35        );
36
37        echo "見つかったファイルパス:\n";
38        $count = 0;
39        foreach ($iterator as $path) {
40            // $path は SplFileInfo オブジェクトではなく、直接ファイルパス文字列です。
41            echo "- " . $path . "\n";
42            $count++;
43        }
44
45        if ($count === 0) {
46            echo "条件に一致するファイルは見つかりませんでした。\n";
47        }
48
49    } catch (UnexpectedValueException $e) {
50        echo "エラー: GlobIterator の操作中に問題が発生しました: " . $e->getMessage() . "\n";
51    } finally {
52        // 後処理: 作成したファイルとディレクトリを削除します。
53        foreach ($filesToCreate as $fileName) {
54            $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
55            if (file_exists($filePath)) {
56                unlink($filePath);
57            }
58        }
59        if (is_dir($tempDir)) {
60            rmdir($tempDir);
61        }
62        echo "\n--- 処理が完了し、一時ファイルは削除されました ---\n";
63    }
64}
65
66// 関数を実行してデモンストレーションを開始します。
67demonstrateGlobIteratorCurrentAsPathname();
68

PHP 8のGlobIterator::CURRENT_AS_PATHNAMEは、ファイルシステムの操作を効率化するGlobIteratorクラスに属する定数です。この定数は、指定されたパターンに一致するファイルを繰り返し処理する際に、取得される要素の形式を制御します。

通常、GlobIteratorはイテレーション時にファイルの詳細情報を含むSplFileInfoオブジェクトを返します。しかし、GlobIteratorのコンストラクタでCURRENT_AS_PATHNAME定数をフラグとして指定すると、イテレーション中に返される各要素がSplFileInfoオブジェクトではなく、マッチしたファイルの完全なパス名を表す文字列に直接変わります。

この定数自体には引数はなく、直接の戻り値もありませんが、GlobIteratorの挙動を変更する設定として機能します。システムエンジニアを目指す初心者の方にとって、特定の条件に合致するファイルのパスを、追加のオブジェクト操作なしで文字列として直接取得したい場合に、コードを簡潔にし、処理を分かりやすくする上で非常に便利です。

Copy
1<?php
2
3/**
4 * GlobIterator::CURRENT_AS_PATHNAME を使用して、
5 * カレントディレクトリ内のファイルおよびディレクトリのパスを文字列として取得する関数です。
6 *
7 * この関数を実行する前に、カレントディレクトリにいくつかのファイルやディレクトリを
8 * 作成しておくと、動作をより明確に確認できます（例: 'test.txt', 'script.php', 'my_folder/').
9 */
10function listCurrentDirectoryItemsAsPaths(): void
11{
12    echo "--- カレントディレクトリ内のアイテムのパス (文字列) ---\n";
13    echo "--- GlobIterator::CURRENT_AS_PATHNAME フラグを使用 ---\n\n";
14
15    // GlobIterator は、指定されたパターンにマッチするファイルやディレクトリを検索します。
16    // './*' はカレントディレクトリ内のすべてのファイルとディレクトリを対象とします。
17    //
18    // GlobIterator::CURRENT_AS_PATHNAME フラグを指定することで、
19    // イテレータが SplFileInfo オブジェクトの代わりに、
20    // 各アイテムの完全なパス名（文字列）を直接返すようになります。
21    $iterator = new GlobIterator('./*', GlobIterator::CURRENT_AS_PATHNAME);
22
23    // イテレータをループし、各パス名（文字列）を出力します。
24    foreach ($iterator as $path) {
25        echo $path . "\n";
26    }
27}
28
29// 関数を実行します。
30listCurrentDirectoryItemsAsPaths();

このPHPのサンプルコードは、GlobIterator::CURRENT_AS_PATHNAME定数を利用して、カレントディレクトリ（現在スクリプトが実行されている場所）内にあるファイルやディレクトリのパスを、文字列として取得し一覧表示する方法を示しています。

listCurrentDirectoryItemsAsPaths関数内では、まずGlobIteratorクラスの新しいインスタンスが作成されます。GlobIteratorは、指定されたパターンに一致するファイルやディレクトリを検索し、それらを反復処理するためのクラスです。ここでは'./*'というパターンを指定しており、これはカレントディレクトリ内のすべてのファイルとディレクトリを対象とすることを意味します。

重要な点は、GlobIteratorのコンストラクタに第二引数としてGlobIterator::CURRENT_AS_PATHNAME定数を渡していることです。通常、GlobIteratorはファイルやディレクトリに関する詳細な情報を含むSplFileInfoオブジェクトを返しますが、この定数を指定すると、イテレータが各アイテムの完全なパス名（文字列）を直接返すように動作が変更されます。

その後、foreachループを使ってイテレータが順に処理され、取得した各パス名（文字列）が画面に表示されます。これにより、カレントディレクトリ内のすべてのアイテムが、そのパス名としてシンプルに一覧出力されます。このCURRENT_AS_PATHNAME定数自体は、引数を受け取らず、また特定の値を戻り値として返すものではありません。これはGlobIteratorのイテレーションの挙動を調整するためのオプション（フラグ）として機能します。