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

Copy
1<?php
2
3/**
4 * SplQueue::current() メソッドの使用例を示します。
5 * このメソッドは、キューの現在の要素（イテレータが指す要素）を返します。
6 *
7 * システムエンジニアを目指す初心者向けに、キューの基本的な操作と
8 * current() メソッドの役割を簡潔に示します。
9 */
10function demonstrateSplQueueCurrent(): void
11{
12    // 新しい SplQueue オブジェクトを作成します。
13    $queue = new SplQueue();
14
15    // キューに要素を追加します。
16    $queue->enqueue("最初のタスク");
17    $queue->enqueue("二番目のタスク");
18    $queue->enqueue("三番目のタスク");
19
20    echo "--- SplQueue::current() メソッドの動作 ---" . PHP_EOL;
21
22    // SplQueue は Iterator インターフェースを実装しているため、
23    // イテレータのように操作できます。
24    // まず、イテレータのポインタをキューの先頭にリセットします。
25    $queue->rewind();
26    echo "1. rewind() 直後:" . PHP_EOL;
27    if ($queue->valid()) {
28        echo "   現在の要素: " . $queue->current() . PHP_EOL; // 「最初のタスク」が出力される
29    } else {
30        echo "   キューは空か、無効な状態です。" . PHP_EOL;
31    }
32
33    // イテレータのポインタを次の要素に進めます。
34    $queue->next();
35    echo PHP_EOL . "2. next() 呼び出し後:" . PHP_EOL;
36    if ($queue->valid()) {
37        echo "   現在の要素: " . $queue->current() . PHP_EOL; // 「二番目のタスク」が出力される
38    } else {
39        echo "   キューの終端に達したか、無効な状態です。" . PHP_EOL;
40    }
41
42    // さらにポインタを次の要素に進めます。
43    $queue->next();
44    echo PHP_EOL . "3. 2回目の next() 呼び出し後:" . PHP_EOL;
45    if ($queue->valid()) {
46        echo "   現在の要素: " . $queue->current() . PHP_EOL; // 「三番目のタスク」が出力される
47    } else {
48        echo "   キューの終端に達したか、無効な状態です。" . PHP_EOL;
49    }
50
51    // キューから要素を取り出す dequeue() と current() の関係を示します。
52    // dequeue() はキューの先頭から要素を削除します。
53    echo PHP_EOL . "--- dequeue() と current() の関係 ---" . PHP_EOL;
54    if (!$queue->isEmpty()) {
55        $dequeuedItem = $queue->dequeue();
56        echo "4. キューから要素を1つ取り出しました (dequeue): " . $dequeuedItem . PHP_EOL; // 「最初のタスク」が取り出される
57
58        // dequeue() によってキューの先頭要素が削除された後、
59        // イテレータのポインタを再度先頭にリセットして、現在の要素を確認します。
60        // これにより、キューの内容が変更された後の現在の要素がわかります。
61        $queue->rewind();
62        if ($queue->valid()) {
63            echo "   dequeue() 後、rewind() 後の現在の要素: " . $queue->current() . PHP_EOL; // 「二番目のタスク」が出力される
64        } else {
65            echo "   dequeue() 後、キューは空になりました。" . PHP_EOL;
66        }
67    }
68}
69
70// 関数を実行してサンプルコードの動作を確認します。
71demonstrateSplQueueCurrent();

PHPのSplQueue::current()メソッドは、先入れ先出し（FIFO）の仕組みでデータを管理するSplQueueクラスの機能の一つです。SplQueueは、要素を順番に追加したり（enqueue）、先頭から取り出したり（dequeue）できるデータ構造である「キュー」を実現します。

current()メソッドは引数を取らず、イテレータがキュー内で現在指している要素を返します。戻り値はmixed型で、キューに格納されたあらゆる種類のデータに対応しています。このメソッドは、キューの要素を一つずつ順番に処理する際に非常に重要です。

