【PHP8.x】SplDoublyLinkedList::IT_MODE_DELETE定数の使い方

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::IT_MODE_DELETE 定数の使い方をデモンストレーションする関数。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * SplDoublyLinkedList のインスタンス作成、要素の追加、
8 * そしてイテレータを使った要素の自動的な削除を簡潔に示します。
9 */
10function demonstrateSplDoublyLinkedListDeleteMode(): void
11{
12    echo "--- SplDoublyLinkedList::IT_MODE_DELETE のデモンストレーション ---\n\n";
13
14    // 1. SplDoublyLinkedList の新しいインスタンスを作成します。 (キーワード: new)
15    $list = new SplDoublyLinkedList();
16
17    // 2. リストにいくつかの要素を追加します。
18    echo "リストに要素を追加中...\n";
19    $list->push('Apple');
20    $list->push('Banana');
21    $list->push('Cherry');
22    $list->push('Date');
23    $list->push('Elderberry');
24    echo "追加後のリストの要素数: " . $list->count() . "\n";
25
26    // 削除モードを設定する前のリストの内容を表示
27    echo "削除モード設定前のリストの内容: [ ";
28    $itemsBeforeDelete = [];
29    foreach ($list as $item) { // ここではまだ削除モードではないので安全にイテレートできます。
30        $itemsBeforeDelete[] = $item;
31    }
32    echo implode(', ', $itemsBeforeDelete) . " ]\n\n";
33
34    // 3. イテレータモードを設定します。
35    // SplDoublyLinkedList::IT_MODE_FIFO: 先入れ先出しの順序で要素にアクセスします。
36    // SplDoublyLinkedList::IT_MODE_DELETE: イテレータが current() を呼び出した要素をリストから削除します。(キーワード: delete)
37    $list->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_DELETE);
38    echo "イテレータモードを IT_MODE_FIFO | IT_MODE_DELETE に設定しました。\n\n";
39
40    echo "--- リストをイテレートし、要素を自動的に削除中 ---\n";
41    // 4. foreach ループを使ってリストをイテレートします。
42    // このモードでは、foreach ループで各要素にアクセス (current() が暗黙的に呼ばれる) するたびに、
43    // その要素はリストから自動的に削除されます。
44    foreach ($list as $key => $value) {
45        echo "イテレートされ、リストから削除された要素: '{$value}' (元のキー: {$key})\n";
46    }
47    echo "イテレーションが完了しました。\n\n";
48
49    // 5. イテレーション後、リストに残った要素を確認します。
50    echo "--- 削除後のリストの状態 ---\n";
51    echo "現在のリストの要素数: " . $list->count() . "\n";
52
53    if ($list->isEmpty()) {
54        echo "リストは空になりました。IT_MODE_DELETE が意図通りに機能しました。\n";
55    } else {
56        // 通常、IT_MODE_DELETE が設定された foreach ループではすべての要素が削除されるため、
57        // このブロックは実行されないはずです。
58        echo "エラー: 予期せぬ要素がリストに残っています。\n";
59        // 念のため、削除モードを解除して残った要素を表示
60        $list->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO);
61        echo "残ったリストの内容: [ ";
62        $remainingItems = [];
63        foreach ($list as $item) {
64            $remainingItems[] = $item;
65        }
66        echo implode(', ', $remainingItems) . " ]\n";
67    }
68
69    echo "\n--- デモンストレーション終了 ---\n";
70}
71
72// 関数を実行してデモンストレーションを開始します。
73demonstrateSplDoublyLinkedListDeleteMode();

PHPのSplDoublyLinkedList::IT_MODE_DELETEは、SplDoublyLinkedListクラスのイテレータの挙動を制御するための定数です。この定数自体は引数を持たず、整数値（int）を戻り値として返します。

この定数を使用する基本的な流れは、まずnew SplDoublyLinkedList()としてリストの新しいインスタンスを作成し、pushメソッドなどで要素を追加します。その後、リストのイテレータモードをsetIteratorMode()メソッドで設定する際に、SplDoublyLinkedList::IT_MODE_DELETE定数を指定します。この定数を他のモード（例えばSplDoublyLinkedList::IT_MODE_FIFOなど）と|演算子で組み合わせることで、リストの要素を先入れ先出しの順序で取得しつつ、特定の動作を付加できます。

