【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()メソッドは、ファイルシステムの存在確認や、見つかったファイルの繰り返し処理を制御する効果的な「バリデータ」として機能します。