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

Copy
1<?php
2
3/**
4 * 指定されたパターンにマッチするファイルが存在するかどうかを検証し、
5 * 見つかったファイルのベース名を表示する関数。
6 *
7 * この関数では、ファイルシステム上の特定の条件（パターン）に合致するファイルが
8 * 存在するかどうかを「検証 (validate)」する際に、GlobIterator の valid() メソッドを
9 * どのように利用するかを示します。
10 *
11 * @param string $globPattern 検索するファイルシステムのパターン (例: /path/to/dir/*.txt)
12 * @return bool パターンにマッチするファイルが見つかった場合は true、それ以外は false
13 */
14function validateAndListMatchingFiles(string $globPattern): bool
15{
16    // GlobIterator を使用して、指定されたパターンにマッチするファイルを検索します。
17    // PHP 8 では、イテレータは SplFileInfo のインスタンスを返します。
18    $iterator = new GlobIterator($globPattern);
19
20    echo "--- 検索パターン: '$globPattern' ---\n";
21
22    // GlobIterator::valid() メソッドは、イテレータが有効な要素（つまり、
23    // パターンにマッチする次のファイル）を指している場合に true を返します。
24    // これにより、ファイルが見つかったかどうか、またはイテレーションを継続できるか検証します。
25    if ($iterator->valid()) {
26        echo "以下のファイルが見つかりました:\n";
27        // イテレータが有効な要素を指している間、ループを継続します。
28        // これは、パターンにマッチするすべてのファイルを処理するために使用されます。
29        while ($iterator->valid()) {
30            // 現在の要素（SplFileInfo オブジェクト）を取得します。
31            $fileInfo = $iterator->current();
32            // ファイルのベース名（ファイル名と拡張子）を表示します。
33            echo "- " . $fileInfo->getBasename() . "\n";
34
35            // 次の要素へ進みます。次の要素が存在しない場合、valid() は false を返します。
36            $iterator->next();
37        }
38        echo "検証完了: マッチするファイルが存在します。\n";
39        return true;
40    } else {
41        echo "検証完了: マッチするファイルは見つかりませんでした。\n";
42        return false;
43    }
44}
45
46// --- サンプルコードの実行例 ---
47
48// 一時的なディレクトリを作成します。これにより、実際のファイルシステムに影響を与えずにテストできます。
49$tempDir = __DIR__ . '/temp_glob_validator_test';
50if (!is_dir($tempDir)) {
51    mkdir($tempDir);
52}
53
54// テスト用のファイルをいくつか作成します。
55file_put_contents($tempDir . '/config.txt', 'このファイルは設定情報を含みます。');
56file_put_contents($tempDir . '/report.log', 'このファイルはログ情報を含みます。');
57file_put_contents($tempDir . '/settings.txt', 'このファイルも設定情報を含みます。');
58file_put_contents($tempDir . '/image.jpg', 'このファイルは画像です。'); // .txt や .log パターンにはマッチしないファイル
59
60echo "--- ファイル検証テスト開始 ---\n\n";
61
62// 例1: .txt 拡張子のファイルを検証します。
63// GlobIterator::valid() は、これらのファイルが存在するため true を返し、ループが実行されます。
64validateAndListMatchingFiles($tempDir . '/*.txt');
65echo "\n";
66
67// 例2: .json 拡張子のファイルを検証します。
68// このパターンにマッチするファイルは存在しないため、GlobIterator::valid() は最初の呼び出しで false を返します。
69validateAndListMatchingFiles($tempDir . '/*.json');
70echo "\n";
71
72// 例3: .log 拡張子のファイルを検証します。
73validateAndListMatchingFiles($tempDir . '/*.log');
74echo "\n";
75
76echo "--- ファイル検証テスト終了 ---\n\n";
77
78// クリーンアップ: 作成した一時ファイルとディレクトリを削除します。
79// glob() でディレクトリ内のすべてのアイテムのパスを取得し、unlink() で削除します。
80array_map('unlink', glob("$tempDir/*"));
81// ディレクトリを削除します。
82rmdir($tempDir);
83
84?>

PHP 8のGlobIteratorクラスに属するvalid()メソッドは、ファイルシステム上で特定のパターンにマッチするファイルを検索する際に使用するイテレータの状態を検証するために用いられます。このメソッドは引数を一切取らず、現在イテレータが有効な要素（ファイルやディレクトリ）を指しているかどうかをbool型の戻り値で示します。