特にIT_MODE_DELETEが設定されている場合、リストをforeachループなどでイテレートし、各要素にアクセスするたびに、その要素はリストから自動的に削除されます。これは、イテレータがcurrent()メソッドを呼び出して要素を取得する際に、その要素がリストから取り除かれるためです。サンプルコードでは、イテレーション終了後にリストの要素数がゼロになることで、IT_MODE_DELETEが正常に機能し、すべての要素が削除されたことを確認しています。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList の IT_MODE_DELETE 定数を使って要素を削除するサンプル
5 *
6 * IT_MODE_DELETE は、SplDoublyLinkedList をイテレートする際に、
7 * イテレータが要素を読み取った後に、その要素をリストから自動的に削除するモードです。
8 * これは、リストを走査しながら要素を取り除きたい場合に役立ちます。
9 *
10 * 注意: このモードでリストをイテレートすると、イテレートしたすべての要素がリストから削除されます。
11 * 特定の条件に基づいて要素を削除したい場合は、別途条件判定を実装するか、
12 * このモード以外の方法を検討する必要があります。
13 */
14function demonstrateSplDoublyLinkedListDeleteMode(): void
15{
16    echo "--- SplDoublyLinkedList IT_MODE_DELETE のデモンストレーション ---\n\n";
17
18    // 1. SplDoublyLinkedList のインスタンスを作成
19    $list = new SplDoublyLinkedList();
20
21    // 2. サンプル要素を追加
22    echo "リストに要素を追加します:\n";
23    $list->push('Apple');
24    $list->push('Banana');
25    $list->push('Cherry');
26    $list->push('Date');
27    $list->push('Elderberry');
28    echo "現在のリストの要素数: " . $list->count() . "\n";
29    echo "現在のリストの内容 (追加直後): ";
30    printListContents($list); // ヘルパー関数で内容を表示
31    echo "\n";
32
33    // 3. イテレータモードを設定
34    // SplDoublyLinkedList::IT_MODE_DELETE: イテレータが要素を読み取った後にリストから削除する
35    // SplDoublyLinkedList::IT_MODE_FIFO: 先入れ先出し (最初から最後まで) の順序でイテレート
36    $list->setIteratorMode(
37        SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_DELETE
38    );
39
40    echo "イテレータモードを IT_MODE_DELETE に設定し、リストを走査します。\n";
41    echo "走査された要素はリストから自動的に削除されます。\n";
42    $countProcessed = 0;
43    foreach ($list as $fruit) {
44        echo "イテレート中: '" . $fruit . "' を処理しました (リストから削除されます)。\n";
45        $countProcessed++;
46    }
47    echo "合計 " . $countProcessed . " 個の要素が処理され、リストから削除されました。\n\n";
48
49    // 4. 削除後のリストの状態を確認
50    echo "イテレーション後のリストの要素数: " . $list->count() . "\n";
51    echo "イテレーション後のリストの内容 (削除後): ";
52    printListContents($list); // ヘルパー関数で内容を表示
53    echo "ご覧の通り、すべての要素がリストから削除されました。\n";
54}
55
56/**
57 * SplDoublyLinkedList の内容を、そのイテレータモードを変更せずに安全に表示するヘルパー関数。
58 *
59 * リスト自体のイテレータモードが IT_MODE_DELETE に設定されている場合、
60 * この関数内で foreach を直接使用すると要素が削除されてしまうため、
61 * 一時的にイテレータモードを通常のモードに設定して内容を読み取り、
62 * 表示後に元のモードに戻します。
63 *
64 * @param SplDoublyLinkedList $list 表示するリスト
65 */
66function printListContents(SplDoublyLinkedList $list): void
67{
68    // 現在のイテレータモードを保存
69    $originalMode = $list->getIteratorMode();
70
71    // 通常のイテレータモードに設定して内容を読み取る (要素は削除されない)
72    // IT_MODE_FIFO は一般的な順序でイテレートするために使用
73    $list->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO);
74
75    $items = [];
76    foreach ($list as $item) {
77        $items[] = $item;
78    }
79    echo "[" . implode(', ', $items) . "]\n";
80
81    // 元のイテレータモードに戻す
82    $list->setIteratorMode($originalMode);
83}
84
85// 関数の実行
86demonstrateSplDoublyLinkedListDeleteMode();

PHPのSplDoublyLinkedList::IT_MODE_DELETEは、SplDoublyLinkedListクラスで使用される定数で、整数値を持ちます。この定数は、双方向リンクリストをイテレートする際の挙動を設定するためのモードの一つです。引数はなく、定数の値は整数型です。

具体的には、この定数をSplDoublyLinkedListのsetIteratorMode()メソッドで設定すると、リストをイテレータ（例えばforeachループ）で走査した際に、イテレータが要素を「読み取った直後に」、その要素をリストから自動的に削除するようになります。これは、リストのすべての要素を一度だけ処理し、処理が完了した要素をリストから取り除きたい場合に役立つ機能です。

サンプルコードでは、まず複数の要素をリストに追加しています。次に、イテレータモードをSplDoublyLinkedList::IT_MODE_FIFO（先入れ先出しの順序）とSplDoublyLinkedList::IT_MODE_DELETEを組み合わせて設定し、foreachでリストを走査しています。これにより、ループ内で各要素が処理されるたびに、その要素はリストから削除されます。結果として、イテレーションが完了すると、リスト内のすべての要素が空になります。IT_MODE_DELETEを使用する際は、イテレートした要素がすべて削除されるため、意図しないデータ消失が起こらないよう注意が必要です。