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

Copy
1<?php
2
3/**
4 * テスト用のディレクトリ構造を作成します。
5 *
6 * @param string $baseDir ベースディレクトリのパス
7 */
8function setup_test_directory(string $baseDir): void
9{
10    if (!is_dir($baseDir)) {
11        mkdir($baseDir, 0777, true);
12    }
13    mkdir($baseDir . '/dir1', 0777);
14    mkdir($baseDir . '/dir1/subdirA', 0777);
15    file_put_contents($baseDir . '/file1.txt', 'Content 1');
16    file_put_contents($baseDir . '/dir1/file2.txt', 'Content 2');
17    file_put_contents($baseDir . '/dir1/subdirA/file3.txt', 'Content 3');
18    echo "テストディレクトリを作成しました: " . realpath($baseDir) . PHP_EOL;
19}
20
21/**
22 * テスト用のディレクトリ構造をクリーンアップします。
23 *
24 * @param string $baseDir ベースディレクトリのパス
25 */
26function cleanup_test_directory(string $baseDir): void
27{
28    if (!is_dir($baseDir)) {
29        return;
30    }
31
32    $files = new RecursiveIteratorIterator(
33        new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS),
34        RecursiveIteratorIterator::CHILD_FIRST
35    );
36
37    foreach ($files as $fileinfo) {
38        $path = $fileinfo->getRealPath();
39        if ($fileinfo->isDir()) {
40            rmdir($path);
41        } else {
42            unlink($path);
43        }
44    }
45    rmdir($baseDir);
46    echo "テストディレクトリを削除しました: " . realpath($baseDir) . PHP_EOL;
47}
48
49
50// テスト用のベースディレクトリを設定
51$testBaseDir = __DIR__ . '/test_tree_data';
52
53// テストディレクトリをセットアップ
54setup_test_directory($testBaseDir);
55
56try {
57    // RecursiveDirectoryIterator を作成し、指定されたディレクトリを再帰的に走査します。
58    // SKIP_DOTS は "." と ".." をスキップし、UNIX_PATHS はパスの区切り文字を統一します。
59    $directoryIterator = new RecursiveDirectoryIterator(
60        $testBaseDir,
61        FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS
62    );
63
64    // RecursiveTreeIterator でツリー構造として表示するためのイテレータを作成します。
65    // RecursiveTreeIterator は内部の RecursiveDirectoryIterator をラップし、ツリー形式で出力します。
66    // BYPASS_CURRENT と BYPASS_KEY は、出力がファイルパスのみになり、シンプルにするためのフラグです。
67    $treeIterator = new RecursiveTreeIterator(
68        $directoryIterator,
69        RecursiveTreeIterator::BYPASS_CURRENT | RecursiveTreeIterator::BYPASS_KEY,
70        RecursiveTreeIterator::PREFIX_LEFT | RecursiveTreeIterator::PREFIX_END_HAS_NEXT
71    );
72
73    echo "--- 1回目のイテレーション ---" . PHP_EOL;
74    // 1回目のイテレーション
75    // RecursiveTreeIterator は、ツリー構造を表現するために各要素を整形して返します。
76    foreach ($treeIterator as $item) {
77        echo $item . PHP_EOL;
78    }
79
80    echo PHP_EOL . "--- rewind() を呼び出し、イテレータを先頭に巻き戻します ---" . PHP_EOL;
81    // RecursiveTreeIterator::rewind() メソッドを呼び出し、イテレータを先頭に巻き戻します。
82    // 通常のPHPジェネレータは一度しか消費できませんが、RecursiveTreeIteratorのような
83    // 特定のイテレータは rewind() を呼び出すことで先頭に戻り、複数回イテレートすることが可能です。
84    $treeIterator->rewind();
85
86    echo "--- 2回目のイテレーション ---" . PHP_EOL;
87    // 2回目のイテレーション
88    // rewind() のおかげで、再度最初からツリー構造を走査できます。
89    foreach ($treeIterator as $item) {
90        echo $item . PHP_EOL;
91    }
92
93} catch (Exception $e) {
94    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
95} finally {
96    // テストディレクトリをクリーンアップ
97    cleanup_test_directory($testBaseDir);
98}

RecursiveTreeIterator::rewind()メソッドは、PHPのRecursiveTreeIteratorクラスに属する機能で、イテレータが現在指し示す位置をその最初の要素に巻き戻すために使用されます。

RecursiveTreeIteratorは、ファイルシステムのような階層構造を再帰的に走査し、それをツリー形式で表現するためのイテレータです。一度すべての要素を走査し終えると、通常はそれ以上要素を提供できなくなります。

