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

Copy
1<?php
2
3/**
4 * MyRecursiveIterator クラス
5 * RecursiveIteratorIterator を継承し、イテレーションの開始処理をカスタマイズします。
6 * beginIteration() メソッドをオーバーライドして、イテレーション開始時に特定の処理を実行します。
7 */
8class MyRecursiveIterator extends RecursiveIteratorIterator
9{
10    /**
11     * beginIteration メソッド
12     *
13     * このメソッドは、RecursiveIteratorIterator がイテレーションを開始する直前に
14     * 自動的に一度だけ呼び出されます。
15     * 引数はなく、戻り値もありません。
16     * ここに、イテレーション全体の開始時に必要な初期化処理などを記述できます。
17     */
18    public function beginIteration(): void
19    {
20        echo "--- RecursiveIteratorIterator のイテレーションを開始します ---\n";
21        echo "  (このメッセージは beginIteration() メソッドによって表示されています)\n";
22    }
23
24    // 他にも endIteration, beginChildren, endChildren などのフックメソッドがありますが、
25    // 今回は beginIteration に焦点を当てています。
26}
27
28/**
29 * demonstrateBeginIteration 関数
30 * RecursiveIteratorIterator::beginIteration の動作を示すサンプルコードです。
31 *
32 * 指定されたパスに一時的なディレクトリとファイルを作成し、
33 * MyRecursiveIterator を使用して再帰的に走査します。
34 * この走査の開始時に、MyRecursiveIterator::beginIteration() が自動的に呼び出され、
35 * その内部で定義された処理が実行されることを示します。
36 *
37 * @param string $basePath 一時ディレクトリを作成するベースパス
38 */
39function demonstrateBeginIteration(string $basePath): void
40{
41    $tempDir = $basePath . '/temp_recursive_test';
42
43    // 1. テスト用のダミーファイルとディレクトリを作成
44    echo "テスト用のダミーディレクトリとファイルを作成中...\n";
45    if (!is_dir($tempDir)) {
46        mkdir($tempDir, 0777, true);
47    }
48    file_put_contents($tempDir . '/document.txt', 'これはドキュメントです。');
49    mkdir($tempDir . '/images', 0777);
50    file_put_contents($tempDir . '/images/photo.jpg', '画像ファイル');
51    mkdir($tempDir . '/reports', 0777);
52    file_put_contents($tempDir . '/reports/annual.pdf', '年間レポート');
53    file_put_contents($tempDir . '/reports/monthly.docx', '月間レポート');
54    echo "作成完了: " . realpath($tempDir) . "\n\n";
55
56    try {
57        echo "ディレクトリ構造の走査を開始します。\n";
58
59        // RecursiveDirectoryIterator を使用して、指定されたディレクトリの内容を反復処理します。
60        // FilesystemIterator::SKIP_DOTS は、"." と ".." をスキップするために使用します。
61        $directoryIterator = new RecursiveDirectoryIterator(
62            $tempDir,
63            FilesystemIterator::SKIP_DOTS
64        );
65
66        // MyRecursiveIterator を使用して、RecursiveDirectoryIterator を再帰的に走査します。
67        // MyRecursiveIterator::beginIteration() は、このオブジェクトがイテレーションを開始するときに自動的に呼び出されます。
68        // RecursiveIteratorIterator::LEAVES_ONLY は、ディレクトリ自体ではなく、最終的なファイル（葉ノード）のみを走査対象とします。
69        $recursiveIterator = new MyRecursiveIterator(
70            $directoryIterator,
71            RecursiveIteratorIterator::LEAVES_ONLY
72        );
73
74        // foreach ループでイテレーションを開始すると、MyRecursiveIterator::beginIteration() が呼び出されます。
75        // その後、各ファイルについてループが実行されます。
76        foreach ($recursiveIterator as $fileInfo) {
77            // $fileInfo は SplFileInfo オブジェクトで、ファイルに関する情報を提供します。
78            echo "  ファイルパス: " . $fileInfo->getPathname() . "\n";
79        }
80
81        echo "\n--- イテレーションが終了しました ---\n";
82
83    } catch (Exception $e) {
84        // エラーが発生した場合の処理
85        echo "エラーが発生しました: " . $e->getMessage() . "\n";
86    } finally {
87        // 2. 作成したダミーファイルとディレクトリをクリーンアップ
88        echo "\nテスト用ファイルをクリーンアップ中...\n";
89        if (is_dir($tempDir)) {
90            $it = new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS);
91            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
92            foreach ($files as $file) {
93                if ($file->isDir()) {
94                    rmdir($file->getRealPath());
95                } else {
96                    unlink($file->getRealPath());
97                }
98            }
99            rmdir($tempDir);
100        }
101        echo "クリーンアップ完了。\n";
102    }
103}
104
105// スクリプトを実行して RecursiveIteratorIterator::beginIteration の動作を確認します。
106demonstrateBeginIteration(__DIR__);
107
108?>

PHPのRecursiveIteratorIterator::beginIterationメソッドは、再帰的な繰り返し処理（イテレーション）が開始される直前に、自動的に一度だけ呼び出される特別なフックメソッドです。このメソッドは引数を一切取らず、戻り値もありません。

サンプルコードでは、MyRecursiveIteratorクラスがRecursiveIteratorIteratorを継承し、このbeginIterationメソッドをオーバーライドしています。これにより、ファイルシステムを再帰的に走査するforeachループが始まる際に、オーバーライドされたbeginIteration内の処理が自動的に実行されます。具体的には、サンプルコードでは「--- RecursiveIteratorIterator のイテレーションを開始します ---」というメッセージが表示され、イテレーションの開始を明示的に示しています。