サンプルコードでは、まずSplQueueに複数の要素を追加しています。current()を使用する前に、rewind()メソッドでイテレータのポインタをキューの先頭にリセットします。current()を呼び出すと、その時点での先頭要素が取得できます。次にnext()メソッドを呼び出すことでポインタが次の要素へ移動し、再度current()を呼び出すとその次の要素が取得できます。このように、current()はrewind()やnext()と組み合わせて、キュー内の要素を順次確認・処理する際に活用されます。また、dequeue()でキューの内容が変更された後でも、rewind()とcurrent()を再度使うことで、新しい先頭要素を確認できることも示されています。

Copy
1<?php
2
3/**
4 * SplQueue を使用して、月に関するデータを扱い、そのキューの現在の要素を取得する方法を示すサンプル関数。
5 *
6 * このサンプルは、SplQueue に月の名前を追加し、イテレータとしてキューを走査する際に
7 * 'current()' メソッドがどのように現在の要素（この場合は月の名前）を返すかを示します。
8 * キーワード「php current month」を意識し、キューに「月」のデータを格納し、
9 * その中の「現在の」要素にアクセスする例として提供します。
10 */
11function demonstrateSplQueueCurrentWithMonths(): void
12{
13    // SplQueue のインスタンスを作成
14    $monthQueue = new SplQueue();
15
16    // キューに月に関するデータを追加
17    // ここでは具体的な「現在の月」ではなく、複数の月のデータを格納しています。
18    // SplQueue::current() はイテレータの現在位置の要素を返します。
19    $monthQueue->enqueue("January");
20    $monthQueue->enqueue("February");
21    $monthQueue->enqueue("March");
22    $monthQueue->enqueue("April");
23    $monthQueue->enqueue("May");
24
25    echo "--- SplQueue::current() を用いた月データの走査 ---" . PHP_EOL;
26    echo "キュー内の要素数: " . $monthQueue->count() . PHP_EOL;
27
28    // SplQueue は Iterator インターフェースを実装しているため、
29    // rewind(), valid(), current(), next() メソッドを使って手動で走査できます。
30
31    // 1. イテレータのポインタをキューの先頭にリセット
32    $monthQueue->rewind();
33
34    $position = 1;
35    // 2. ポインタがキュー内の有効な位置を指している間、ループを継続
36    while ($monthQueue->valid()) {
37        // 3. current() メソッドを使用して、イテレータの現在の位置にある要素を取得
38        // この例では、キューに格納された「月の名前」が取得されます。
39        $currentMonthData = $monthQueue->current();
40
41        echo "現在 (" . $position . "番目) の要素: " . $currentMonthData . PHP_EOL;
42
43        // 4. next() メソッドでイテレータのポインタを次の要素に進める
44        $monthQueue->next();
45        $position++;
46    }
47
48    echo "--- キュー内のすべての月データを処理しました ---" . PHP_EOL;
49
50    // 注意: current() メソッドは要素を取得するだけで、キューから要素を削除しません。
51    // 要素をキューから削除するには dequeue() メソッドを使用します。
52}
53
54// 関数を実行し、SplQueue::current() の動作を確認
55demonstrateSplQueueCurrentWithMonths();
56
57?>

PHP 8のSplQueueクラスに属するcurrentメソッドは、キュー内のイテレータが現在指し示している要素を取得するために使用されます。キューは要素を先入れ先出しの原則で管理する特殊なデータ構造であり、このメソッドは引数を必要とせず、キューに格納されているあらゆる種類のデータ（mixed型）を戻り値として返します。

サンプルコードでは、月の名前をSplQueueに追加し、それを順番に処理する例を通じてcurrentメソッドの動作を示しています。まずrewind()メソッドでキューの先頭にイテレータのポインタを戻し、whileループ内でvalid()メソッドを使って有効な要素があるかを確認します。そして、ループ内でcurrent()メソッドを呼び出すことで、その時点でイテレータが指す「現在の月の名前」を取得しています。その後next()メソッドでポインタを次の要素に進め、キュー内のすべての月データを順に処理していきます。

このメソッドは、要素を取得するだけでキューから要素を削除することはありません。そのため、キューの内容を変更せずに、現在位置の要素を参照したい場合に特に役立ちます。