valid()がtrueを返すのは、GlobIteratorが指定されたパターンに合致するファイルやディレクトリを現在指している場合です。これは、パターンにマッチするファイルが見つかったこと、またはイテレーションを継続して次のファイルを処理できることを意味します。対照的に、falseを返す場合は、イテレータが有効な要素を指していない、つまり、指定されたパターンにマッチするファイルがこれ以上見つからないか、最初から一つも存在しなかったことを示します。

サンプルコードでは、validateAndListMatchingFiles関数内でGlobIteratorを初期化した後、最初にif ($iterator->valid())を用いて、パターンにマッチするファイルが一つでも存在するかどうかを検証しています。ファイルが存在すればtrueが返され、その後while ($iterator->valid())ループを通じて、マッチするすべてのファイルを一つずつ処理し、そのベース名を表示しています。このように、valid()メソッドは、ファイルシステムの存在確認や、見つかったファイルの繰り返し処理を制御する効果的な「バリデータ」として機能します。

Copy
1<?php
2
3// このサンプルコードは、GlobIterator::valid() メソッドの動作を説明します。
4// GlobIterator は、ファイルシステムをイテレート（繰り返し処理）するための PHP の組み込みクラスです。
5// GlobIterator::valid() は、イテレータが有効な要素（ファイルやディレクトリ）を指しているかを検証し、
6// 真偽値 (true/false) を返します。これは主に、手動でイテレーションを制御する while ループで使用されます。
7
8// 1. テスト用のディレクトリとファイルを作成します。
9//    これにより、GlobIterator が処理できる実際のファイルパスが存在することを確認できます。
10$tempDir = __DIR__ . '/temp_glob_files';
11if (!is_dir($tempDir)) {
12    mkdir($tempDir);
13}
14file_put_contents($tempDir . '/report_2023.txt', '年間レポート2023');
15file_put_contents($tempDir . '/data_2024.csv', 'データ2024'); // このファイルはパターンにマッチしない
16file_put_contents($tempDir . '/report_2024.txt', '年間レポート2024');
17
18echo "GlobIterator を使用して '{$tempDir}/report_*.txt' パターンにマッチするファイルを検索します。\n";
19echo "GlobIterator::valid() は、現在イテレータが有効な要素（ファイル）を指しているかを確認します。\n\n";
20
21try {
22    // 2. GlobIterator のインスタンスを作成します。
23    //    指定されたパターンにマッチするファイル（ここでは 'report_*.txt'）をすべて見つけます。
24    $iterator = new GlobIterator($tempDir . '/report_*.txt');
25
26    // 3. イテレータを最初の要素に巻き戻します。
27    //    while ループで手動でイテレーションを始める前に、通常はこれを行います。
28    $iterator->rewind();
29
30    // 4. while ループと GlobIterator::valid() を使ってイテレーションを行います。
31    //    valid() メソッドが true を返す間、つまり有効な要素が存在する間、ループが継続します。
32    //    イテレータがこれ以上有効な要素を指さなくなると (valid() が false を返すと)、ループは終了します。
33    while ($iterator->valid()) {
34        // 5. current() メソッドで現在の有効なファイルパスを取得します。
35        $currentFile = $iterator->current();
36        echo "見つかった有効なファイル: " . $currentFile . "\n";
37
38        // 6. next() メソッドでイテレータを次の要素に進めます。
39        //    次の要素が存在しない場合、valid() は次回のループで false を返します。
40        $iterator->next();
41    }
42    echo "\nすべての有効なファイルを処理しました。\n";
43
44    // 7. 一致するファイルが全くなかった場合のメッセージも表示できます。
45    if ($iterator->count() === 0) {
46        echo "指定されたパターン '{$tempDir}/report_*.txt' に一致するファイルは見つかりませんでした。\n";
47    }
48
49} catch (UnexpectedValueException $e) {
50    // GlobIterator のコンストラクタが失敗した場合の例外処理。
51    // 例: 指定されたパスが無効である、またはアクセス権がない場合。
52    echo "エラーが発生しました: " . $e->getMessage() . "\n";
53    echo "指定されたファイルパスのパターンを確認してください。\n";
54} finally {
55    // 8. スクリプトの実行後、作成した一時ファイルをクリーンアップします。
56    //    これはサンプルコードを単体で動作させるためのもので、実際のアプリケーションでは通常不要です。
57    @unlink($tempDir . '/report_2023.txt');
58    @unlink($tempDir . '/data_2024.csv');
59    @unlink($tempDir . '/report_2024.txt');
60    @rmdir($tempDir);
61}

PHP 8のGlobIterator::valid()メソッドは、ファイルシステム内の特定のパターンにマッチするファイルやディレクトリを繰り返し処理（イテレート）するGlobIteratorクラスの重要な機能です。このメソッドは引数を一切取らず、現在のイテレータが有効な要素（ファイルやディレクトリ）を指しているかを検証し、その結果を真偽値（trueまたはfalse）で返します。

