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

Copy
1<?php
2
3/**
4 * SplStack の setIteratorMode メソッドの使用例を示します。
5 *
6 * SplStack は LIFO (Last-In, First-Out: 後入れ先出し) のデータ構造ですが、
7 * setIteratorMode を使用することで、イテレータの順序を FIFO (First-In, First-Out: 先入れ先出し)
8 * に変更して要素を処理することができます。
9 * foreach ループは SplStack::getIterator() を暗黙的に呼び出します。
10 */
11function demonstrateSplStackIteratorMode(): void
12{
13    // 新しい SplStack インスタンスを作成
14    $stack = new SplStack();
15
16    // スタックに要素を追加（プッシュ）
17    // 'First' が最初に追加され、'Third' が最後に追加されます
18    $stack->push('First');
19    $stack->push('Second');
20    $stack->push('Third');
21
22    echo "--- LIFO (後入れ先出し) モードでのイテレーション ---\n";
23    // SplStack のデフォルトのイテレータモードは LIFO (後入れ先出し) です。
24    // 明示的に設定することも可能です。
25    $stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO);
26
27    echo "LIFO 順序で要素を処理（最後に追加されたものから最初に出力）:\n";
28    foreach ($stack as $item) {
29        echo "- " . $item . "\n";
30    }
31    // 出力順: Third, Second, First
32
33    echo "\n--- FIFO (先入れ先出し) モードでのイテレーション ---\n";
34    // イテレータモードを FIFO (先入れ先出し) に変更します。
35    // SplStack 自体の構造は LIFO のままですが、イテレータは FIFO 順で要素を提供します。
36    $stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO);
37
38    echo "FIFO 順序で要素を処理（最初に追加されたものから最初に出力）:\n";
39    foreach ($stack as $item) {
40        echo "- " . $item . "\n";
41    }
42    // 出力順: First, Second, Third
43
44    echo "\n--- 再度 LIFO モードに設定した場合 ---\n";
45    // イテレータモードを LIFO に戻します。
46    $stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO);
47
48    echo "LIFO 順序で要素を処理:\n";
49    foreach ($stack as $item) {
50        echo "- " . $item . "\n";
51    }
52    // 出力順: Third, Second, First
53}
54
55// 関数の実行
56demonstrateSplStackIteratorMode();

SplStack::setIteratorModeは、PHPの特殊なデータ構造であるSplStack（スタック）のイテレータが要素を処理する順序を設定するメソッドです。SplStackは通常、LIFO（Last-In, First-Out: 後入れ先出し）という、最後に追加された要素から順に取り出すデータ構造です。しかし、このsetIteratorModeメソッドを使用すると、foreachループなどで要素を順に処理する際のイテレータの順序を、FIFO（First-In, First-Out: 先入れ先出し）に変更できます。

引数$modeには整数の定数を指定し、SplDoublyLinkedList::IT_MODE_LIFOを指定するとLIFO順、SplDoublyLinkedList::IT_MODE_FIFOを指定するとFIFO順でイテレータが要素を提供します。このメソッド自体は戻り値を返しません。

サンプルコードでは、SplStackに「First」「Second」「Third」の順で要素を追加しています。setIteratorModeでIT_MODE_LIFOを設定すると、スタックの性質通り「Third」「Second」「First」の順で出力されます。その後、IT_MODE_FIFOに設定を変更すると、追加した順序と同じ「First」「Second」「Third」の順で出力されることが確認できます。このように、このメソッドはSplStack自体のデータ構造を変更するのではなく、foreachループが暗黙的に呼び出すSplStack::getIterator()が提供する要素の走査順序を制御するために利用されます。

Copy
1<?php
2
3/**
4 * SplStack::setIteratorMode の使用例を示します。
5 *
6 * SplStack はデフォルトで LIFO (Last-In-First-Out) モードで要素をイテレートしますが、
7 * setIteratorMode メソッドを使用することで、FIFO (First-In-First-Out) モードに変更できます。
8 *
9 * @param array<mixed> $elements スタックに追加する要素の配列
10 */
11function demonstrateSplStackIteratorModes(array $elements): void
12{
13    $stack = new SplStack();
14
15    // スタックに要素を追加します
16    echo "--- 要素をスタックに追加 ---\n";
17    foreach ($elements as $element) {
18        $stack->push($element);
19        echo "Push: " . $element . "\n";
20    }
21    echo "\n";
22
23    // デフォルトのLIFO (Last-In-First-Out) モードでイテレートします。
24    // SplStackはSplDoublyLinkedListを継承しており、その定数を使用します。
25    // デフォルトは SplDoublyLinkedList::IT_MODE_LIFO です。
26    echo "--- LIFO (Last-In-First-Out) モードでのイテレーション (デフォルト) ---\n";
27    foreach ($stack as $item) {
28        echo "LIFO Item: " . $item . "\n";
29    }
30    echo "\n";
31
32    // イテレーションモードを FIFO (First-In-First-Out) に変更します。
33    // SplDoublyLinkedList::IT_MODE_FIFO を setIteratorMode に渡します。
34    $stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO);
35    echo "--- FIFO (First-In-First-Out) モードでのイテレーション ---\n";
36    foreach ($stack as $item) {
37        echo "FIFO Item: " . $item . "\n";
38    }
39    echo "\n";
40
41    // setIteratorMode はイテレーションの「順序」を変更するものであり、
42    // スタックから要素を Pop や Shift するわけではありません。
43    // イテレーション後にスタックの要素数は変わりません。
44    echo "スタックの要素数 (モード変更後も同じ): " . $stack->count() . "\n";
45}
46
47// サンプルデータを指定して関数を実行します
48demonstrateSplStackIteratorModes(['Apple', 'Banana', 'Cherry', 'Date']);

PHPのSplStackクラスは、スタックと呼ばれるデータ構造を提供します。スタックは通常、最後に追加された要素が最初に取り出される（LIFO: Last-In-First-Out）という特徴を持っています。SplStack::setIteratorModeメソッドは、このSplStackインスタンスに対して、foreach文などで要素を繰り返し処理（イテレート）する際の取り出し順序を設定するために使用されます。

このメソッドはint $modeという整数型の引数を一つ受け取ります。この$modeには、SplDoublyLinkedListクラスで定義されている定数であるSplDoublyLinkedList::IT_MODE_LIFOまたはSplDoublyLinkedList::IT_MODE_FIFOを指定します。SplDoublyLinkedList::IT_MODE_LIFOは、デフォルトである後入れ先出しの順序で要素をイテレートします。一方、SplDoublyLinkedList::IT_MODE_FIFOを指定すると、先入れ先出し（FIFO: First-In-First-Out）の順序で要素をイテレートするようになります。

setIteratorModeメソッドは戻り値を持ちません（void）。これは、このメソッドがスタックから実際に要素を取り出したり、スタックの内部データを変更したりするのではなく、単にイテレーション（繰り返し処理）の動作モードを切り替えるだけであることを意味します。サンプルコードでは、デフォルトのLIFOモードとsetIteratorModeで変更したFIFOモードでのイテレーション順序の違いを確認できますが、スタック内の要素数自体はモード変更後も変わりません。