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

Copy
1<?php
2
3/**
4 * SplStack::offsetGet メソッドのサンプルコード
5 *
6 * SplStack はスタック（LIFO: Last In, First Out）データ構造を実装するクラスです。
7 * ArrayAccess インターフェースを実装しているため、配列のようにオフセット（インデックス）
8 * を使って要素にアクセス（取得・設定）することができます。
9 *
10 * offsetGet メソッドは、指定されたオフセットにある要素を取得するために使用されます。
11 * これは $stack[index] のような配列アクセス記法の内部で呼び出されます。
12 *
13 * キーワード 'php offsetset' に関連して、要素をスタックに「セット」する（追加する）
14 * 方法も示し、その後に offsetGet で取得する例を示します。
15 */
16
17// 1. SplStack オブジェクトを初期化します。
18$stack = new SplStack();
19
20// 2. スタックに要素を「セット」（追加）します。
21//    SplStackの場合、通常は push() メソッドで要素を追加します。
22//    インデックスは0から始まり、一番古い要素（一番下）が0、一番新しい要素（一番上）が count($stack)-1 となります。
23$stack->push('データA'); // インデックス 0
24$stack->push('データB'); // インデックス 1
25$stack->push('データC'); // インデックス 2 (現在のスタックのトップ)
26
27echo "--- SplStackの状態 ---\n";
28echo "スタックの要素数: " . count($stack) . "\n\n";
29
30// 3. offsetGet メソッドを使用して、特定のインデックスの要素を取得します。
31//    引数には、取得したい要素のインデックス（整数）を指定します。
32echo "インデックス 0 の要素: " . $stack->offsetGet(0) . "\n";
33echo "インデックス 1 の要素: " . $stack->offsetGet(1) . "\n";
34echo "インデックス 2 の要素: " . $stack->offsetGet(2) . "\n"; // スタックのトップにある要素
35
36echo "\n";
37
38// 4. 配列アクセス記法での取得も同様に動作します。
39echo "配列アクセス記法でのインデックス 0 の要素: " . $stack[0] . "\n\n";
40
41// 5. 存在しないインデックスにアクセスした場合の例
42//    OutOfBoundsException がスローされます。
43try {
44    echo "存在しないインデックス 10 の要素: " . $stack->offsetGet(10) . "\n";
45} catch (OutOfBoundsException $e) {
46    echo "エラー: " . $e->getMessage() . "\n";
47    echo "ヒント: 存在しないインデックスにアクセスしようとしました。\n";
48}
49
50?>

SplStack::offsetGetメソッドは、スタック（LIFO: 後入れ先出し）データ構造を扱うSplStackクラスで、配列のようにインデックスを指定して要素を取得するために使用されます。SplStackはArrayAccessインターフェースを実装しているため、$stack[インデックス]といった配列アクセス記法を用いることができ、その際に内部的にoffsetGetが呼び出されます。

このメソッドはint $indexを引数に取り、指定されたインデックス位置にある要素の値をmixed型で返します。例えば、push()メソッドで要素をスタックに「セット」（追加）すると、追加された順に0からのインデックスが割り振られます。$stack->push('データA');と追加されたデータAはインデックス0となり、$stack->offsetGet(0)で取得できます。

スタックに存在しないインデックスを指定してアクセスしようとすると、OutOfBoundsExceptionが発生しますので、有効なインデックス範囲内で使用することが重要です。この機能により、スタックの特定の深さにある要素へ簡単にアクセスできます。

Copy
1<?php
2
3// SplStack は LIFO (後入れ先出し) データ構造であるスタックを実装します。
4// offsetGet メソッドは、スタック内の特定のインデックスにある要素を取得するために使用されます。
5// インデックス 0 はスタックの「トップ」（次に pop される要素）を指します。
6
7$stack = new SplStack();
8
9// スタックに要素を追加します (push)。
10// 要素はスタックの底から積まれていきます。
11$stack->push('Apple');  // スタックの一番底
12$stack->push('Banana');
13$stack->push('Cherry'); // スタックのトップに近く
14$stack->push('Date');   // 現在のスタックのトップ (一番上にあり、次に pop される要素)
15
16echo "--- SplStack の offsetGet メソッドの例 ---" . PHP_EOL;
17echo "現在のスタックの要素数: " . count($stack) . PHP_EOL;
18
19// SplStack::offsetGet(int $index) を使用して要素にアクセスします。
20// インデックスはスタックのトップから数えられます。
21echo "\n[offsetGet() を使用したアクセス]:" . PHP_EOL;
22echo "スタック[0] (トップの要素): " . $stack->offsetGet(0) . PHP_EOL; // Date
23echo "スタック[1] (トップから2番目の要素): " . $stack->offsetGet(1) . PHP_EOL; // Cherry
24echo "スタック[2] (トップから3番目の要素): " . $stack->offsetGet(2) . PHP_EOL; // Banana
25echo "スタック[3] (スタックの一番底の要素): " . $stack->offsetGet(3) . PHP_EOL; // Apple
26
27// SplStack は ArrayAccess インターフェースを実装しているため、
28// 配列の角括弧構文 ([]) を使って要素にアクセスすることも可能です。
29echo "\n[配列のような角括弧構文でのアクセス (ArrayAccess)]:" . PHP_EOL;
30echo "スタック[0]: " . $stack[0] . PHP_EOL; // Date
31echo "スタック[1]: " . $stack[1] . PHP_EOL; // Cherry
32
33// 存在しないインデックスにアクセスしようとすると OutOfBoundsException がスローされます。
34try {
35    echo "\n存在しないインデックスにアクセスを試行 (スタック[4]):" . PHP_EOL;
36    echo $stack->offsetGet(4) . PHP_EOL;
37} catch (OutOfBoundsException $e) {
38    echo "エラー: " . $e->getMessage() . PHP_EOL;
39}
40
41// スタックから要素を取り出してみます (pop)。
42// pop すると、スタックのトップの要素が取り除かれ、その下の要素が新しいトップになります。
43echo "\n--- pop 操作後 ---" . PHP_EOL;
44$poppedElement = $stack->pop();
45echo "取り出された要素: " . $poppedElement . PHP_EOL; // Date
46echo "新しいスタックの要素数: " . count($stack) . PHP_EOL;
47echo "新しいスタック[0] (新しいトップ): " . $stack->offsetGet(0) . PHP_EOL; // Cherry
48

PHPのSplStackクラスは、LIFO（Last In, First Out：後入れ先出し）という特性を持つデータ構造「スタック」を扱います。このSplStack::offsetGetメソッドは、スタック内に格納されている特定の要素を、その位置（インデックス）を指定して取得するために使用されます。

引数$indexには、取得したい要素の位置を整数で指定します。SplStackでは、このインデックスはスタックの「トップ」から数えられます。つまり、次にpopされる要素（一番上にある要素）がインデックス0となり、その下の要素がインデックス1、さらにその下がインデックス2となります。戻り値は、指定されたインデックスに存在する要素の値です。

例えば、pushメソッドで要素を追加していくと、最後にpushされた要素がスタックのトップ（インデックス0）に位置します。offsetGet(0)を呼び出すと、このトップの要素が取得できます。スタックに存在しないインデックスを指定してアクセスしようとすると、OutOfBoundsExceptionというエラーが発生しますので注意が必要です。

また、SplStackはArrayAccessインターフェースを実装しているため、$stack->offsetGet(0)のようにメソッドを呼び出す代わりに、$stack[0]といった配列のような角括弧構文でも同様に要素にアクセスすることが可能です。このメソッドは、スタックの内部にあるデータを確認したい場合に便利に利用できます。