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

Copy
1<?php
2
3// GlobIterator::current メソッドの使用例
4// 現在のディレクトリ内の .php ファイルを検索し、それぞれのファイルパスを表示します。
5
6/**
7 * 現在のディレクトリにあるPHPファイルをリストアップし、それぞれのパスを表示します。
8 * GlobIterator::current() メソッドを使用して、イテレータの現在の要素（ファイルパス）を取得します。
9 */
10function listPhpFilesInCurrentDirectory(): void
11{
12    // GlobIterator を使用して、現在のディレクトリ内の拡張子が .php のファイルを検索します。
13    // './*.php' パターンは、現在のディレクトリ (./) 内の
14    // 任意の名前で .php 拡張子を持つファイルにマッチします。
15    $iterator = new GlobIterator('./*.php');
16
17    echo "現在のディレクトリ内の .php ファイル:\n";
18
19    // イテレータを反復処理します。
20    // foreach ループは、イテレータを自動的に進め、各要素を提供します。
21    // $path 変数には、現在のファイルパスが自動的に割り当てられます。
22    foreach ($iterator as $path) {
23        // GlobIterator::current() メソッドは、イテレータが現在指している要素（ファイルパス）を返します。
24        // この戻り値は string 型です。
25        // foreach の内部では自動的に current() が呼ばれて $path に値がセットされますが、
26        // ここではメソッドの存在とその戻り値を明示的に示すために呼び出しています。
27        $currentFilePath = $iterator->current();
28
29        echo "- " . $currentFilePath . "\n";
30    }
31
32    // ファイルが見つからなかった場合のメッセージ
33    if ($iterator->count() === 0) {
34        echo "  .php ファイルが見つかりませんでした。\n";
35        echo "  (このスクリプトファイル自体は結果に含まれない場合があります)\n";
36    }
37}
38
39// 関数を実行して、スクリプトの動作を確認します。
40listPhpFilesInCurrentDirectory();

PHP 8のGlobIterator::currentメソッドは、ファイルシステムを探索し、特定のパターンに合致するファイルやディレクトリを反復処理するGlobIteratorクラスに属しています。このメソッドは、イテレータが現在指し示している要素、具体的には現在のファイルやディレクトリのパスを取得する役割を持ちます。

currentメソッドは引数を一切取りません。呼び出す際は$iterator->current()のように、引数なしで実行します。戻り値はstring型であり、イテレータが現在位置しているファイルまたはディレクトリの完全なパスが文字列として返されます。

サンプルコードでは、GlobIteratorを使用して現在のディレクトリ内にあるすべての.phpファイルを検索し、それぞれのファイルパスを表示しています。foreachループで$iteratorを反復処理する際、ループ変数$pathには自動的にcurrent()メソッドの戻り値が代入されます。しかし、サンプルコードでは$iterator->current()を明示的に呼び出すことで、このメソッドの機能と戻り値がstring型であることの理解を深めることができます。このメソッドは、イテレータで取得した現在の要素の正確なパス情報を取得し、次の処理に活用する際に利用されます。

