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

Copy
1<?php
2
3/**
4 * SplStack::getIteratorMode() の使用例。
5 * このメソッドは、スタックのイテレータが現在どのモードで動作しているかを取得します。
6 * SplStack は SplDoublyLinkedList を継承しており、そのイテレータモード定数を使用します。
7 */
8
9// SplStack の新しいインスタンスを作成します。
10$stack = new SplStack();
11
12// getIteratorMode() を呼び出して、現在のイテレータモードを取得します。
13// 戻り値は整数値で、イテレータの挙動を示します。
14$currentIteratorMode = $stack->getIteratorMode();
15
16// 取得したイテレータモードの値を表示します。
17echo "現在の SplStack イテレータモード: " . $currentIteratorMode . "\n";
18
19// 参考: SplStack のデフォルトのイテレータモードは LIFO (Last In, First Out) です。
20// これは SplDoublyLinkedList::IT_MODE_LIFO 定数に対応し、その値は 1 です。
21// このモードは、イテレータがスタックの末尾から先頭へ要素を走査し、
22// かつイテレーション中に要素がスタックから削除されないことを意味します。
23
24?>

PHP 8のSplStack::getIteratorMode()メソッドは、スタック（SplStack）に格納された要素を順番に取り扱う「イテレータ」が、現在どのような動作モードで設定されているかを取得するために使用されます。このメソッドは引数を必要とせず、現在のイテレータモードを示す整数値を戻り値として返します。

サンプルコードでは、まずSplStackの新しいインスタンスを作成し、そのgetIteratorMode()メソッドを呼び出しています。これにより、スタックの現在のイテレータモードが数値として取得され、画面に表示されます。

SplStackは、SplDoublyLinkedListという別のクラスの機能を継承しており、そのイテレータモード定数を利用します。SplStackのデフォルトのイテレータモードは「LIFO」（Last In, First Out、最後に入れたものが最初に出てくる）です。このLIFOモードは、SplDoublyLinkedList::IT_MODE_LIFOという定数に対応し、その値は整数で「1」です。

このLIFOモードは、イテレータがスタックに格納された要素を、一番最後に格納されたものから順に（つまり、スタックの末尾から先頭に向かって）走査することを意味します。また、このモードでイテレーション（要素の取り出し操作）を行ったとしても、イテレータが要素を自動的にスタックから削除することはありません。これにより、スタックの内容を安全に確認できます。

Copy
1<?php
2
3// SplStack クラスは SplDoublyLinkedList を継承しており、
4// IteratorAggregate インターフェースを実装しています。
5// これにより、getIterator() メソッドを通じてイテレータを提供し、
6// foreach ループなどでオブジェクトを直接反復処理できます。
7
8// SplStack のインスタンスを作成します。
9$stack = new SplStack();
10
11// スタックに要素を追加します。
12// SplStack は後入れ先出し (LIFO) の原則で動作します。
13$stack->push('最初の要素');
14$stack->push('二番目の要素');
15$stack->push('三番目の要素'); // これがスタックの先頭になります
16
17echo "--- 初期状態 ---\n";
18
19// getIteratorMode() メソッドを使って現在のイテレータモードを取得します。
20// デフォルトでは、SplStack のイテレータは LIFO モードです。
21$currentMode = $stack->getIteratorMode();
22echo "現在のイテレータモード: ";
23
24if ($currentMode === SplDoublyLinkedList::IT_MODE_LIFO) {
25    echo "LIFO (後入れ先出し) - スタックのデフォルトモードです。\n";
26} elseif ($currentMode === SplDoublyLinkedList::IT_MODE_FIFO) {
27    echo "FIFO (先入れ先出し) です。\n";
28} else {
29    echo "不明なモード: " . $currentMode . "\n";
30}
31
32echo "\n--- LIFOモード (デフォルト) での反復処理 ---\n";
33echo "スタックをLIFOモードで反復処理すると、最後に追加された要素から順に取得されます:\n";
34// SplStack は IteratorAggregate を実装しているため、foreach で直接反復可能です。
35// デフォルトのLIFOモードでは、'三番目の要素' -> '二番目の要素' -> '最初の要素' の順になります。
36foreach ($stack as $item) {
37    echo "- " . $item . "\n";
38}
39
40echo "\n--- イテレータモードをFIFOに変更 ---\n";
41
42// setIteratorMode() メソッドを使ってイテレータモードを FIFO (先入れ先出し) に変更します。
43// これはスタックのプッシュ/ポップ操作とは独立した、イテレーションの順序を設定します。
44$stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO);
45
46// 変更後のイテレータモードを再度 getIteratorMode() で取得し表示します。
47$changedMode = $stack->getIteratorMode();
48echo "変更後のイテレータモード: ";
49
50if ($changedMode === SplDoublyLinkedList::IT_MODE_LIFO) {
51    echo "LIFO (後入れ先出し) です。\n";
52} elseif ($changedMode === SplDoublyLinkedList::IT_MODE_FIFO) {
53    echo "FIFO (先入れ先出し) です。\n";
54} else {
55    echo "不明なモード: " . $changedMode . "\n";
56}
57
58echo "\n--- FIFOモードでの反復処理 ---\n";
59echo "スタックをFIFOモードで反復処理すると、最初に追加された要素から順に取得されます:\n";
60// FIFOモードでは、'最初の要素' -> '二番目の要素' -> '三番目の要素' の順になります。
61foreach ($stack as $item) {
62    echo "- " . $item . "\n";
63}
64
65// 注意: SplStack の push/pop メソッド自体は常に LIFO 原則に従います。
66// getIteratorMode() と setIteratorMode() は、あくまで foreach などでスタックを反復処理する際の順序に影響します。
67
68?>

PHPのSplStackクラスは、データ構造の一つである「スタック」（後入れ先出し：LIFO）を効率的に扱うための標準クラスです。このクラスはIteratorAggregateインターフェースを実装しているため、foreachループを使ってスタック内の要素を順番に取り出す（反復処理する）ことができます。

getIteratorMode()メソッドは、このSplStackオブジェクトをforeachなどで反復処理する際に、どのような順序で要素が取り出されるかを示す「イテレータモード」が現在どう設定されているかを確認するために使用されます。このメソッドは引数を必要とせず、現在のイテレータモードを表す整数値（int型）を戻り値として返します。返される値は、SplDoublyLinkedList::IT_MODE_LIFO（後入れ先出し）やSplDoublyLinkedList::IT_MODE_FIFO（先入れ先出し）などの定数に対応しています。

SplStackのデフォルトのイテレータモードはLIFOですが、setIteratorMode()メソッドを使うことでFIFOに変更することも可能です。サンプルコードでは、まずpush()で要素を追加し、getIteratorMode()でデフォルトのLIFOモードを確認しながらforeachで反復処理を行っています。その後、setIteratorMode()でモードをFIFOに変更し、再度getIteratorMode()で変更後のモードを確認し、FIFO順での反復処理を示しています。

注意点として、push()やpop()といったSplStack本来の操作は常にLIFOの原則に従います。getIteratorMode()やsetIteratorMode()は、あくまでforeachなどのイテレーション時の要素の順序にのみ影響を与える機能であることを理解することが重要です。