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

Copy
1<?php
2
3/**
4 * 特定のキーワードを含む文字列のみを許可するカスタムフィルタ。
5 *
6 * RecursiveFilterIteratorを継承し、accept()メソッドで検証ロジックを実装します。
7 * valid()メソッドは、イテレーション中（例: foreachループ）に内部的に呼び出され、
8 * accept()がtrueを返した有効な要素がまだ存在するかどうかを判定します。
9 */
10class LogLevelFilter extends RecursiveFilterIterator
11{
12    /**
13     * @var string フィルタリング（検証）に使用するキーワード
14     */
15    private string $keyword;
16
17    /**
18     * コンストラクタで、元のイテレータと検証用キーワードを受け取ります。
19     *
20     * @param RecursiveIterator $iterator
21     * @param string $keyword
22     */
23    public function __construct(RecursiveIterator $iterator, string $keyword)
24    {
25        parent::__construct($iterator);
26        $this->keyword = $keyword;
27    }
28
29    /**
30     * 現在の要素が有効かどうかを検証（validation）します。
31     * このメソッドが true を返した要素のみが、イテレーションの対象となります。
32     *
33     * @return bool
34     */
35    public function accept(): bool
36    {
37        // 現在のイテレータの要素を取得します。
38        $current = $this->current();
39
40        // 値が文字列であり、かつ指定されたキーワードを含む場合のみ有効（true）とします。
41        return is_string($current) && str_contains($current, $this->keyword);
42    }
43}
44
45// 検証対象となる多次元配列データ（ログファイルの例）
46$logEntries = [
47    '2023-10-26 10:00:00 [INFO] User logged in.',
48    '2023-10-26 10:01:15 [ERROR] Database connection failed.',
49    'system_events' => [
50        '2023-10-26 10:02:00 [DEBUG] Processing request.',
51        '2023-10-26 10:02:30 [CRITICAL] Service unavailable.',
52        '2023-10-26 10:02:45 [ERROR] Null pointer exception.',
53    ],
54    '2023-10-26 10:03:00 [INFO] Process finished.',
55];
56
57// 配列を再帰的に走査するためのイテレータを作成します。
58$arrayIterator = new RecursiveArrayIterator($logEntries);
59
60// 'ERROR' というキーワードが含まれるログのみを抽出するフィルタを作成します。
61$filterIterator = new LogLevelFilter($arrayIterator, 'ERROR');
62
63// フィルタリングされた結果を、ネスト構造を無視して（フラットに）扱えるようにします。
64$iterator = new RecursiveIteratorIterator($filterIterator);
65
66echo "検証を通過した 'ERROR' レベルのログ:\n";
67
68// foreachループは、各反復の開始時に内部で valid() メソッドを呼び出します。
69// valid() は、accept() メソッドの検証を通過する次の要素が存在するかを確認し、
70// 存在すれば true を、存在しなければ false を返してループを終了させます。
71foreach ($iterator as $validLog) {
72    echo $validLog . "\n";
73}
74
75?>

RecursiveFilterIteratorクラスのvalid()メソッドは、イテレータが現在有効な要素を指しているかどうかを判定するために使用されます。このメソッドは、foreachループなどで繰り返し処理を行う際に、各反復の開始時にPHPエンジンによって内部的に呼び出されます。

引数はなく、戻り値はbool型です。trueを返した場合は、処理すべき有効な要素が存在することを示し、ループは継続されます。一方、falseを返した場合は、これ以上有効な要素がないことを意味し、ループは終了します。

このメソッドの重要な点は、継承したクラスで実装されたaccept()メソッドと連携して動作することです。valid()は、単に次の要素が存在するかどうかを確認するだけでなく、その要素がaccept()メソッドの検証（validation）条件を満たすかどうかをチェックします。条件を満たさない要素は自動的にスキップされ、次の条件を満たす要素を探します。

サンプルコードでは、foreachループが'ERROR'という文字列を含むログを探す際にvalid()が呼び出されます。accept()メソッドの検証を通過するログが見つかるまで内部でイテレータを進め、見つかればtrueを返します。すべてのログを調べてもう有効なログが存在しない場合にfalseを返し、ループが停止します。これにより、検証済みのデータのみを効率的に処理できます。

