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

Copy
1<?php
2
3/**
4 * SplStackは、PHPのSPL (Standard PHP Library) に含まれるデータ構造で、
5 * LIFO (Last-In, First-Out) 原則に基づいたスタックを実装します。
6 *
7 * このサンプルコードは、SplStack::top() メソッドの使用方法を示します。
8 * top() メソッドは、スタックの一番上にある要素を返しますが、その要素をスタックから削除しません。
9 */
10
11// 新しいSplStackインスタンスを作成します。
12$stack = new SplStack();
13
14// スタックに要素を追加します (push操作)。
15// 追加した要素は順にスタックに積まれていきます。
16$stack->push("最初のデータ");
17$stack->push("2番目のデータ");
18$stack->push("一番上のデータ"); // これが現在スタックの一番上にあります
19
20echo "スタックに3つの要素が追加されました。\n";
21
22// SplStack::top() メソッドを使用して、スタックの一番上の要素を取得します。
23// この操作は要素をスタックから削除しません。
24$topElement = $stack->top();
25
26echo "スタックの一番上の要素: " . $topElement . "\n";
27
28// top() メソッドを呼び出した後も、スタックの一番上の要素が削除されていないことを確認します。
29// count() メソッドでスタックの現在の要素数を取得できます。
30echo "top() メソッド呼び出し後のスタックの要素数: " . $stack->count() . "\n";
31
32// この出力から、「一番上のデータ」が取得された後も、スタックにはまだ3つの要素が残っていることがわかります。
33
34?>

PHP 8のSplStackは、SPL（Standard PHP Library）が提供するデータ構造の一つで、LIFO（Last-In, First-Out）原則に基づいたスタックを実装します。このサンプルコードは、SplStackクラスに属するtop()メソッドの利用方法を具体的に示しています。

top()メソッドは、スタックの一番上にある要素を返しますが、その要素をスタックから削除しない点が非常に重要です。このメソッドは引数を必要とせず、スタックにどのような型の要素が格納されていても対応できるよう、戻り値の型はmixedとなります。

サンプルコードでは、まず新しいSplStackインスタンスを作成し、push()メソッドを用いて「最初のデータ」、「2番目のデータ」、「一番上のデータ」という順序で要素を追加しています。これにより、「一番上のデータ」がスタックの最上位に位置することになります。

次に、$stack->top()を呼び出すことで、スタックの一番上にある「一番上のデータ」が取得され、画面に出力されます。その直後、$stack->count()でスタックの要素数を確認すると、top()メソッド呼び出し後も要素数が3のままであることが示されます。この結果から、top()メソッドがスタックの要素を削除せず、最上位の要素を参照するだけの操作であることが明確に理解できます。これにより、スタックの現在の状態を維持しつつ、必要な情報を確認することが可能です。

Copy
1<?php
2
3/**
4 * Demonstrates the use of SplStack::top() in a currency conversion context (PHP to USD).
5 *
6 * This function simulates processing a batch of Philippine Peso (PHP) amounts
7 * for conversion to United States Dollar (USD). It uses SplStack to manage
8 * the amounts and demonstrates peeking at the top element without removing it.
9 *
10 * @return void
11 */
12function processPhpToUsdConversions(): void
13{
14    echo "--- PHP to USD Conversion Batch Processor ---\n\n";
15
16    // Define a dummy exchange rate for demonstration purposes.
17    // In a real application, this would typically be fetched from a reliable API.
18    $phpToUsdRate = 0.017; // Example rate: 1 PHP = 0.017 USD
19
20    echo "Current Exchange Rate (1 PHP = {$phpToUsdRate} USD)\n\n";
21
22    // Create an SplStack to store PHP amounts pending conversion.
23    // SplStack implements a Last-In, First-Out (LIFO) data structure.
24    $pendingPhpAmounts = new SplStack();
25
26    echo "Adding PHP amounts to the processing queue:\n";
27
28    // Push several PHP amounts onto the stack.
29    // The last pushed item will be at the top of the stack.
30    $pendingPhpAmounts->push(1500.00);
31    echo "  Pushed: 1500.00 PHP\n";
32
33    $pendingPhpAmounts->push(2750.50);
34    echo "  Pushed: 2750.50 PHP\n";
35
36    $pendingPhpAmounts->push(999.95);
37    echo "  Pushed: 999.95 PHP\n";
38
39    echo "\n--- Demonstrating SplStack::top() ---\n";
40
41    // Use top() to peek at the most recently added (top) PHP amount
42    // without removing it from the stack.
43    if (!$pendingPhpAmounts->isEmpty()) {
44        $nextAmountToProcess = $pendingPhpAmounts->top();
45        echo "The next PHP amount at the top of the stack (using top()): " . $nextAmountToProcess . " PHP\n";
46        echo "(This amount is still on the stack; it has not been removed.)\n";
47
48        // We can verify the stack size is unchanged after calling top().
49        echo "Current stack size: " . $pendingPhpAmounts->count() . "\n";
50    } else {
51        echo "The stack is empty. Cannot peek at the top element.\n";
52    }
53
54    echo "\n--- Processing (Popping) amounts from the stack ---\n";
55
56    // Now, let's process the amounts by popping them one by one.
57    // The amount returned by pop() will be the same as what top() showed previously.
58    while (!$pendingPhpAmounts->isEmpty()) {
59        $phpAmount = $pendingPhpAmounts->pop(); // Get and remove the top element
60        $usdAmount = $phpAmount * $phpToUsdRate;
61        echo sprintf(
62            "  Converted %.2f PHP to %.2f USD. (Stack size remaining: %d)\n",
63            $phpAmount,
64            $usdAmount,
65            $pendingPhpAmounts->count()
66        );
67    }
68
69    echo "\nAll amounts processed. The stack is now empty.\n";
70}
71
72// Execute the demonstration function.
73processPhpToUsdConversions();

PHP 8のSplStack::top()メソッドは、LIFO（Last-In, First-Out）形式のデータ構造であるSplStackクラスに属し、スタックの「一番上」、つまり最後に格納された要素を取得するためのものです。このメソッドは引数を一切取りません。

最も重要な点は、top()メソッドが要素をスタックから「削除せず」にその値だけを返す点です。これにより、スタックの状態を変更せずに、次に処理されるべき要素を事前に確認できます。戻り値はスタックに格納されている要素の型（mixed）となります。

提供されたサンプルコードでは、フィリピンペソ（PHP）から米ドル（USD）への通貨変換処理をシミュレートしています。複数のPHP金額をSplStackにpushメソッドで追加した後、top()メソッドを使って、次に処理されるべき金額（スタックの最上位にある金額）を削除せずに表示しています。その後、pop()メソッドを使って実際にスタックから金額を取り出し、変換処理を行っており、top()が要素を削除しないことを明確に示しています。これは、実際の処理を行う前にデータを確認したい場合に非常に役立ちます。