しかし、このrewind()メソッドを呼び出すことで、イテレータを初期状態に戻し、再度最初の要素から走査を開始できるようになります。これにより、同じイテレータのインスタンスを使って、繰り返しツリー構造を処理することが可能になります。

このメソッドは引数を取りません。また、特定の値を返すことはなく、処理が完了するとvoid（何も返さない）を返します。サンプルコードでは、ディレクトリ構造のツリーを一度表示した後、rewind()を呼び出すことで、再び最初から同じツリー構造を走査して表示できることを示しています。これは、特に複数回データセットを処理する必要がある場合に便利な機能です。

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator::rewind メソッドの使用例を示します。
5 *
6 * このコードは、ネストされた配列をツリー構造として反復処理し、
7 * rewind メソッドがイテレータを最初の位置にリセットする様子をデモンストレーションします。
8 * システムエンジニアを目指す初心者の方にも理解しやすいよう、具体的な出力例と共に説明します。
9 */
10function demonstrateRecursiveTreeIteratorRewind(): void
11{
12    // ツリー構造を模倣したネストされた配列データを作成します。
13    // 例：ファイルシステムのような階層構造
14    $data = [
15        'プロジェクトルート' => [
16            'src' => [
17                'main.php',
18                'utils.php',
19            ],
20            'tests' => [
21                'test_main.php',
22            ],
23            'README.md',
24        ],
25        'config.json',
26    ];
27
28    // RecursiveArrayIterator を使用して、配列をイテレータとして扱えるようにします。
29    $arrayIterator = new RecursiveArrayIterator($data);
30
31    // RecursiveTreeIterator を作成します。
32    // これにより、再帰的なデータをツリー構造として整形してイテレートできます。
33    // BY_KEY: 各行にキーを表示します。
34    // PREFIX_DASHED: 階層を示すプレフィックス（例: "--"）を追加します。
35    $treeIterator = new RecursiveTreeIterator(
36        $arrayIterator,
37        RecursiveTreeIterator::BY_KEY,
38        RecursiveTreeIterator::PREFIX_DASHED
39    );
40
41    echo "--- 最初のイテレーション (途中で停止) ---\n";
42    $counter = 0;
43    // foreach ループでイテレータを順に進めます。
44    foreach ($treeIterator as $key => $value) {
45        // value には RecursiveTreeIterator によって整形された文字列が含まれます。
46        echo $value . "\n";
47        $counter++;
48        if ($counter >= 3) { // 最初の3つの要素を表示したら停止します。
49            echo "(イテレーションを途中で停止しました)\n";
50            break;
51        }
52    }
53
54    echo "\n--- rewind() を呼び出し、イテレータをリセットします ---\n";
55    // rewind() メソッドを呼び出すことで、イテレータを最初の位置にリセットします。
56    // これにより、次のイテレーションは最初から開始されます。
57    $treeIterator->rewind();
58
59    echo "\n--- 2回目のイテレーション (最初から再開) ---\n";
60    $counter = 0;
61    // 再度 foreach ループを実行すると、イテレータがリセットされているため、
62    // 最初の要素から再び処理が開始されます。
63    foreach ($treeIterator as $key => $value) {
64        echo $value . "\n";
65        $counter++;
66        if ($counter >= 3) { // 再び最初の3つの要素を表示したら停止します。
67            echo "(イテレーションを途中で停止しました)\n";
68            break;
69        }
70    }
71    echo "\n--- 2回目のイテレーション完了 ---\n";
72}
73
74// 上で定義したデモンストレーション関数を実行します。
75demonstrateRecursiveTreeIteratorRewind();
76
77?>

RecursiveTreeIterator::rewindメソッドは、PHPのイテレータ機能の一部で、ツリー構造のように階層化されたデータを効率的に処理するために使用されるRecursiveTreeIteratorクラスに属します。このメソッドの主な役割は、イテレータの内部ポインタを最初の位置にリセットすることです。

rewindメソッドは引数を取りません。また、戻り値もありません（void）。

具体的な使用例としては、まずネストされた配列のようなデータをRecursiveTreeIteratorでツリー状に反復処理する場合を考えます。foreachループなどでイテレータを進めていくと、内部的には現在の要素を指すポインタが移動します。もし途中で処理を中断し、後でもう一度、最初から全ての要素を順に処理し直したい場合、rewind()メソッドを呼び出します。これにより、イテレータが初期状態に戻り、再度foreachループなどを実行すると、ツリーのルート要素から処理が再開されるようになります。

このようにrewind()メソッドは、一度開始したイテレーションを初期位置に戻し、再開することを可能にするため、複雑なデータ構造を複数回にわたって、あるいは特定の条件で最初から処理し直す必要がある場合に非常に役立ちます。