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

Copy
1<?php
2
3// SplDoublyLinkedList は、両端から要素の追加・削除が可能なリスト構造です。
4// getIteratorMode() メソッドは、このリストのイテレータ（要素を順に辿るための仕組み）が
5// 現在どのような動作モードで設定されているかを取得するために使用します。
6
7// SplDoublyLinkedList のインスタンスを作成します。
8$list = new SplDoublyLinkedList();
9
10// リストにいくつかの要素を追加します。
11$list->push('要素A'); // リストの末尾に追加
12$list->push('要素B');
13$list->unshift('要素C'); // リストの先頭に追加
14
15echo "--- 初期状態のイテレータモードの確認 --- \n";
16
17// 現在のイテレータモードを取得します。
18// SplDoublyLinkedList のデフォルトのイテレータモードは IT_MODE_FIFO (先入れ先出し) です。
19// この定数の値は 0 です。
20$initialMode = $list->getIteratorMode();
21echo "デフォルトのイテレータモード: " . $initialMode . " (SplDoublyLinkedList::IT_MODE_FIFO の値)\n";
22
23// モードの数値が、どの定数に対応するか確認する例
24if ($initialMode === SplDoublyLinkedList::IT_MODE_FIFO) {
25    echo "-> これは先入れ先出し (FIFO: First-In, First-Out) モードです。\n";
26}
27
28echo "\n--- イテレータモードを変更し、その変更を getIteratorMode() で再確認 --- \n";
29
30// イテレータモードを SplDoublyLinkedList::IT_MODE_LIFO (後入れ先出し) に設定します。
31// この定数の値は 1 です。
32$list->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO);
33
34// モードが正しく変更されたか、getIteratorMode() を使って確認します。
35$changedMode = $list->getIteratorMode();
36echo "変更後のイテレータモード: " . $changedMode . " (SplDoublyLinkedList::IT_MODE_LIFO の値)\n";
37
38// 変更後のモードが意図したモードと一致するか確認します。
39if ($changedMode === SplDoublyLinkedList::IT_MODE_LIFO) {
40    echo "-> イテレータモードが後入れ先出し (LIFO: Last-In, First-Out) に設定されました。\n";
41}
42
43// 参考: その他のイテレータモードの例
44// SplDoublyLinkedList::IT_MODE_DELETE は、イテレータが要素を読み取った際にリストから削除するモードです。
45// $list->setIteratorMode(SplDoublyLinkedList::IT_MODE_DELETE);
46// $modeWithDelete = $list->getIteratorMode();
47// echo "DELETEモード設定後のイテレータモード: " . $modeWithDelete . "\n";
48
49?>

SplDoublyLinkedList::getIteratorMode()は、PHPのSplDoublyLinkedListクラスに属するメソッドです。SplDoublyLinkedListは、要素をリストの両端から追加・削除できるデータ構造で、効率的にデータを管理します。このメソッドは、リスト内の要素を順に処理する「イテレータ」が現在どのような動作モードに設定されているかを取得するために使用されます。

このメソッドは引数を一切取りません。実行すると、現在のイテレータモードを示す整数値が返されます。この整数値は、SplDoublyLinkedList::IT_MODE_FIFO（先入れ先出し）、SplDoublyLinkedList::IT_MODE_LIFO（後入れ先出し）、またはSplDoublyLinkedList::IT_MODE_DELETE（要素読み取り時に削除）といったクラス定数に対応しており、イテレータがどのように要素を辿るかの設定を表します。

