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

Copy
1<?php
2
3/**
4 * SplStack の pop メソッドの基本的な使用例を示します。
5 * SplStack はスタック (LIFO: 後入れ先出し) データ構造を実装しており、
6 * pop メソッドはスタックの先頭 (最後に追加された要素) を取り出します。
7 *
8 * このコードは、スタックに要素を追加し、その後 pop メソッドで要素を
9 * 取り出す過程を追うことで、その動作を理解するのに役立ちます。
10 */
11function demonstrateSplStackPop(): void
12{
13    // 新しい SplStack インスタンスを作成します。
14    $stack = new SplStack();
15
16    echo "--- スタックに要素を追加 (push) ---" . PHP_EOL;
17    // スタックに複数の要素を順番に追加します。
18    // 後から追加された要素がスタックの先頭になります。
19    $stack->push("データA"); // 最初に追加された要素 (スタックの底)
20    echo "追加: データA" . PHP_EOL;
21    $stack->push("データB");
22    echo "追加: データB" . PHP_EOL;
23    $stack->push("データC"); // 最後に追加された要素 (スタックの先頭)
24    echo "追加: データC" . PHP_EOL;
25
26    echo PHP_EOL . "現在のスタックサイズ: " . $stack->count() . PHP_EOL;
27
28    echo PHP_EOL . "--- pop メソッドで要素を取り出す (LIFO: 後入れ先出し) ---" . PHP_EOL;
29    // pop メソッドを呼び出すと、スタックの先頭 (最後に追加された要素) が取り出されます。
30    // これが「Last-In, First-Out (後入れ先出し)」の原則です。
31
32    $poppedItem1 = $stack->pop();
33    echo "pop された要素: " . $poppedItem1 . PHP_EOL; // データC が取り出される
34    echo "スタックサイズ: " . $stack->count() . PHP_EOL;
35
36    $poppedItem2 = $stack->pop();
37    echo "pop された要素: " . $poppedItem2 . PHP_EOL; // データB が取り出される
38    echo "スタックサイズ: " . $stack->count() . PHP_EOL;
39
40    $poppedItem3 = $stack->pop();
41    echo "pop された要素: " . $poppedItem3 . PHP_EOL; // データA が取り出される
42    echo "スタックサイズ: " . $stack->count() . PHP_EOL;
43
44    echo PHP_EOL . "--- 空のスタックからの pop 処理 ---" . PHP_EOL;
45    // スタックが空の状態で pop メソッドを呼び出すと、RuntimeException がスローされます。
46    try {
47        $stack->pop();
48        echo "この行は実行されません。" . PHP_EOL; // エラーが発生するため、この行は表示されない
49    } catch (RuntimeException $e) {
50        echo "エラー: スタックは空です。要素を取り出せません (" . $e->getMessage() . ")" . PHP_EOL;
51    }
52}
53
54// 上記の関数を実行して、SplStack::pop の動作を確認します。
55demonstrateSplStackPop();
56

PHP 8のSplStack::popメソッドは、スタックというデータ構造から要素を取り出すために使用されます。スタックは「Last-In, First-Out（後入れ先出し）」の原則に基づいており、最後にスタックに追加された要素が最初に取り出されます。popメソッドは引数を必要とせず、スタックの先頭（最後に投入された要素）を取り出し、その値をmixed型として返します。mixedは、取り出される要素がどんな型の値でもあり得ることを示します。

サンプルコードでは、まずSplStackに「データA」「データB」「データC」の順で要素を追加しています。この時点で、「データC」がスタックの先頭にあります。その後、popメソッドを呼び出すと、最初に「データC」が取り出され、次に「データB」、最後に「データA」が取り出されることが示されており、LIFOの動作原理を明確に確認できます。スタックが空になった状態で再度popメソッドを呼び出そうとすると、RuntimeExceptionというエラーが発生し、要素を取り出せないことが通知されます。これは、pop操作を行う前にスタックが空でないことを確認する必要があることを示しています。

