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

Copy
1<?php
2
3/**
4 * SplStack::bottom() メソッドの使用例を示します。
5 * このメソッドは、SplStack（LIFOコレクション）の最下部にある要素を返します。
6 * スタックに追加された最初の要素が最下部の要素になります。
7 */
8function demonstrateSplStackBottom(): void
9{
10    // 新しいSplStackインスタンスを作成します。
11    $stack = new SplStack();
12
13    // スタックに複数の要素をプッシュします。
14    // 'Apple'が最初に追加された要素であり、これがスタックの最下部になります。
15    $stack->push('Apple');
16    $stack->push('Banana');
17    $stack->push(123); // 異なる型の要素も追加可能です（bottom()の戻り値は mixed 型）。
18    $stack->push('Cherry');
19
20    echo "スタックの現在の要素 (最下部から最上部へ): Apple, Banana, 123, Cherry\n";
21
22    // SplStack::bottom() メソッドを呼び出し、スタックの最下部の要素を取得します。
23    $bottomElement = $stack->bottom();
24
25    echo "スタックの最下部の要素 (SplStack::bottom()): ";
26    var_dump($bottomElement); // 結果: string(5) "Apple"
27
28    // 参考: SplStack::top() メソッドは、スタックの最上部の要素（最後に追加された要素）を返します。
29    $topElement = $stack->top();
30    echo "スタックの最上部の要素 (SplStack::top()): ";
31    var_dump($topElement); // 結果: string(6) "Cherry"
32}
33
34// デモンストレーション関数を実行します。
35demonstrateSplStackBottom();

PHPのSplStack::bottom()メソッドは、LIFO（Last In, First Out：最後に入れたものが最初に出る）型のデータ構造であるSplStackの最下部、つまり一番最初に追加された要素を取得するために使用されます。

このメソッドは引数を一切取りません。戻り値はmixed型であり、SplStackに格納されている要素の型に関わらず、その最下部の要素をそのまま返します。たとえば、文字列や数値など、様々な型の要素をスタックに入れていても問題なく取得できます。

サンプルコードでは、新しいSplStackに「Apple」「Banana」「123」「Cherry」の順で要素をプッシュしています。この場合、「Apple」が最初にプッシュされた要素であるため、これがスタックの最下部になります。$stack->bottom()を呼び出すと、期待通り「Apple」という文字列が返されることがvar_dumpの出力から確認できます。

一方、参考として示されているSplStack::top()メソッドは、スタックの最上部、つまり最後に追加された要素（この例では「Cherry」）を返します。bottom()メソッドは、SplStackの特定の時点での最も古い要素にアクセスしたい場合に活用されます。

Copy
1<?php
2
3/**
4 * SplStack::bottom() メソッドの使用例を示します。
5 * このメソッドは、スタックの一番底にある要素（最初に追加された要素）を返します。
6 * 要素はスタックから削除されません。
7 *
8 * SplStack は、PHP の標準データ構造の一部であり、LIFO (Last-In, First-Out) の原則に基づきます。
9 */
10function demonstrateSplStackBottom(): void
11{
12    // SplStack のインスタンスを作成します。
13    $stack = new SplStack();
14
15    echo "--- SplStack::bottom() のデモンストレーション ---\n";
16
17    echo "スタックに要素をプッシュ（追加）します。\n";
18    echo "最初に追加される要素がスタックの「底」になります。\n";
19
20    // 複数の要素をスタックにプッシュします。
21    // 「ログエントリ 1」がスタックの底（最初に追加された要素）になります。
22    $stack->push("ログエントリ 1: アプリケーション初期化");
23    echo "  プッシュ: 'ログエントリ 1'\n";
24
25    $stack->push("ログエントリ 2: データベース接続確立");
26    echo "  プッシュ: 'ログエントリ 2'\n";
27
28    $stack->push("ログエントリ 3: ユーザーセッション開始");
29    echo "  プッシュ: 'ログエントリ 3'\n";
30
31    echo "\n現在のスタック内の要素数: " . $stack->count() . "\n";
32
33    // SplStack::bottom() メソッドを呼び出して、スタックの一番底の要素を取得します。
34    // このメソッドは、スタックに最初に追加された要素を返します。
35    // bottom() は要素をスタックから削除しないため、スタックの内容は変化しません。
36    if (!$stack->isEmpty()) {
37        $bottomElement = $stack->bottom();
38        echo "\nスタックの底にある要素 (最初に追加されたもの): " . $bottomElement . "\n";
39    } else {
40        echo "\nスタックは現在空です。\n";
41    }
42
43    echo "\nbottom() 呼び出し後のスタック内の要素数: " . $stack->count() . "\n";
44    echo "(bottom() メソッドは要素を削除しないため、要素数は変わりません。)\n";
45
46    // 空のスタックで bottom() を呼び出した場合の挙動を確認します。
47    echo "\n--- 空のスタックでの bottom() の挙動 ---\n";
48    $emptyStack = new SplStack();
49    echo "空のスタックに対して bottom() を呼び出します。\n";
50    try {
51        $emptyStack->bottom();
52    } catch (RuntimeException $e) {
53        echo "エラーが発生しました: " . $e->getMessage() . "\n";
54        echo "(空のスタックで bottom() を呼び出すと RuntimeException がスローされます。)\n";
55    }
56}
57
58// デモンストレーション関数を実行します。
59demonstrateSplStackBottom();

PHP 8のSplStack::bottom()メソッドは、LIFO（Last-In, First-Out、後入れ先出し）のデータ構造であるスタックの一番底、つまり最初に追加された要素を取得する際に使用します。このメソッドは引数を取らず、スタックの底にある要素をmixed型で返しますが、その要素がスタックから削除されることはありません。

サンプルコードでは、まず複数のログエントリをスタックにプッシュ（追加）しています。このとき、最初に追加された「ログエントリ 1: アプリケーション初期化」がスタックの底になります。bottom()メソッドを呼び出すと、この一番底の要素である「ログエントリ 1」が取得されますが、スタック内の要素数は呼び出し前後で変わらず、要素はスタックに残ったままです。これは、スタックの現在の状態を確認しつつも、要素を保持したい場合に役立ちます。

しかし、スタックが空の状態でbottom()メソッドを呼び出すと、RuntimeExceptionが発生しますので注意が必要です。このため、isEmpty()メソッドなどでスタックが空でないことを確認してからbottom()を呼び出すのが安全な利用方法です。このメソッドは、スタックに蓄積されたデータの中で、最も古い（最初に追加された）情報にアクセスしたい場合などに活用できます。