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

Copy
1<?php
2
3/**
4 * SplPriorityQueue::current() メソッドの使用例を示します。
5 *
6 * SplPriorityQueue は、要素とその優先度を管理する特殊なキューです。
7 * 優先度が高い要素が先に取得されますが、current() メソッドでは要素はキューから削除されません。
8 *
9 * current() メソッドは、キューを走査するイテレータが現在指している要素を返します。
10 * このメソッドはイテレータの位置を変更せず、要素をキューから取り出すこともありません。
11 * 通常、rewind() や next() と組み合わせてキューの要素を順に読み取る際に使用します。
12 */
13function demonstrateSplPriorityQueueCurrent(): void
14{
15    // SplPriorityQueue の新しいインスタンスを作成します。
16    $queue = new SplPriorityQueue();
17
18    // キューに要素とそれに対応する優先度を追加します。
19    // insert(データ, 優先度) の形式です。
20    // 優先度が高いほど先に処理されるべき要素と見なされます。
21    $queue->insert('データベースバックアップ', 1); // 最も低い優先度
22    $queue->insert('レポート生成', 2);       // 中程度の優先度
23    $queue->insert('サーバーログ解析', 3);     // 高い優先度
24    $queue->insert('緊急システムアラート', 5); // 最も高い優先度
25
26    echo "--- SplPriorityQueue の要素を優先度順に取得・表示 ---\n";
27
28    // イテレータをキューの先頭（最も優先度の高い要素）に移動させます。
29    // SplPriorityQueue はデフォルトで最も優先度が高い要素が先頭に来るようにソートされます。
30    $queue->rewind();
31
32    // キューが有効な要素を持っている間、ループを続けます。
33    while ($queue->valid()) {
34        // current() メソッドで現在のイテレータが指す要素を取得します。
35        // この操作では要素はキューから削除されず、イテレータの位置も変わりません。
36        $currentElement = $queue->current();
37        echo "現在の処理対象: " . $currentElement . "\n";
38
39        // next() メソッドでイテレータを次の要素（次に優先度が高い要素）に進めます。
40        $queue->next();
41    }
42
43    echo "\n--- current() メソッドは要素をキューから削除しないことを確認 ---\n";
44    echo "上記のループ後も、キューにはまだ全ての要素が残っています。\n";
45
46    // キューの内容がまだ残っていることを確認するため、再度イテレートしてみます。
47    $queue->rewind(); // 再度イテレータを先頭に戻します
48    echo "残存要素:\n";
49    while ($queue->valid()) {
50        echo "- " . $queue->current() . "\n";
51        $queue->next();
52    }
53
54    // 補足: キューから要素を削除する場合は extract() メソッドを使用します。
55    // 例: $removedElement = $queue->extract(); // 最も優先度の高い要素を削除して取得
56}
57
58// サンプル関数を実行します。
59demonstrateSplPriorityQueueCurrent();
60
61?>

SplPriorityQueueは、追加された要素を優先度に基づいて管理する特殊なキューです。このSplPriorityQueueクラスのcurrent()メソッドは、引数を取らず、イテレータが現在指しているキューの要素を返します。戻り値の型はmixedで、キューに格納されたあらゆる型の要素を受け取ることができます。

このメソッドの最も重要な点は、要素をキューから削除したり、イテレータの位置を移動させたりしないことです。キューの要素を順に読み取る際には、まずrewind()メソッドでイテレータをキューの先頭に設定し、次にvalid()メソッドで要素の有無を確認しながらループ処理を行います。ループ内でcurrent()メソッドを用いて現在の要素を取得し、next()メソッドでイテレータを次の要素へと進めます。

サンプルコードでは、まずSplPriorityQueueに異なる優先度を持つ複数のタスクを追加しています。その後、rewind()でイテレータを最も優先度の高い要素に設定し、whileループの中でcurrent()を使って各タスク名を取得・表示します。この際、current()は要素をキューから取り除かないため、ループが終了した後でも、キューにはすべての要素がそのまま残っていることを再度イテレートして確認しています。このように、current()はキューの内容を破壊せずに確認したい場合に非常に役立つメソッドです。