このメソッドを利用することで、再帰的な処理を開始する前の初期化や、処理全体のログ記録など、イテレーション全体を通して一度だけ実行したい共通の準備処理を記述できます。例えば、データベース接続の確立や、特定のカウンタのリセットなどが考えられます。これにより、複雑な再帰処理の開始地点を明確にし、コードの整理と保守性を高めることができます。

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator を継承し、beginIteration メソッドをオーバーライドするカスタムイテレーターの例です。
5 * beginIteration は、イテレーションが開始される直前に一度だけ自動的に呼び出されます。
6 * これにより、イテレーション開始時の初期処理を記述できます。
7 */
8class CustomRecursiveIteratorIterator extends RecursiveIteratorIterator
9{
10    /**
11     * イテレーションが開始される直前に呼び出されるメソッドです。
12     * ここに、イテレーション開始時に一度だけ実行したい処理を記述します。
13     * 引数はなく、戻り値もありません。
14     */
15    public function beginIteration(): void
16    {
17        echo "=== イテレーション開始: 初期処理を実行します ===\n";
18        // 例: イテレーション中に使用するカウンタのリセットや、ログの開始などを記述できます。
19    }
20
21    // 必要に応じて、他の RecursiveIteratorIterator のメソッドもオーバーライドできます。
22    // 例: endIteration(), beginChildren(), endChildren() など。
23}
24
25// ----------------------------------------------------
26// 以下は、上記カスタムイテレーターの使用例です。
27// 一時的なディレクトリ構造を作成し、その内容を再帰的に走査します。
28// ----------------------------------------------------
29
30// イテレーションの対象となる一時ディレクトリを作成します。
31$tempDir = __DIR__ . '/iterator_example_dir';
32$subDir = $tempDir . '/sub_dir';
33
34// ディレクトリが存在しない場合は作成します。
35if (!is_dir($tempDir)) {
36    mkdir($tempDir);
37}
38if (!is_dir($subDir)) {
39    mkdir($subDir);
40}
41
42// 一時ファイルを作成します。
43file_put_contents($tempDir . '/file1.txt', 'This is content of file1.');
44file_put_contents($subDir . '/file2.txt', 'This is content of file2.');
45
46echo "--- イテレーション準備完了 ---\n";
47
48try {
49    // RecursiveDirectoryIterator を使用して、指定されたディレクトリを再帰的に走査する基本イテレーターを作成します。
50    // FilesystemIterator::SKIP_DOTS を指定することで、'.' と '..' ディレクトリをスキップします。
51    $directoryIterator = new RecursiveDirectoryIterator(
52        $tempDir,
53        FilesystemIterator::SKIP_DOTS
54    );
55
56    // 作成したカスタム RecursiveIteratorIterator に基本イテレーターを渡します。
57    // これにより、イテレーション中に CustomRecursiveIteratorIterator クラスのオーバーライドされたメソッドが呼び出されます。
58    $iterator = new CustomRecursiveIteratorIterator($directoryIterator);
59
60    // foreach ループでイテレーションを開始すると、
61    // CustomRecursiveIteratorIterator::beginIteration() が自動的に呼び出されます。
62    foreach ($iterator as $path => $fileInfo) {
63        // 現在の要素のパスと種類を表示します。
64        echo "要素: " . $fileInfo->getPathname();
65        if ($fileInfo->isDir()) {
66            echo " (ディレクトリ)\n";
67        } else {
68            echo " (ファイル)\n";
69        }
70    }
71
72    echo "=== イテレーション完了 ===\n";
73
74} finally {
75    // 後処理: 作成した一時ファイルとディレクトリを削除し、クリーンアップします。
76    // 'finally' ブロックを使うことで、エラーが発生した場合でも確実にクリーンアップが行われます。
77    @unlink($subDir . '/file2.txt'); // '@' はエラーを抑制します (ファイルが存在しない場合など)。
78    @rmdir($subDir);
79    @unlink($tempDir . '/file1.txt');
80    @rmdir($tempDir);
81    echo "--- 一時ファイルをクリーンアップしました ---\n";
82}

PHP 8のRecursiveIteratorIteratorクラスに属するbeginIterationメソッドは、イテレーション（繰り返し処理）が開始される直前に一度だけ、自動的に呼び出されるメソッドです。このメソッドは、イテレーション開始時に一度だけ実行したい初期処理を記述するために使用されます。例えば、イテレーション中に使用するカウンタのリセットや、処理開始のログ出力など、準備段階の処理に適しています。

beginIterationメソッドは引数を一切取らず、また戻り値もありません。特定の値を返すことを目的とせず、初期処理の実行に特化しています。

このメソッドを利用するには、RecursiveIteratorIteratorを継承したカスタムクラスを作成し、その中でbeginIterationメソッドをオーバーライドします。サンプルコードでは、CustomRecursiveIteratorIteratorというクラスがbeginIterationをオーバーライドし、イテレーションが開始される際に「=== イテレーション開始: 初期処理を実行します ===」というメッセージを表示する例を示しています。foreachループを使ってイテレーションを開始すると、このオーバーライドされたbeginIterationが自動的に実行され、その後に各要素の処理が続きます。これにより、ファイルシステムなどの再帰的なデータ構造を処理する際に、適切なタイミングで初期設定を行えます。