Copy
1<?php
2
3/**
4 * GlobIterator を使用して、ファイルシステムから現在の月に該当するレポートファイルを検索するデモンストレーション。
5 * GlobIterator::current() メソッドの戻り値が文字列であることを示します。
6 */
7function findCurrentMonthReports(): void
8{
9    // 一時的なテスト用ディレクトリを作成します。
10    // このディレクトリにサンプルファイルを生成し、処理後に削除します。
11    $tempDir = __DIR__ . '/temp_reports';
12    if (!is_dir($tempDir)) {
13        mkdir($tempDir, 0777, true);
14    }
15
16    // 現在の年と月を 'YYYY-MM' 形式で取得します。
17    // 例: 2023-10
18    $currentYearMonth = date('Y-m');
19
20    // テスト用のレポートファイルをいくつか作成します。
21    // これにより、GlobIterator が処理するファイルが存在する状態を作ります。
22    file_put_contents($tempDir . '/report_2023-01.txt', 'レポート2023-01');
23    file_put_contents($tempDir . '/report_' . $currentYearMonth . '.txt', '現在の月のレポート');
24    file_put_contents($tempDir . '/report_2024-03.txt', '未来のレポート');
25    file_put_contents($tempDir . '/other_document.pdf', 'PDFファイル'); // これは GlobIterator の対象外になります
26
27    echo "現在の年月: " . $currentYearMonth . "\n\n";
28
29    // GlobIterator をインスタンス化し、指定されたパターンに一致するファイルを探します。
30    // ここでは 'temp_reports/' ディレクトリ内の全ての .txt ファイルを対象とします。
31    $globPattern = $tempDir . '/*.txt';
32
33    // FilesystemIterator::CURRENT_AS_PATHNAME フラグを指定することで、
34    // GlobIterator::current() メソッドがファイルパスの文字列を直接返すようになります。
35    // これにより、提供されたリファレンス情報「戻り値: string」と一致する振る舞いを実現します。
36    $iterator = new GlobIterator($globPattern, FilesystemIterator::CURRENT_AS_PATHNAME);
37
38    echo "--- GlobIterator によるファイル検出と current() メソッドの利用 ---\n";
39
40    // イテレータに有効な要素があるか（つまり、パターンに一致するファイルが見つかったか）を確認します。
41    if (!$iterator->valid()) {
42        echo "指定されたパターン ('" . $globPattern . "') に一致するファイルは見つかりませんでした。\n";
43    } else {
44        // イテレータを最初の要素に巻き戻します。
45        // これにより、常に最初のファイルから処理を開始できます。
46        $iterator->rewind();
47
48        // current() メソッドを呼び出し、現在のイテレータ要素（ここでは最初のファイルパス）を取得します。
49        // FilesystemIterator::CURRENT_AS_PATHNAME フラグにより、ファイルパスの文字列が直接返されます。
50        echo "最初のファイル (current() で取得):\n";
51        $firstFilePath = $iterator->current(); // ファイルパス (string) が直接返される
52        echo "- " . $firstFilePath . "\n";
53
54        // 取得したファイルパスから年月部分を抽出し、現在の年月と比較します。
55        if (preg_match('/report_(\d{4}-\d{2})\.txt$/', $firstFilePath, $matches)) {
56            $fileMonth = $matches[1];
57            if ($fileMonth === $currentYearMonth) {
58                echo "  これは現在の月のレポートです。\n";
59            } else {
60                echo "  これは現在の月のレポートではありません (年月: " . $fileMonth . ")。\n";
61            }
62        }
63        echo "\n";
64
65
66        echo "すべてのファイル (foreach ループでイテレート):\n";
67        // foreach ループはイテレータを順に処理します。
68        // FilesystemIterator::CURRENT_AS_PATHNAME フラグにより、
69        // 各 `$filePath` 変数には直接ファイルパスの文字列が代入されます。
70        foreach ($iterator as $filePath) {
71            echo "- " . $filePath;
72
73            // ファイルパスから年月部分を抽出し、現在の年月と比較します。
74            if (preg_match('/report_(\d{4}-\d{2})\.txt$/', $filePath, $matches)) {
75                $fileMonth = $matches[1];
76                if ($fileMonth === $currentYearMonth) {
77                    echo " (現在の月のレポート)";
78                } else {
79                    echo " (他の月のレポート: " . $fileMonth . ")";
80                }
81            }
82            echo "\n";
83        }
84    }
85
86    // 後処理：作成した一時ファイルを削除し、ディレクトリも削除します。
87    // glob() 関数は、指定されたパターンに一致するすべてのファイルとディレクトリのパスを配列として返します。
88    $files = glob($tempDir . '/*');
89    foreach ($files as $file) {
90        if (is_file($file)) {
91            unlink($file); // ファイルを削除
92        }
93    }
94    rmdir($tempDir); // 空になったディレクトリを削除
95}
96
97// サンプルコードを実行します。
98findCurrentMonthReports();
99

PHP 8のGlobIterator::current()メソッドは、ファイルシステムを探索し、指定されたパターンに一致するファイルの情報を取得する際に使用されます。このメソッドは引数を一切受け取らず、イテレータが現在指している要素の値を返します。GlobIteratorは通常、ファイルパスやファイル情報オブジェクトを要素として扱いますが、サンプルコードではFilesystemIterator::CURRENT_AS_PATHNAMEフラグを指定しています。このフラグにより、current()メソッドは直接ファイルパスを表す文字列を戻り値として返します。

サンプルコードは、現在の月に該当するレポートファイルを検索するシナリオでcurrent()メソッドを利用しています。このメソッドで取得したファイルパス（文字列）からレポートの年月を抽出し、現在の年月と比較することで、特定のレポートを識別しています。このように、current()メソッドはイテレータの現在位置にある要素を文字列として取得し、ファイルパスに基づいた柔軟な処理を可能にする重要な手段です。