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

Copy
1<?php
2
3/**
4 * MultipleIterator::containsIterator メソッドの使用例を示します。
5 * このメソッドは、指定されたイテレータが MultipleIterator インスタンスに
6 * アタッチされているかどうかを確認するために使用されます。
7 *
8 * システムエンジニアを目指す初心者向けに、ArrayIterator を用いて
9 * 配列をイテレータとして扱い、そのイテレータが MultipleIterator に
10 * 含まれているかどうかの判定方法を簡潔に示します。
11 */
12function demonstrateMultipleIteratorContains(): void
13{
14    echo "--- MultipleIterator::containsIterator の使用例 ---\n\n";
15
16    // 1. ArrayIterator を使用して配列をイテレータに変換します。
17    //    これにより、「配列」をイテレータとして扱えるようになります。
18    $arrayData1 = ['apple', 'banana', 'cherry'];
19    $iteratorA = new ArrayIterator($arrayData1);
20
21    $arrayData2 = ['dog', 'elephant', 'fox'];
22    $iteratorB = new ArrayIterator($arrayData2);
23
24    // MultipleIterator にはアタッチしない、別のイテレータ
25    $arrayData3 = ['grape', 'honey', 'ice'];
26    $iteratorC = new ArrayIterator($arrayData3);
27
28    // 2. MultipleIterator のインスタンスを作成します。
29    //    ここでは、特にモードを指定せず、デフォルトの動作とします。
30    $multiIterator = new MultipleIterator();
31    echo "MultipleIterator インスタンスが作成されました。\n";
32
33    // 3. イテレータを MultipleIterator にアタッチ（追加）します。
34    $multiIterator->attachIterator($iteratorA, 'fruits');
35    $multiIterator->attachIterator($iteratorB, 'animals');
36    echo "iteratorA ('fruits') と iteratorB ('animals') がアタッチされました。\n\n";
37
38    // 4. containsIterator メソッドを使用して、イテレータが含まれているか確認します。
39
40    // iteratorA が含まれているか？ (期待値: true)
41    echo "MultipleIterator に iteratorA ('fruits') が含まれているか？: ";
42    var_dump($multiIterator->containsIterator($iteratorA));
43
44    // iteratorB が含まれているか？ (期待値: true)
45    echo "MultipleIterator に iteratorB ('animals') が含まれているか？: ";
46    var_dump($multiIterator->containsIterator($iteratorB));
47
48    // iteratorC が含まれているか？ (アタッチされていないため、期待値: false)
49    echo "MultipleIterator に iteratorC (アタッチされていない) が含まれているか？: ";
50    var_dump($multiIterator->containsIterator($iteratorC));
51
52    echo "\n";
53
54    // 5. アタッチされたイテレータをデタッチ（削除）し、再度確認します。
55    $multiIterator->detachIterator($iteratorA);
56    echo "iteratorA ('fruits') が MultipleIterator からデタッチされました。\n";
57
58    // デタッチされた iteratorA が含まれているか？ (期待値: false)
59    echo "MultipleIterator に iteratorA ('fruits') が含まれているか？ (デタッチ後): ";
60    var_dump($multiIterator->containsIterator($iteratorA));
61}
62
63// サンプル関数を実行
64demonstrateMultipleIteratorContains();

このPHPコードは、MultipleIterator::containsIteratorメソッドの利用方法を初心者向けに解説しています。MultipleIteratorは、複数のイテレータ（配列やコレクションなどのデータ要素を順番に取り出すための仕組み）をまとめて扱えるようにするクラスです。

まず、通常の配列をArrayIteratorを使ってイテレータに変換し、それをMultipleIteratorのインスタンスにattachIteratorメソッドで追加します。この例では$iteratorAと$iteratorBが追加され、$iteratorCは追加されません。

containsIteratorメソッドは、引数として渡されたイテレータが、現在MultipleIteratorインスタンスにアタッチされているかどうかをチェックし、含まれていればtrue、含まれていなければfalseという論理値を戻り値として返します。サンプルコードの実行結果では、アタッチされている$iteratorAと$iteratorBに対してはtrueが、アタッチされていない$iteratorCに対してはfalseが返されることが確認できます。