Copy
1<?php
2
3/**
4 * SplStack::pop メソッドのサンプルコード
5 *
6 * SplStack は、PHPの標準ライブラリ (SPL) で提供される、
7 * LIFO (Last-In, First-Out) の原則に基づいたデータ構造「スタック」を実装するクラスです。
8 * スタックに要素を追加するには push() メソッドを、スタックから要素を取り出すには pop() メソッドを使用します。
9 * pop() メソッドは、スタックの先頭（最後にプッシュされた要素）を削除し、その要素を返します。
10 * スタックが空の状態で pop() を呼び出すと、RuntimeException がスローされます。
11 */
12function demonstrateSplStackPop(): void
13{
14    echo "=== SplStack::pop メソッドのデモンストレーション ===\n";
15
16    // 1. SplStack オブジェクトを新しく作成します。
17    $stack = new SplStack();
18    echo "SplStackを初期化しました。\n";
19    echo "現在のスタックの要素数: " . $stack->count() . "\n\n";
20
21    // 2. いくつかの要素をスタックにプッシュ (追加) します。
22    // スタックは異なる型の値を格納できます (mixed)。
23    echo "スタックに要素をプッシュします:\n";
24    $stack->push('最初の要素'); // 最初にプッシュされた要素
25    echo "  - プッシュ: '最初の要素'\n";
26    $stack->push(123);
27    echo "  - プッシュ: 123\n";
28    $stack->push(['a' => 1, 'b' => 2]); // 配列もプッシュ可能
29    echo "  - プッシュ: ['a' => 1, 'b' => 2]\n";
30    $stack->push(true); // 最後にプッシュされた要素
31    echo "  - プッシュ: true\n";
32
33    echo "プッシュ後、現在のスタックの要素数: " . $stack->count() . "\n\n";
34
35    // 3. pop() メソッドを使用してスタックから要素を一つずつ取り出します。
36    // LIFO (Last-In, First-Out) の原則に従い、最後にプッシュされた要素から取り出されます。
37    echo "スタックから要素をポップ (取り出し) します:\n";
38
39    // 最後の要素 (true) が取り出されます
40    if (!$stack->isEmpty()) {
41        $poppedItem1 = $stack->pop();
42        echo "  - ポップされた要素 (1回目): " . var_export($poppedItem1, true) . "\n";
43        echo "    現在のスタックの要素数: " . $stack->count() . "\n";
44    }
45
46    // 次の要素 (['a' => 1, 'b' => 2]) が取り出されます
47    if (!$stack->isEmpty()) {
48        $poppedItem2 = $stack->pop();
49        echo "  - ポップされた要素 (2回目): " . var_export($poppedItem2, true) . "\n";
50        echo "    現在のスタックの要素数: " . $stack->count() . "\n";
51    }
52
53    // スタックが空になるまで全ての要素をポップします。
54    echo "\nスタックが空になるまで残りの要素をポップします:\n";
55    while (!$stack->isEmpty()) {
56        $item = $stack->pop();
57        echo "  - ポップされた要素: " . var_export($item, true) . "\n";
58        echo "    現在のスタックの要素数: " . $stack->count() . "\n";
59    }
60
61    echo "\n全ての要素がポップされ、スタックは現在空です。\n";
62    echo "現在のスタックの要素数: " . $stack->count() . "\n\n";
63
64    // 4. 空のスタックから pop() しようとした場合の挙動をテストします。
65    // この操作は RuntimeException をスローしますので、try-catch ブロックで捕捉します。
66    echo "空のスタックから pop() しようとすると RuntimeException が発生します。\n";
67    try {
68        $stack->pop();
69    } catch (RuntimeException $e) {
70        echo "  - エラーをキャッチしました: " . $e->getMessage() . "\n";
71        echo "    エラーメッセージ: \"Cannot pop from an empty stack\"\n";
72    }
73
74    echo "\n=== デモンストレーション終了 ===\n";
75}
76
77// 関数を実行して SplStack::pop の動作を確認します。
78demonstrateSplStackPop();

SplStack::popメソッドは、PHPの標準ライブラリ（SPL）で提供されるSplStackクラスに属する機能です。SplStackは、LIFO（Last-In, First-Out）の原則に基づく「スタック」というデータ構造を実装しており、要素を追加した順序とは逆の順序で要素を取り出す際に利用されます。

pop()メソッドは、このスタックの最も上にある要素、つまり最後にプッシュ（追加）された要素をスタックから削除し、その削除した要素を戻り値として返します。このメソッドは引数を取りません。戻り値の型はmixedであり、スタックにプッシュされた様々な型の要素（文字列、数値、配列、真偽値など）をそのままの型で受け取ることが可能です。

スタックが空の状態でpop()メソッドを呼び出すと、RuntimeExceptionが発生します。そのため、pop()を実行する前にはisEmpty()メソッドなどでスタックが空でないことを確認することが推奨されます。サンプルコードでは、複数の要素をプッシュした後、pop()を使ってそれらがLIFOの順に取り出される様子や、空のスタックからポップしようとした際にRuntimeExceptionが適切に捕捉される様子が示されています。