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

Copy
1<?php
2
3/**
4 * SplStack::isEmpty メソッドの使用例を示します。
5 *
6 * SplStack は、LIFO (Last In, First Out) の原則に従うデータ構造であるスタックを実装するクラスです。
7 * isEmpty メソッドは、スタックが現在空であるかどうかをチェックし、bool 値を返します。
8 *
9 * システムエンジニアを目指す初心者の方向けに、スタックの基本的な操作と
10 * isEmpty メソッドの挙動を理解しやすいように構成されています。
11 */
12function demonstrateSplStackIsEmpty(): void
13{
14    echo "--- SplStack::isEmpty のデモンストレーション ---" . PHP_EOL;
15
16    // 1. 新しい SplStack インスタンスを作成します。最初は空の状態です。
17    $stack = new SplStack();
18    echo "新しいスタックを作成しました。" . PHP_EOL;
19
20    // 2. スタックが空かどうかをチェックします。
21    //    この時点では要素がないため、true が返されるはずです。
22    echo "スタックは空ですか？ (初期状態): ";
23    var_dump($stack->isEmpty()); // true が出力される
24
25    // 3. スタックに要素を追加します。
26    $stack->push("A");
27    $stack->push("B");
28    echo "要素 'A' と 'B' をスタックに追加しました。" . PHP_EOL;
29
30    // 4. 要素を追加した後、再度スタックが空かどうかをチェックします。
31    //    要素があるため、false が返されるはずです。
32    echo "スタックは空ですか？ (要素追加後): ";
33    var_dump($stack->isEmpty()); // false が出力される
34
35    // 5. スタックからすべての要素を取り出します。
36    echo "スタックから要素を取り出します: " . PHP_EOL;
37    while (!$stack->isEmpty()) {
38        $item = $stack->pop();
39        echo "  取り出した要素: " . $item . PHP_EOL;
40    }
41
42    // 6. すべての要素を取り出した後、スタックが空かどうかをチェックします。
43    //    この時点では要素がないため、true が返されるはずです。
44    echo "スタックは空ですか？ (要素取り出し後): ";
45    var_dump($stack->isEmpty()); // true が出力される
46
47    echo "--- デモンストレーション終了 ---" . PHP_EOL;
48}
49
50// 関数の実行
51demonstrateSplStackIsEmpty();
52
53?>

PHP 8で利用できるSplStackは、データが「最後に入れたものが最初に出る（LIFO: Last In, First Out）」という原則に従って要素を管理するデータ構造、スタックを実装するクラスです。このサンプルコードは、SplStackクラスに用意されているisEmptyメソッドの使い方を、システムエンジニアを目指す初心者の方にも分かりやすく解説しています。

SplStack::isEmptyメソッドは、スタックが現在空であるかどうかをチェックするためのものです。このメソッドは引数を一切必要とせず、スタックに一つも要素がない場合はtrueを、一つでも要素が存在する場合はfalseという真偽値を戻り値として返します。

サンプルコードでは、最初に新しく作成したスタックが空であることをisEmptyがtrueで示すことを確認します。次に、スタックに要素「A」と「B」を追加すると、isEmptyはfalseを返すようになります。その後、スタック内のすべての要素を一つずつ取り出すループ処理を実行します。このループはisEmptyがtrueを返すまで、つまりスタックが空になるまで繰り返されます。すべての要素が取り出され、スタックが再び空になった時点でisEmptyを呼び出すと、再びtrueが返されることが確認できます。このように、isEmptyメソッドはスタックの状態を把握し、安全に要素を操作する上で重要な役割を果たします。

Copy
1<?php
2
3// SplStack はPHPの標準ライブラリ（SPL）の一部で、スタック（LIFO: 後入れ先出し）データ構造を実装します。
4// isEmpty メソッドは、スタックが空であるかどうかをチェックします。
5
6/**
7 * SplStack の isEmpty メソッドの使用例を示します。
8 * このメソッドは、スタックが現在何の要素も保持していない場合に true を返します。
9 * スタックには様々な型のデータを格納できますが、ここではキーワードを考慮して文字列を例として使用します。
10 */
11function demonstrateSplStackIsEmpty(): void
12{
13    echo "--- SplStack::isEmpty() の使用例 ---\n";
14
15    // 新しいSplStackインスタンスを作成
16    $stack = new SplStack();
17
18    // スタック作成直後、isEmpty() で空であることを確認
19    echo "スタック作成直後、空ですか？: " . ($stack->isEmpty() ? "はい" : "いいえ") . "\n";
20
21    // スタックに文字列データをプッシュ（追加）
22    echo "文字列 'First Item' をプッシュします。\n";
23    $stack->push('First Item');
24    echo "文字列 'Second Item' をプッシュします。\n";
25    $stack->push('Second Item');
26
27    // データ追加後、isEmpty() でスタックが空ではないことを確認
28    echo "データをプッシュした後、空ですか？: " . ($stack->isEmpty() ? "はい" : "いいえ") . "\n";
29
30    // スタックからデータをポップ（取り出し）
31    // pop() メソッドは、スタックの最上位の要素を取り除き、その値を返します。
32    echo "スタックからデータをポップ: " . $stack->pop() . "\n";
33
34    // 1つポップした後、まだデータが残っているので空ではないことを確認
35    echo "1つポップした後、空ですか？: " . ($stack->isEmpty() ? "はい" : "いいえ") . "\n";
36
37    // 残りのデータもポップ
38    echo "スタックからデータをポップ: " . $stack->pop() . "\n";
39
40    // 全てのデータをポップした後、isEmpty() でスタックが空であることを確認
41    echo "全てのデータをポップした後、空ですか？: " . ($stack->isEmpty() ? "はい" : "いいえ") . "\n";
42
43    // 空のスタックから pop() を実行しようとすると、RuntimeException が発生します。
44    // そのため、pop する前に isEmpty() でスタックが空ではないかチェックすることが良い習慣です。
45    echo "スタックが空なので、ポップを試みる前に確認します。\n";
46    if (!$stack->isEmpty()) {
47        echo "スタックからデータをポップ: " . $stack->pop() . "\n";
48    } else {
49        echo "スタックは空です。これ以上ポップできません。\n";
50    }
51}
52
53// 関数の実行
54demonstrateSplStackIsEmpty();
55

PHP 8のSplStack::isEmpty()メソッドは、スタック（LIFO: 後入れ先出し）というデータ構造が現在何の要素も保持していないかを確認するために使用されます。このメソッドはSplStackクラスに属し、引数を一切必要とせず、スタックが完全に空であればブール値のtrueを、一つでも要素があればfalseを返します。

サンプルコードでは、最初に作成したばかりのSplStackインスタンスに対してisEmpty()を呼び出し、スタックが空であることを確認しています。続いて、複数の文字列データをスタックに「プッシュ」（追加）すると、スタックに要素が存在するため、isEmpty()はfalseを返します。その後、スタックからデータを「ポップ」（取り出し）する操作を繰り返し、全ての要素が取り除かれると、isEmpty()は再びtrueを返します。

このメソッドの主な用途は、空のスタックからさらに要素を取り出そうとした際に発生する可能性があるエラー（RuntimeException）を未然に防ぐことにあります。pop()を実行する前にisEmpty()でスタックが空でないかを確認することは、堅牢なコードを書く上での良い習慣です。サンプルでは文字列データを扱っていますが、SplStackは数値やオブジェクトなど、様々な型のデータを格納できます。