Copy
1<?php
2
3/**
4 * 特定の条件（この例では'.log'拡張子）に一致するファイルのみを検証し、
5 * フィルタリングする再帰イテレータの実装例です。
6 *
7 * RecursiveFilterIteratorを継承し、独自の検証ロジックをaccept()メソッドに実装します。
8 * foreachループは、内部で自動的にvalid()メソッドを呼び出して、
9 * イテレーションが継続可能かどうかを判断します。
10 */
11class LogFileValidator extends RecursiveFilterIterator
12{
13    /**
14     * イテレータの現在の要素が有効かどうかを検証します。
15     *
16     * @return bool ディレクトリ、または'.log'拡張子を持つファイルの場合はtrueを返します。
17     */
18    public function accept(): bool
19    {
20        // 現在のアイテムがディレクトリの場合、再帰的に探索するため常に true を返します。
21        if ($this->hasChildren()) {
22            return true;
23        }
24
25        // 現在のアイテムがファイルで、かつファイル名が'.log'で終わるか検証します。
26        $file = $this->current();
27        if ($file instanceof SplFileInfo) {
28            return $file->isFile() && str_ends_with($file->getFilename(), '.log');
29        }
30
31        return false;
32    }
33}
34
35// --- 以下、サンプルコードの実行部分 ---
36
37// テスト用のディレクトリとファイル構造を一時的に作成します。
38$baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_recursive_filter_iterator_example';
39if (is_dir($baseDir)) {
40    // 既存のディレクトリがあればクリーンアップ
41    $rii = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST);
42    foreach ($rii as $file) {
43        $file->isDir() ? rmdir($file) : unlink($file);
44    }
45    rmdir($baseDir);
46}
47mkdir($baseDir . '/logs/2023', 0777, true);
48touch($baseDir . '/app.log');
49touch($baseDir . '/config.ini');
50touch($baseDir . '/logs/access.log');
51touch($baseDir . '/logs/2023/error.log');
52touch($baseDir . '/logs/2023/system.txt');
53
54echo "指定ディレクトリ内の'.log'ファイルを検索します:\n";
55echo "----------------------------------------\n";
56
57try {
58    // 1. ディレクトリを再帰的に走査するイテレータを作成します。
59    $directoryIterator = new RecursiveDirectoryIterator(
60        $baseDir,
61        FilesystemIterator::SKIP_DOTS
62    );
63
64    // 2. カスタムクラス（LogFileValidator）でラップしてフィルタリングを適用します。
65    $logFileFilter = new LogFileValidator($directoryIterator);
66
67    // 3. フィルタリングされた結果をフラットに処理するためのイテレータを作成します。
68    $iterator = new RecursiveIteratorIterator($logFileFilter);
69
70    // foreach ループは内部で valid() を呼び出し、走査できる要素が残っているかを確認します。
71    // valid() が false を返した時点でループは終了します。
72    foreach ($iterator as $fileInfo) {
73        echo $fileInfo->getPathname() . "\n";
74    }
75} finally {
76    // 後片付けとして、作成した一時ディレクトリとファイルを削除します。
77    $rii = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST);
78    foreach ($rii as $file) {
79        $file->isDir() ? rmdir($file) : unlink($file);
80    }
81    rmdir($baseDir);
82}
83?>

RecursiveFilterIteratorクラスのvalid()メソッドは、イテレータ（繰り返し処理を行うためのオブジェクト）が現在指している位置に、処理対象となる有効な要素が存在するかどうかを検証するために使用されます。このメソッドは引数を取りません。戻り値は真偽値（bool型）で、有効な要素があればtrueを、なければ（つまり繰り返しの終端に達していれば）falseを返します。

foreachループなどでイテレータを処理する際、ループを続けるかどうかを判断するために、このvalid()メソッドがPHPによって内部的に自動で呼び出されます。valid()がtrueを返し続ける限りループは継続し、falseを返した時点でループは終了します。

サンプルコードでは、RecursiveFilterIteratorを継承したLogFileValidatorクラスのイテレータをforeachで処理しています。このとき、valid()はディレクトリ内に走査すべきファイルやディレクトリがまだ残っているかを確認し、すべてのアイテムをチェックし終えた時点でループを正しく停止させる役割を担います。なお、どのファイルを表示するかという具体的な絞り込みのロジックは、valid()ではなくaccept()メソッドに実装されており、役割が分担されています。