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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ParentIterator::valid() の使用例
7 *
8 * このサンプルコードは、ParentIterator::valid() を使って、
9 * イテレータの現在の位置が有効かどうかを検証（validate）する方法を示します。
10 * while ループの継続条件として valid() を使用し、イテレーション（反復処理）が
11 * 終端に達したかどうかを判定します。
12 */
13
14// サンプル用のネストされたデータ構造（多次元配列）
15$productCategories = [
16    'electronics' => [
17        'Smartphone',
18        'Laptop',
19        'Tablet',
20    ],
21    'books' => [
22        'Programming in PHP',
23        'Database Design',
24    ],
25];
26
27// 多次元配列を再帰的に処理できる RecursiveArrayIterator を作成します
28$recursiveIterator = new RecursiveArrayIterator($productCategories);
29
30// ParentIterator は RecursiveIterator をラップし、親要素へのアクセス機能などを提供します
31$iterator = new ParentIterator($recursiveIterator);
32
33// イテレータを最初の位置に移動させます（ループの開始準備）
34$iterator->rewind();
35
36// ParentIterator::valid() が true を返す間だけ、ループ処理を続けます。
37// valid() は、現在のイテレータの位置に有効な要素が存在するかを bool 値で返します。
38// これがループを継続するための「有効性検証」の役割を果たします。
39while ($iterator->valid()) {
40    $parentKey = $iterator->key();
41    echo "カテゴリ '{$parentKey}':" . PHP_EOL;
42
43    // getChildren() で子イテレータ（カテゴリ内のアイテム）を取得して処理します
44    $childrenIterator = $iterator->getChildren();
45    foreach ($childrenIterator as $item) {
46        echo "  - {$item}" . PHP_EOL;
47    }
48
49    // イテレータを次の要素に進めます
50    $iterator->next();
51}
52
53?>

このPHPサンプルコードは、ParentIterator::valid()メソッドの役割を解説するものです。valid()は、イテレータ（データの集合を順番に指し示す仕組み）の現在の位置に、処理すべき有効なデータが存在するかどうかを検証（validate）します。このメソッドは引数を取らず、戻り値として論理値（bool型）を返します。現在の位置にデータが存在すればtrueを、存在しなければ（つまり、データの終端に達していれば）falseを返します。

サンプルコードでは、このvalid()メソッドをwhileループの条件式に利用しています。これにより、「valid()がtrueを返す間」、つまり「まだ処理すべきデータが残っている間」だけループが継続されます。ループ内で一つの要素に対する処理が終わると、next()メソッドで次の要素に進みます。やがて全ての要素を処理し終えると、valid()がfalseを返すため、ループは安全に停止します。このように、valid()は反復処理がデータの終わりに達したことを判定し、ループを正しく制御するために不可欠なメソッドです。

Copy
1<?php
2
3/**
4 * ParentIteratorとvalid()メソッドの使用法を示すサンプルクラスです。
5 *
6 * ParentIteratorは、再帰的なデータ構造（例: ディレクトリ）を走査する際に
7 * 親要素へのアクセスを可能にするイテレータです。
8 *
9 * valid()メソッドは、イテレータの現在の位置に有効な要素が存在するかを判定します。
10 * ループ処理（foreachやwhile）の継続条件として内部的に使われ、
11 * 走査する要素がなくなるとfalseを返してループを終了させます。
12 *
13 * このコードは、サンプルディレクトリを作成し、ParentIteratorを使って走査します。
14 * whileループで明示的にvalid()を呼び出すことで、その動作を解説します。
15 */
16class IteratorValidationExample
17{
18    /**
19     * サンプル用のディレクトリとファイルを準備し、走査とクリーンアップを実行します。
20     */
21    public function run(): void
22    {
23        // 1. サンプル用のディレクトリとファイルを作成
24        $baseDir = 'temp_test_dir';
25        $subDir = $baseDir . DIRECTORY_SEPARATOR . 'subdir';
26        if (!is_dir($subDir)) {
27            mkdir($subDir, 0777, true);
28        }
29        touch($baseDir . DIRECTORY_SEPARATOR . 'file1.txt');
30        touch($subDir . DIRECTORY_SEPARATOR . 'file2.txt');
31
32        echo "ディレクトリ構造をスキャンします:\n";
33
34        try {
35            // 2. ディレクトリを再帰的に走査するためのイテレータを作成
36            $dirIterator = new RecursiveDirectoryIterator(
37                $baseDir,
38                RecursiveDirectoryIterator::SKIP_DOTS
39            );
40            
41            // 3. ParentIteratorでラップし、親要素にアクセスできるようにする
42            $parentIterator = new ParentIterator($dirIterator);
43
44            // 4. 再帰イテレータをフラットに扱うためのイテレータ
45            $iterator = new RecursiveIteratorIterator(
46                $parentIterator,
47                RecursiveIteratorIterator::SELF_FIRST
48            );
49
50            // 5. valid() を使ったループ処理
51            //    - foreachループは内部で同様のチェックを行っています。
52            //    - ループの各反復の開始時に valid() が呼ばれ、
53            //      true を返す間だけループが続きます。
54            while ($iterator->valid()) {
55                // インデントで階層を表現
56                $indent = str_repeat('  ', $iterator->getDepth());
57                echo $indent . $iterator->current()->getFilename() . "\n";
58                
59                // 次の要素へ進む
60                $iterator->next();
61            }
62        } finally {
63            // 6. 作成したディレクトリとファイルをクリーンアップ
64            unlink($subDir . DIRECTORY_SEPARATOR . 'file2.txt');
65            unlink($baseDir . DIRECTORY_SEPARATOR . 'file1.txt');
66            rmdir($subDir);
67            rmdir($baseDir);
68            echo "\nクリーンアップが完了しました。\n";
69        }
70    }
71}
72
73// クラスのインスタンスを作成して実行
74$example = new IteratorValidationExample();
75$example->run();

ParentIteratorクラスのvalid()メソッドは、イテレータが現在指し示している位置に、処理対象となる有効な要素が存在するかどうかを判定するためのものです。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。まだ処理すべき要素が残っている場合はtrueを、全ての要素を処理し終えてこれ以上要素がない場合はfalseを返します。

私たちが普段よく利用するforeachループは、内部でこのvalid()メソッドを自動的に呼び出してループを続けるべきか判断しています。valid()がfalseを返した時点で、foreachループは自動的に終了します。

サンプルコードでは、この一連の動作をより明確に理解するためにwhileループを使用しています。while ($iterator->valid())という条件式は、「イテレータに次の有効な要素が存在する間、ループ処理を継続する」ということを明示的に示しています。コード例では、ディレクトリ内の全てのファイルとサブディレクトリを走査し終えるとvalid()がfalseを返すため、ループが停止し、後続のクリーンアップ処理が実行されます。このように、valid()は繰り返し処理の終了を判定する重要な役割を担っています。