【PHP8.x】RecursiveCallbackFilterIterator::valid()メソッドの使い方
validメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
『validメソッドは、現在のイテレータの位置が有効かどうかを確認するメソッドです。このメソッドは、RecursiveCallbackFilterIteratorが内部的に保持しているイテレータを操作する上で中心的な役割を果たします。具体的には、まず内部イテレータの現在の位置に要素が存在するかを判定します。そして、要素が存在する場合には、コンストラクタで指定されたコールバック関数をその要素に適用し、フィルタリング条件を満たすかどうかを評価します。現在の要素が条件を満たさない場合、このメソッドは自動的にイテレータを次の要素に進め、条件を満たす要素が見つかるまで探索を続けます。条件を満たす有効な要素が見つかった時点でtrueを返し、見つからないままイテレータの終端に達した場合はfalseを返します。この一連の動作は、foreach文などのループ処理で内部的に利用され、ループを継続するか終了するかを決定するために使われます。』
構文(syntax)
1<?php 2 3// 再帰的なイテレータを準備 4$iterator = new RecursiveArrayIterator(['item1', 'item2']); 5 6// フィルタリング用のコールバック関数を準備 7$callback = function ($current, $key, $iterator) { 8 // この例では全ての要素を有効とする 9 return true; 10}; 11 12// RecursiveCallbackFilterIterator のインスタンスを作成 13$filterIterator = new RecursiveCallbackFilterIterator($iterator, $callback); 14 15// valid() メソッドを呼び出し、現在の位置が有効か (true) 、 16// それとも終端に達したか (false) を確認する。 17$result = $filterIterator->valid(); 18 19// $result には bool 値が格納される 20var_dump($result);
引数(parameters)
引数なし
引数はありません
戻り値(return)
bool
現在のイテレータが有効な要素を指している場合は true を返します。無効な場合は false を返します。
サンプルコード
PHP RecursiveCallbackFilterIterator でデータを検証する
1<?php 2 3/** 4 * 特定の条件（バリデーション）を満たす要素のみを再帰的に抽出し表示します。 5 * 6 * この例では、部署階層を表す多次元配列から、 7 * 30歳以上の従業員データのみをフィルタリング（検証）します。 8 * RecursiveCallbackFilterIterator は、コールバック関数を使って 9 * 各要素を検証し、条件に合うものだけを通過させます。 10 * ループ処理では、Iterator::valid() メソッドが内部的に（または明示的に） 11 * 次に処理すべき有効な要素が存在するかをチェックするために使われます。 12 */ 13function filterAndDisplayValidatedData(): void 14{ 15 // サンプルデータ: 部署と従業員の階層構造 16 $companyStructure = [ 17 'Sales' => [ 18 ['name' => 'Alice', 'age' => 32, 'role' => 'Manager'], 19 ['name' => 'Bob', 'age' => 28, 'role' => 'Staff'], 20 ], 21 'Engineering' => [ 22 'Frontend' => [ 23 ['name' => 'Charlie', 'age' => 35, 'role' => 'Lead'], 24 ], 25 'Backend' => [ 26 ['name' => 'David', 'age' => 29, 'role' => 'Developer'], 27 ['name' => 'Eve', 'age' => 41, 'role' => 'Architect'], 28 ], 29 ], 30 ]; 31 32 // 多次元配列を再帰的に走査するためのイテレータを作成 33 $arrayIterator = new RecursiveArrayIterator($companyStructure); 34 35 // 検証ロジックを定義するコールバック関数 36 // ここでは、要素が配列で、かつ 'age' が30以上であるかを検証（validate）します。 37 $validatorCallback = function ($current, $key, $iterator) { 38 // 子を持つ階層（部署名など）は常に走査対象とする 39 if ($iterator->hasChildren()) { 40 return true; 41 } 42 43 // 従業員データ（配列）で、かつ年齢が30歳以上か検証する 44 return is_array($current) && isset($current['age']) && $current['age'] >= 30; 45 }; 46 47 // コールバック関数を使ってフィルタリングを行う再帰イテレータを作成 48 $filterIterator = new RecursiveCallbackFilterIterator($arrayIterator, $validatorCallback); 49 50 // 再帰的なイテレータをフラットに展開して扱いやすくする 51 $iterator = new RecursiveIteratorIterator($filterIterator); 52 53 echo "Validated Employees (Age >= 30):\n"; 54 55 // イテレータのポインタを先頭に移動 56 $iterator->rewind(); 57 58 // valid() を使って、現在のポインタ位置に有効な要素が存在するかチェック 59 while ($iterator->valid()) { 60 // current() で現在の要素を取得 61 $employee = $iterator->current(); 62 printf( 63 "- Name: %s, Age: %d, Role: %s\n", 64 $employee['name'], 65 $employee['age'], 66 $employee['role'] 67 ); 68 // next() でポインタを次の要素に進める 69 $iterator->next(); 70 } 71} 72 73// 関数を実行 74filterAndDisplayValidatedData();
このPHPコードは、RecursiveCallbackFilterIteratorクラスを使い、階層構造を持つ多次元配列から特定の条件を満たす要素だけを再帰的に抽出する例です。サンプルでは、部署階層データの中から「30歳以上」という条件で従業員データを検証（バリデーション）し、該当するデータのみを取り出しています。
この処理の中でvalid()メソッドは、イテレータのループ処理において、現在の位置に処理すべき有効な要素が存在するかどうかを判定する重要な役割を担います。このメソッドに引数はなく、戻り値としてbool型（真偽値）を返します。具体的には、有効な要素が存在すればtrueを、これ以上処理すべき要素がなければ（データの終端に達していれば）falseを返します。
サンプルコードのwhile ($iterator->valid())というループ条件は、「フィルタリングされた有効な従業員データがまだ存在する間は処理を繰り返す」という意味になります。valid()がtrueを返す限りループは続き、ループ内でcurrent()によって要素が取得され、next()で次の要素へと進みます。そして、すべての有効な要素を処理し終えるとvalid()がfalseを返し、ループが安全に終了します。
valid()メソッドは、イテレータが現在有効なデータを指しているかを判定し、ループ処理を続けるかどうかの判断に使われます。foreach文ではこの確認が内部で自動的に行われますが、サンプルのようにwhile文でイテレータを直接制御する場合は、valid()の呼び出しが必須です。これを忘れると無限ループに陥る危険があるため注意しましょう。コールバック関数内のisset()によるキーの存在確認は、想定外のデータ構造でエラーが発生するのを防ぐための重要なバリデーションです。また、hasChildren()で親要素を常に通過させる処理は、深い階層のデータまで正しく再帰的に走査するために不可欠な記述となります。
PHP RecursiveCallbackFilterIteratorでログファイル検証する
1<?php 2 3/** 4 * RecursiveCallbackFilterIterator を使用して、 5 * 特定の条件（この例では .log ファイル）に一致するファイルを再帰的に検索するバリデーターの例です。 6 * 7 * このコードは、指定されたディレクトリ内のファイルとサブディレクトリを走査し、 8 * コールバック関数で定義された検証ロジックに基づいて .log ファイルのみを出力します。 9 */ 10class FileValidatorExample 11{ 12 /** 13 * サンプルコードのメイン処理を実行します。 14 * 15 * 1. テスト用の一時ディレクトリとファイルを作成します。 16 * 2. RecursiveCallbackFilterIterator を使って .log ファイルをフィルタリングします。 17 * 3. 結果を出力します。 18 * 4. 作成した一時ディレクトリとファイルをクリーンアップします。 19 */ 20 public function run(): void 21 { 22 // 検証対象の一時的なディレクトリとファイル構造を準備 23 $baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_validator_test'; 24 $this->setupDummyDirectory($baseDir); 25 26 echo "以下のディレクトリを再帰的に検索し、'.log' ファイルのみを抽出します:\n"; 27 echo "{$baseDir}\n\n"; 28 29 // ディレクトリを再帰的に走査するためのイテレータ 30 $directoryIterator = new RecursiveDirectoryIterator( 31 $baseDir, 32 FilesystemIterator::SKIP_DOTS 33 ); 34 35 // フィルタリング（検証）ロジックを定義したコールバック関数 36 // このコールバックが「バリデーター」として機能します。 37 $filterCallback = function (SplFileInfo $current, string $key, RecursiveIterator $iterator): bool { 38 // ディレクトリは再帰的に探索するため、常に true を返す 39 if ($iterator->hasChildren()) { 40 return true; 41 } 42 // ファイルの場合、拡張子が 'log' であるか検証する 43 return $current->isFile() && $current->getExtension() === 'log'; 44 }; 45 46 // コールバック関数を使ってフィルタリングを行うイテレータを作成 47 $filterIterator = new RecursiveCallbackFilterIterator($directoryIterator, $filterCallback); 48 49 // フィルタリングされた結果をイテレーションして表示 50 // foreach ループは内部でイテレータの valid() メソッドを自動的に呼び出し、 51 // 有効な要素がなくなるまで処理を続けます。 52 echo "検証結果 ('.log' ファイルのみ):\n"; 53 foreach (new RecursiveIteratorIterator($filterIterator) as $fileInfo) { 54 echo "- " . $fileInfo->getPathname() . "\n"; 55 } 56 57 // 後片付け 58 $this->cleanupDummyDirectory($baseDir); 59 } 60 61 /** 62 * テスト用のディレクトリとファイルを生成します。 63 * 64 * @param string $baseDir ベースディレクトリのパス 65 */ 66 private function setupDummyDirectory(string $baseDir): void 67 { 68 // 既存の場合は一度削除してクリーンな状態にする 69 if (is_dir($baseDir)) { 70 $this->cleanupDummyDirectory($baseDir); 71 } 72 73 // ディレクトリ構造を作成 74 mkdir($baseDir . '/app/logs', 0777, true); 75 mkdir($baseDir . '/data/tmp', 0777, true); 76 77 // サンプルファイルを作成 78 file_put_contents($baseDir . '/app/logs/system.log', 'system log entry'); 79 file_put_contents($baseDir . '/app/logs/error.log', 'error log entry'); 80 file_put_contents($baseDir . '/app/config.php', '<?php return [];'); 81 file_put_contents($baseDir . '/data/access.log', 'access log entry'); 82 file_put_contents($baseDir . '/data/tmp/cache.tmp', 'cache data'); 83 } 84 85 /** 86 * テスト用に作成したディレクトリとファイルを再帰的に削除します。 87 * 88 * @param string $dirPath 削除するディレクトリのパス 89 */ 90 private function cleanupDummyDirectory(string $dirPath): void 91 { 92 if (!is_dir($dirPath)) { 93 return; 94 } 95 96 $iterator = new RecursiveIteratorIterator( 97 new RecursiveDirectoryIterator($dirPath, FilesystemIterator::SKIP_DOTS), 98 RecursiveIteratorIterator::CHILD_FIRST 99 ); 100 101 foreach ($iterator as $file) { 102 if ($file->isDir()) { 103 rmdir($file->getRealPath()); 104 } else { 105 unlink($file->getRealPath()); 106 } 107 } 108 rmdir($dirPath); 109 } 110} 111 112// クラスのインスタンスを作成して実行 113$example = new FileValidatorExample(); 114$example->run();
RecursiveCallbackFilterIterator::valid()メソッドは、イテレータの現在の位置が有効な要素を指しているかどうかを判定します。このメソッドは、foreachループなどでイテレータを繰り返し処理する際に、次の要素が存在するかどうかを確認するためにPHPエンジンによって自動的に呼び出されます。
このメソッドに引数はありません。戻り値は真偽値（bool）で、現在の位置がフィルタリング条件を満たす有効な要素であればtrueを、これ以上有効な要素がない（ループを終了すべき）場合はfalseを返します。
サンプルコードでは、.logファイルのみを抽出するコールバック関数がバリデーターとして機能しています。foreachループが始まると、valid()メソッドが内部でこのコールバック関数を呼び出し、条件に合う要素を探します。条件を満たす要素が見つかるまでイテレータは進み、見つかった時点でvalid()がtrueを返すことで、ループ内の処理が実行されます。全てのファイルを調べ終え、条件に合うものがなくなるとfalseを返し、ループが終了します。このようにvalid()は、定義された検証ルールに基づいて処理を続けるか判断する役割を担っています。
このコードでは foreach ループがイテレータを処理する際、内部で自動的に RecursiveCallbackFilterIterator の valid メソッドを呼び出します。この valid メソッドは、指定されたコールバック関数を実行し、その結果が true の要素のみを有効と判断します。コールバック関数で最も注意すべき点は、ディレクトリ自体は常に true を返し、再帰的な探索を許可することです。もしディレクトリに false を返すと、その配下にあるファイルは一切検証されません。また、非常に大きなディレクトリを走査するとパフォーマンスに影響が出る可能性があるため、対象範囲には注意してください。実運用では、指定したパスが存在しない場合に備えて try-catch による例外処理を追加すると、より安全になります。