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

Copy
1<?php
2
3// RecursiveTreeIterator を拡張し、endIteration メソッドの動作を示すカスタムイテレータ
4class CustomTreeIterator extends RecursiveTreeIterator
5{
6    // イテレーションが一度でも行われたかを示すフラグ
7    private bool $hasIterated = false;
8
9    /**
10     * CustomTreeIterator のコンストラクタ
11     *
12     * @param RecursiveIteratorIterator $it 再帰イテレータ
13     */
14    public function __construct(RecursiveIteratorIterator $it)
15    {
16        parent::__construct($it);
17    }
18
19    /**
20     * 現在の要素を返す前に、イテレーションが行われたことを記録します。
21     *
22     * @return mixed 現在の要素
23     */
24    public function current(): mixed
25    {
26        $this->hasIterated = true;
27        return parent::current();
28    }
29
30    /**
31     * イテレーションが終了した時に呼び出されるメソッド。
32     * このメソッドは親クラス (IteratorIterator) のものをオーバーライドしています。
33     * ここでは、キーワード「php endif」に合わせて、代替構文を使って条件分岐の例を示します。
34     *
35     * @return void
36     */
37    protected function endIteration(): void
38    {
39        // イテレーションが実際に実行されたかどうかでメッセージを分岐
40        if ($this->hasIterated) :
41            echo "--- イテレーションが正常に完了しました。---" . PHP_EOL;
42        else :
43            echo "--- イテレーションは実行されませんでした。---" . PHP_EOL;
44        endif;
45    }
46}
47
48// サンプルデータとして、階層構造を持つ配列を準備
49$sampleData = [
50    'file_a.txt',
51    'directory_x' => [
52        'sub_file_x1.txt',
53        'directory_y' => [
54            'final_file.log',
55        ],
56    ],
57    'file_b.txt',
58];
59
60// RecursiveArrayIterator で配列を再帰的にイテレート可能にする
61$recursiveArray = new RecursiveArrayIterator($sampleData);
62// RecursiveIteratorIterator でイテレータをフラット化し、子要素もトラバースできるようにする
63// RecursiveIteratorIterator::SELF_FIRST は、親要素を先に訪問することを指定
64$recursiveIterator = new RecursiveIteratorIterator($recursiveArray, RecursiveIteratorIterator::SELF_FIRST);
65
66// CustomTreeIterator を使用してツリー形式でデータを表示
67$treeIterator = new CustomTreeIterator($recursiveIterator);
68
69echo "ツリー構造のイテレーション開始:" . PHP_EOL;
70
71// foreach ループでツリー構造をイテレートし、各要素を表示
72foreach ($treeIterator as $key => $value) {
73    // getPrefix() メソッドで現在の階層に応じたインデント文字列を取得
74    echo $treeIterator->getPrefix() . $value . PHP_EOL;
75}
76
77echo "--- メインループ終了 ---" . PHP_EOL;
78// foreach ループの終了後に、CustomTreeIterator::endIteration() メソッドが自動的に呼び出されます。
79// その結果のメッセージが、上記の「--- メインループ終了 ---」の後に表示されます。
80

PHP 8のRecursiveTreeIteratorクラスに属するendIterationメソッドは、イテレータの反復処理が終了した際に、自動的に呼び出される特別なメソッドです。このメソッドは引数を受け取らず、戻り値もありません（void）。イテレーションの完了時に特定の処理を実行したい場合に、子クラスでこのメソッドをオーバーライドして利用します。

サンプルコードでは、RecursiveTreeIteratorを継承したCustomTreeIteratorクラスを定義し、endIterationメソッドをオーバーライドしています。これにより、foreachループでのイテレーションが完全に終了した後、自動的にカスタム処理が実行されます。ここでは、イテレーションが実際に一度でも行われたかどうかに応じて異なるメッセージを表示しています。条件分岐には、キーワード「php endif」に示すように、if (...): ... else: ... endif;というPHPの代替構文を使用しており、一般的なif (...) { ... }形式とは異なる書き方を示しています。このメソッドは、イテレーションの最終的な後処理や結果の通知などに役立ちます。