サンプルコードでは、まずSplDoublyLinkedListのインスタンスを作成し、要素を追加しています。初期状態では、getIteratorMode()を呼び出すとデフォルトのIT_MODE_FIFO（値は0）が返されることが確認できます。次に、setIteratorMode()メソッドを使ってイテレータモードをIT_MODE_LIFO（値は1）に変更した後、再度getIteratorMode()を呼び出すことで、モードが正しく変更されたことを確認しています。このメソッドを利用することで、リストの処理順序に関する現在の設定をプログラム上で簡単に把握し、必要に応じて制御できます。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList のイテレータモードの動作をデモンストレーションします。
5 * SplDoublyLinkedList は IteratorAggregate インターフェースを実装しており、
6 * 自身を反復処理できるイテレータを提供します。
7 * getIteratorMode() メソッドは、このイテレータの現在の動作モードを返します。
8 */
9function demonstrateSplDoublyLinkedListIteratorMode(): void
10{
11    echo "--- SplDoublyLinkedList イテレータモードのデモンストレーション ---\n\n";
12
13    // SplDoublyLinkedList のインスタンスを作成
14    $list = new SplDoublyLinkedList();
15
16    // リストに要素を追加
17    $list->push('Apple');
18    $list->push('Banana');
19    $list->push('Cherry');
20
21    echo "リストに要素を追加しました: [Apple, Banana, Cherry]\n";
22
23    // 1. 現在のイテレータモードを取得（デフォルトは FIFO | KEEP）
24    // getIteratorMode() は整数値を返します。この値はビットマスクです。
25    $initialMode = $list->getIteratorMode();
26    echo "初期イテレータモード: " . getIteratorModeName($initialMode) . " (数値: " . $initialMode . ")\n";
27
28    echo "\n初期モード (FIFO | KEEP) での反復処理の例:\n";
29    foreach ($list as $item) {
30        echo "- " . $item . "\n";
31    }
32    echo "（FIFOモードでは、最初に追加されたAppleから反復処理されます。）\n";
33
34    // 2. イテレータモードを変更 (LIFO | KEEP)
35    // IT_MODE_LIFO: 後入れ先出し (Last In, First Out)
36    // IT_MODE_KEEP: イテレート中に要素を保持する (削除しない)
37    $newLIFO_KEEP_Mode = SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP;
38    $list->setIteratorMode($newLIFO_KEEP_Mode);
39    echo "\nイテレータモードを LIFO | KEEP に変更しました。\n";
40
41    // 3. 変更後のイテレータモードを取得
42    $changedModeLIFO = $list->getIteratorMode();
43    echo "変更後イテレータモード: " . getIteratorModeName($changedModeLIFO) . " (数値: " . $changedModeLIFO . ")\n";
44
45    echo "\nLIFO | KEEP モードでの反復処理の例:\n";
46    foreach ($list as $item) {
47        echo "- " . $item . "\n";
48    }
49    echo "（LIFOモードでは、最後に追加されたCherryから反復処理されます。）\n";
50
51    // 4. イテレータモードを DELETE に変更してみる
52    // IT_MODE_LIFO: 後入れ先出し (Last In, First Out)
53    // IT_MODE_DELETE: イテレート中に要素を削除する
54    $newLIFO_DELETE_Mode = SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_DELETE;
55    $list->setIteratorMode($newLIFO_DELETE_Mode);
56    echo "\nイテレータモードを LIFO | DELETE に変更しました。\n";
57
58    // 5. 変更後のイテレータモードを取得
59    $changedModeLIFO_DELETE = $list->getIteratorMode();
60    echo "変更後イテレータモード: " . getIteratorModeName($changedModeLIFO_DELETE) . " (数値: " . $changedModeLIFO_DELETE . ")\n";
61
62    echo "\nLIFO | DELETE モードでの反復処理の例 (要素が削除されます!):\n";
63    foreach ($list as $item) {
64        echo "- " . $item . "\n";
65    }
66    echo "（LIFO | DELETE モードでは、要素が反復処理されると同時にリストから削除されます。）\n";
67
68    // リストが空になったことを確認
69    echo "\n反復処理後のリストの要素数: " . $list->count() . "\n";
70
71    echo "\n--- デモンストレーション終了 ---\n";
72}
73
74/**
75 * SplDoublyLinkedList のイテレータモードの数値から対応する名前の文字列を生成するヘルパー関数。
76 * ビットマスクで表現されるモードを初心者にも分かりやすい文字列に変換します。
77 *
78 * @param int $mode getIteratorMode() メソッドが返すイテレータモードの数値
79 * @return string モードの名前 (例: "FIFO | KEEP")
80 */
81function getIteratorModeName(int $mode): string
82{
83    $names = [];
84
85    // アクセス順序のモードを判断: LIFO (2) または FIFO (0, デフォルト)
86    if (($mode & SplDoublyLinkedList::IT_MODE_LIFO) === SplDoublyLinkedList::IT_MODE_LIFO) {
87        $names[] = 'LIFO';
88    } else {
89        $names[] = 'FIFO'; // LIFO が設定されていない場合は FIFO とみなす
90    }
91
92    // 要素保持のモードを判断: DELETE (1) または KEEP (0, デフォルト)
93    if (($mode & SplDoublyLinkedList::IT_MODE_DELETE) === SplDoublyLinkedList::IT_MODE_DELETE) {
94        $names[] = 'DELETE';
95    } else {
96        $names[] = 'KEEP'; // DELETE が設定されていない場合は KEEP とみなす
97    }
98
99    return implode(' | ', $names);
100}
101
102// スクリプトを実行
103demonstrateSplDoublyLinkedListIteratorMode();

PHPのSplDoublyLinkedList::getIteratorModeメソッドは、SplDoublyLinkedListオブジェクトが要素を反復処理（foreachなどで順番に取り出すこと）する際の現在の動作モードを取得するために使用されます。このクラスはIteratorAggregateインターフェースを実装しているため、それ自体を直接foreach文で扱うことができます。

本メソッドは引数をとりません。戻り値としてint型の整数を返します。この整数値は、イテレータが要素をどのような順序で（例えば、最初に追加されたものから順にFIFO、あるいは最後に追加されたものから順にLIFO）、また反復処理中に要素をリスト内に保持するか（KEEP）、それとも削除するか（DELETE）という複数の設定の組み合わせを示しています。

提供されたサンプルコードでは、まずSplDoublyLinkedListのインスタンスを作成し、いくつかの要素を追加します。次に、getIteratorModeメソッドを呼び出して初期のイテレータモード（デフォルトはFIFO | KEEP）を取得し、そのモードでのforeachの動作を確認しています。その後、setIteratorModeメソッドを使用してイテレータモードをLIFO | KEEP、LIFO | DELETEへと変更し、変更後のモードをgetIteratorModeメソッドで再度取得して表示しています。モードが変更されると、foreachによる要素の反復順序や、要素が反復処理後にリストから削除されるかどうかが変わることを示しています。このように、getIteratorModeは現在のイテレータの振る舞いを把握するために役立ちます。