Copy
1<?php
2
3/**
4 * SplPriorityQueue::current の使用例。
5 * イベントログを優先度付きキューに格納し、その内容をイテレートして表示します。
6 * キーワード「php current timestamp」に対応するため、イベントデータにタイムスタンプを含め、
7 * 優先度としてもタイムスタンプを利用します。
8 *
9 * SplPriorityQueue::current() メソッドは、SplPriorityQueue をイテレータとして使用する際に、
10 * イテレータが現在指している要素を返します。foreach ループ内で暗黙的に呼び出されます。
11 */
12function demonstrateSplPriorityQueueCurrent(): void
13{
14    // SplPriorityQueue を初期化します。
15    // デフォルトでは、優先度の高い（値が大きい）要素が先に処理されます。
16    $eventQueue = new SplPriorityQueue();
17
18    // 抽出フラグを設定します。
19    // SplPriorityQueue::EXTR_BOTH を設定することで、
20    // キューから要素を取得する際に、挿入したデータと割り当てた優先度の両方を
21    // 配列（例: ['data' => mixed, 'priority' => mixed]）として取得できます。
22    $eventQueue->setExtractFlags(SplPriorityQueue::EXTR_BOTH);
23
24    // 異なるイベントとタイムスタンプを優先度付きキューに挿入します。
25    // 優先度にはUNIXタイムスタンプを使用し、新しいイベントほど高い優先度を持つようにします。
26    // (大きいタイムスタンプ値ほど優先度が高くなります)
27    $eventQueue->insert(
28        ['message' => 'ユーザーログイン', 'timestamp' => time() - 3600], // 1時間前のイベント
29        time() - 3600 // 優先度として1時間前のタイムスタンプを使用
30    );
31    sleep(1); // タイムスタンプに差をつけるため1秒待機
32    $eventQueue->insert(
33        ['message' => 'ファイルアップロード', 'timestamp' => time() - 1800], // 30分前のイベント
34        time() - 1800 // 優先度として30分前のタイムスタンプを使用
35    );
36    sleep(1); // タイムスタンプに差をつけるため1秒待機
37    $eventQueue->insert(
38        ['message' => 'データベースエラー', 'timestamp' => time()], // 現在のイベント
39        time() // 優先度として現在のタイムスタンプを使用
40    );
41
42    echo "--- 優先度付きキューのイベントログ (優先度の高いものから表示) ---" . PHP_EOL;
43    echo "（新しいタイムスタンプを持つイベントほど高い優先度を持ちます）" . PHP_EOL . PHP_EOL;
44
45    // キューをイテレートします。
46    // この foreach ループの各ステップで、SplPriorityQueue::current() メソッドが暗黙的に呼び出され、
47    // イテレータが現在指している要素（データと優先度の両方）が $eventInfo 変数に代入されます。
48    foreach ($eventQueue as $eventInfo) {
49        $eventData = $eventInfo['data'];       // キューに挿入したイベントデータ（連想配列）
50        $eventPriority = $eventInfo['priority']; // そのイベントに割り当てられた優先度（タイムスタンプ）
51
52        echo "イベントメッセージ: " . $eventData['message'] . PHP_EOL;
53        echo "発生時刻 (UNIXタイムスタンプ): " . $eventData['timestamp'] . " (" . date('Y-m-d H:i:s', $eventData['timestamp']) . ")" . PHP_EOL;
54        echo "キュー優先度 (UNIXタイムスタンプ): " . $eventPriority . PHP_EOL;
55        echo "-----------------------------------" . PHP_EOL;
56    }
57}
58
59// 上記の関数を実行し、デモンストレーションを開始します。
60demonstrateSplPriorityQueueCurrent();

PHPのSplPriorityQueue::current()メソッドは、優先度付きキューの現在位置にある要素を取得するために使用されます。このメソッドは引数を必要とせず、現在指している要素をmixed型で返します。特にSplPriorityQueue::setExtractFlags(SplPriorityQueue::EXTR_BOTH)を設定すると、挿入したデータと、そのデータに割り当てた優先度の両方が配列として取得できるようになります。

サンプルコードでは、イベントログを優先度付きキューに格納し、優先度の高いものから順に表示する例を示しています。キーワード「php current timestamp」に対応するため、イベントの発生時刻（UNIXタイムスタンプ）をデータの値としてだけでなく、優先度としても利用しています。これにより、新しいイベントほど優先度が高くなるようにキューが管理されます。

foreachループでSplPriorityQueueをイテレートする際、内部でcurrent()メソッドが暗黙的に呼び出されます。これにより、ループの各段階で最も優先度の高いイベントのデータと、その優先度（ここではタイムスタンプ）の両方を効率的に取得し、表示しています。このように、重要なイベントから順に処理を行う必要があるシステムで、この機能は非常に役立ちます。