Copy
1<?php
2
3/**
4 * HtmlSafeTreeIterator は RecursiveTreeIterator を拡張し、
5 * ツリー構造のデータを反復処理する際のカスタムロジックを提供します。
6 * RecursiveTreeIterator::endIteration() メソッドをオーバーライドすることで、
7 * 特定のレベルの反復処理が終了した際のカスタム動作を定義します。
8 */
9class HtmlSafeTreeIterator extends RecursiveTreeIterator
10{
11    /**
12     * 現在のイテレーション（反復）レベルの処理が終了したときに呼び出されます。
13     * このメソッドは引数なし、戻り値なしです。
14     *
15     * システムエンジニアを目指す初心者向けには、このメソッドが
16     * 「特定の階層（サブツリー）のデータ処理が完了した」という節目で
17     * 実行される「フック（hook）」であると理解するのが良いでしょう。
18     * 例えば、その階層でのリソースのクリーンアップ、ログの記録、
19     * あるいは集計処理の最終化などに利用できます。
20     *
21     * この例では、`endIteration()` が呼び出されたときに、
22     * 現在の深さ（レベル）を示すメッセージを出力します。
23     * これは、ツリー構造のデータを表示し、同時に「エンティティ化」することで
24     * 安全性を確保する一連の処理の中で、各レベルの完了を追跡するシナリオを想定しています。
25     */
26    public function endIteration(): void
27    {
28        // 現在のノードの深さ（ルートは0）に基づいてインデントを生成
29        $indent = str_repeat('    ', $this->getDepth());
30
31        // 反復が終了したことを示すメッセージを標準出力に表示
32        // このメッセージは、データ処理（表示やエンティティ化を含む）の
33        // 各レベルの終了を示す追跡ログの一部と見なすことができます。
34        echo sprintf("%s--- レベル %d の反復が終了しました。 ---\n", $indent, $this->getDepth());
35
36        // 親クラスの endIteration() にもデフォルトの動作がある場合、
37        // 呼び出すことが推奨されます。PHP 8 の RecursiveTreeIterator の
38        // endIteration は標準実装を持たないため必須ではありませんが、
39        // 一般的なオーバーライドのプラクティスとして残します。
40        parent::endIteration();
41    }
42}
43
44// サンプルデータ: HTML特殊文字やユーザー入力に見立てた文字列を含む配列
45// これらの文字列は、Webページに表示する際に「エンティティ化」（HTMLエスケープ）が必要です。
46$treeData = new RecursiveArrayIterator([
47    'ウェブサイト設定' => [
48        'タイトル' => 'PHP ツリー構造表示デモ',
49        '説明' => 'これは<b>ユーザー</b>からの入力です。 <script>alert("XSS")</script>',
50        '詳細' => [
51            '管理者' => 'admin@example.com',
52            'バージョン' => '1.0.0',
53            'メッセージ' => 'こんにちは & 世界!'
54        ]
55    ],
56    '製品情報' => '安全なテキスト &amp; その他の情報'
57]);
58
59// RecursiveArrayIterator をカスタムの HtmlSafeTreeIterator でラップします。
60// これにより、ツリー構造としてデータを反復処理し、
61// endIteration() のカスタム動作が利用可能になります。
62$treeIterator = new HtmlSafeTreeIterator($treeData);
63
64echo "## PHPツリー構造データ表示とHTMLエンティティ化\n";
65echo "### `RecursiveTreeIterator::endIteration()` の動作例\n";
66echo "以下のツリー構造のデータは、表示時に HTML エンティティ化 (`htmlspecialchars`) されています。\n";
67echo "`endIteration()` メソッドは、各階層の反復処理が完了した際に自動的に呼び出され、その終了を示します。\n\n";
68
69// foreach ループでツリー構造を反復し、各要素を表示します。
70// RecursiveTreeIterator::endIteration() は、このループの実行中に
71// 内部的なイテレータのライフサイクルに基づいて自動的に呼び出されます。
72foreach ($treeIterator as $key => $value) {
73    // 現在のノードの深さに応じたインデントとツリー描画プレフィックスを取得
74    $indent = str_repeat('    ', $treeIterator->getDepth());
75    $prefix = $treeIterator->getPrefix(); // 例: "├── ", "└─ "
76
77    // キーをHTMLエンティティ化してXSS攻撃を防ぎます。
78    $escapedKey = htmlspecialchars((string) $key, ENT_QUOTES, 'UTF-8');
79
80    // 子要素があるかどうかで出力形式を分けます。
81    if ($treeIterator->hasChildren()) {
82        echo sprintf("%s%s%s\n", $indent, $prefix, $escapedKey);
83    } else {
84        // 子要素がない末端ノードの場合、値もHTMLエンティティ化します。
85        // これが「エンティティ化」の具体的な適用例です。
86        $escapedValue = htmlspecialchars((string) $value, ENT_QUOTES, 'UTF-8');
87        echo sprintf("%s%s%s: %s\n", $indent, $prefix, $escapedKey, $escapedValue);
88    }
89}

RecursiveTreeIterator::endIteration() は、PHP 8 のイテレータ拡張機能の一部で、ツリー構造のデータを反復処理するための RecursiveTreeIterator クラスに属するメソッドです。このメソッドは引数を取らず、戻り値もありません。

このメソッドの基本的な役割は、ツリー構造の特定の階層（サブツリー）に対する反復処理が完了したときに自動的に呼び出されることです。システムエンジニアを目指す初心者の方には、「特定の階層のデータ処理が完了した」という節目で実行される「フック」として理解していただくと良いでしょう。

サンプルコードでは、HtmlSafeTreeIterator というクラスで endIteration() メソッドをオーバーライドし、各階層の反復処理が終了するたびに、現在のレベルを示すメッセージを出力するように実装されています。これは、ウェブページに表示するデータをHTMLエンティティ化（特殊文字を安全な形式に変換）しながらツリー表示を行うようなシナリオにおいて、データの表示や加工の一連の処理の中で、各階層の完了を追跡するための手段として機能します。例えば、その階層でのリソースのクリーンアップやログの記録、集計処理の最終化などに利用することが可能です。