さらに、detachIteratorメソッドで$iteratorAをMultipleIteratorから削除（デタッチ）した後、再度containsIteratorで確認すると、$iteratorAは含まれていないためfalseが返されることが示されています。このメソッドは、MultipleIteratorが管理しているイテレータの状態をプログラムで確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * MultipleIterator::containsIterator() メソッドの使用例を示します。
5 * このメソッドは、指定されたイテレータが MultipleIterator にアタッチされているかどうかを判定します。
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、各ステップをコメントで解説しています。
7 */
8function demonstrateMultipleIteratorContains(): void
9{
10    echo "MultipleIterator::containsIterator() のデモンストレーションを開始します。\n\n";
11
12    // 1. 複数の ArrayIterator オブジェクトを作成します。
13    // ArrayIterator は、配列をイテレータとして扱うための標準的なPHPクラスです。
14    $dataFruits = ['apple', 'banana', 'cherry'];
15    $dataColors = ['red', 'green', 'blue'];
16    $dataShapes = ['circle', 'square', 'triangle']; // これは MultipleIterator にアタッチしません
17
18    $iteratorFruits = new ArrayIterator($dataFruits);
19    $iteratorColors = new ArrayIterator($dataColors);
20    $iteratorShapes = new ArrayIterator($dataShapes); // アタッチしないイテレータ
21
22    echo "イテレータを3つ作成しました:\n";
23    echo "  - \$iteratorFruits\n";
24    echo "  - \$iteratorColors\n";
25    echo "  - \$iteratorShapes (これは後でアタッチしないことを確認します)\n\n";
26
27    // 2. MultipleIterator オブジェクトを作成します。
28    // MultipleIterator は、複数のイテレータを同時に処理するためのクラスです。
29    // コンストラクタ引数は、イテレーションの振る舞いを設定するものですが、
30    // containsIterator() メソッドの動作には直接影響しません。
31    $mit = new MultipleIterator(MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_ASSOC);
32    echo "MultipleIterator オブジェクトを作成しました。\n\n";
33
34    // 3. 作成したイテレータの一部を MultipleIterator にアタッチ (関連付け) します。
35    $mit->attachIterator($iteratorFruits, 'fruits_key');
36    $mit->attachIterator($iteratorColors, 'colors_key');
37
38    echo "MultipleIterator に \$iteratorFruits と \$iteratorColors をアタッチしました。\n\n";
39
40    // 4. containsIterator() メソッドを使用して、イテレータが含まれているか確認します。
41    echo "--- MultipleIterator::containsIterator() の結果 ---\n";
42
43    // \$iteratorFruits が MultipleIterator に含まれているか確認
44    $isFruitsContained = $mit->containsIterator($iteratorFruits);
45    echo "MultipleIterator は \$iteratorFruits を含んでいますか？ ";
46    echo ($isFruitsContained ? "はい (true)" : "いいえ (false)") . "\n"; // 期待値: はい (true)
47
48    // \$iteratorColors が MultipleIterator に含まれているか確認
49    $isColorsContained = $mit->containsIterator($iteratorColors);
50    echo "MultipleIterator は \$iteratorColors を含んでいますか？ ";
51    echo ($isColorsContained ? "はい (true)" : "いいえ (false)") . "\n"; // 期待値: はい (true)
52
53    // \$iteratorShapes (アタッチしていないもの) が MultipleIterator に含まれているか確認
54    $isShapesContained = $mit->containsIterator($iteratorShapes);
55    echo "MultipleIterator は \$iteratorShapes を含んでいますか？ ";
56    echo ($isShapesContained ? "はい (true)" : "いいえ (false)") . "\n"; // 期待値: いいえ (false)
57
58    // 新しく作成した、MultipleIterator にアタッチされていないイテレータで確認
59    $anotherIterator = new ArrayIterator(['one', 'two']);
60    $isAnotherContained = $mit->containsIterator($anotherIterator);
61    echo "MultipleIterator は新しく作成したイテレータを含んでいますか？ ";
62    echo ($isAnotherContained ? "はい (true)" : "いいえ (false)") . "\n"; // 期待値: いいえ (false)
63
64    echo "\nデモンストレーションが完了しました。\n";
65}
66
67// 上記の関数を実行して、MultipleIterator::containsIterator() の動作を確認します。
68demonstrateMultipleIteratorContains();
69
70?>

PHPのMultipleIterator::containsIterator()メソッドは、複数のイテレータ（データ源を順番に処理するオブジェクト）をまとめて扱うMultipleIteratorインスタンスが、特定のイテレータを現在「含んでいる（アタッチしている）」かどうかを確認するために使用されます。このメソッドは、確認したいIteratorオブジェクトを引数として受け取ります。もし指定されたイテレータがMultipleIteratorに関連付けられていればtrueを、そうでなければfalseをブール値として返します。

提供されたサンプルコードでは、まず複数のArrayIterator（配列をイテレータとして扱うクラス）を作成しています。その後、MultipleIteratorオブジェクトを生成し、作成したイテレータの一部（例えば$iteratorFruitsと$iteratorColors）をattachIterator()メソッドで関連付けます。一方、$iteratorShapesは関連付けられません。

containsIterator()メソッドを用いて確認すると、MultipleIteratorにアタッチされた$iteratorFruitsや$iteratorColorsに対してはtrueが返され、アタッチされていない$iteratorShapesや、新しく作成した別のイテレータに対してはfalseが返されることが確認できます。このように、このメソッドは、複数のデータセットを統合して処理する際に、どのデータが現在取り込まれているかをプログラムで効率的に判定するのに役立ちます。