主に、whileループを使ってファイルリストを順に処理する際に、ループの継続条件として利用されます。valid()がtrueを返している間は、まだ処理すべき有効な要素が存在することを示し、ループは続行されます。イテレータがすべての要素を処理し終え、これ以上有効な要素を指さなくなった時点でvalid()はfalseを返し、ループを終了させます。これにより、ファイルの一覧を安全かつ効率的に取得・操作できます。サンプルコードでは、指定されたパターンに合致するファイルを一つずつ見つけ出すためにvalid()が使用されており、見つかった各ファイルのパスを出力する流れを示しています。

Copy
1<?php
2
3/**
4 * GlobIterator::valid() メソッドの動作を示すサンプルコードです。
5 *
6 * GlobIterator は、指定された glob パターンにマッチするファイルやディレクトリを
7 * 繰り返し処理（イテレーション）するための SplFileInfo オブジェクトのイテレータを提供します。
8 *
9 * valid() メソッドは、イテレータが現在、有効な（存在する）要素を指している場合に
10 * true を返し、そうでない場合は false を返します。
11 * これは通常、while ループでイテレータを手動で進める際に、ループを継続するかどうかの
12 * 条件として使用されます。
13 */
14
15try {
16    // 現在のスクリプトがあるディレクトリ内のすべてのファイルとディレクトリを対象とするパターン
17    // 例えば、`__DIR__ . '/*'` は、`C:\path\to\your\script\*` のようになります。
18    $pattern = __DIR__ . '/*';
19    $iterator = new GlobIterator($pattern);
20
21    echo "--- イテレーション開始前の状態 ---" . PHP_EOL;
22    // イテレータが初期位置で有効な要素を指しているか確認
23    // マッチするファイルやディレクトリが存在すれば true、そうでなければ false を返します。
24    echo "イテレータは有効な要素を指していますか？: " . ($iterator->valid() ? "はい" : "いいえ") . PHP_EOL;
25
26    // イテレータに要素が存在する場合のみ、以下のループ処理を実行します。
27    if ($iterator->valid()) {
28        echo PHP_EOL . "--- イテレーション処理中 ---" . PHP_EOL;
29        // valid() が true を返す限り、ループを続けます。
30        while ($iterator->valid()) {
31            // 現在の要素（SplFileInfo オブジェクト）を取得します。
32            $fileInfo = $iterator->current();
33            echo "  有効: はい, パス: " . $fileInfo->getPathname() . PHP_EOL;
34
35            // イテレータを次の要素に進めます。
36            $iterator->next();
37        }
38        echo PHP_EOL . "--- イテレーション処理完了 ---" . PHP_EOL;
39    } else {
40        echo PHP_EOL . "--- 指定されたパターン '" . $pattern . "' にマッチするファイルまたはディレクトリが見つかりませんでした。 ---" . PHP_EOL;
41    }
42
43    // ループ終了後、イテレータはすべての要素を処理し終えているため、
44    // valid() は false を返すべきです。
45    echo "イテレータは有効な要素を指していますか？: " . ($iterator->valid() ? "はい" : "いいえ") . PHP_EOL;
46
47} catch (UnexpectedValueException $e) {
48    // GlobIterator の初期化でエラーが発生した場合（例: 無効なパターン）
49    echo "エラー: GlobIterator の初期化中に問題が発生しました。 " . $e->getMessage() . PHP_EOL;
50    echo "指定されたパターン '" . $pattern . "' を確認してください。" . PHP_EOL;
51}
52

GlobIterator::valid()は、PHP 8で導入されたGlobIteratorクラスに属するメソッドです。GlobIteratorは、指定されたglobパターン（例: *.txt）にマッチするファイルやディレクトリを繰り返し処理（イテレーション）するための機能を提供します。

このvalid()メソッドは、現在イテレータが有効な要素、つまり処理すべきファイルやディレクトリを指しているかどうかを判断します。引数は受け取らず、戻り値はbool型です。もしイテレータが有効な要素を指していればtrueを返し、すべての要素を処理し終えた後や、最初から有効な要素が存在しない場合はfalseを返します。

サンプルコードでは、while ($iterator->valid())という形でこのメソッドが使用されています。これは、イテレータが有効な要素を指している間、つまり処理すべきファイルやディレクトリがまだ残っている間はループを継続するという意味です。これにより、ファイルシステム上の複数の項目を安全かつ効率的に順次処理できます。ループ開始前の状態確認や、ループ終了後の状態確認にも利用できるため、イテレーション処理の制御において非常に重要な役割を果たします。