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

Copy
1<?php
2
3/**
4 * SplPriorityQueue::setExtractFlags の使用例
5 *
6 * SplPriorityQueue は、要素とその優先度を管理するキューです。
7 * setExtractFlags メソッドは、キューから要素を取り出す際に、
8 * 何を抽出するか（データのみ、優先度のみ、両方）を設定します。
9 */
10
11// 1. SplPriorityQueue オブジェクトの作成
12$queue = new SplPriorityQueue();
13
14// 2. 優先度付きでデータをキューに追加
15// insert(データ, 優先度)
16$queue->insert('Task A', 3); // 優先度 高
17$queue->insert('Task B', 1); // 優先度 低
18$queue->insert('Task C', 2); // 優先度 中
19
20echo "--- デフォルトの抽出モード (データのみ) ---\n";
21// デフォルトでは SplPriorityQueue::EXTR_DATA が設定されています。
22// top() メソッドは、キューの先頭要素を Peek します（キューからは削除しない）。
23echo "現在のトップ要素: " . $queue->top() . "\n\n";
24
25echo "--- 抽出フラグを優先度のみに設定 (SplPriorityQueue::EXTR_PRIORITY) ---\n";
26// setExtractFlags で抽出フラグを設定します。
27$queue->setExtractFlags(SplPriorityQueue::EXTR_PRIORITY);
28echo "現在のトップ要素 (優先度): " . $queue->top() . "\n\n";
29
30echo "--- 抽出フラグをデータと優先度の両方に設定 (SplPriorityQueue::EXTR_BOTH) ---\n";
31$queue->setExtractFlags(SplPriorityQueue::EXTR_BOTH);
32$both_extracted = $queue->top(); // 配列としてデータと優先度を取得
33echo "現在のトップ要素 (データと優先度): \n";
34echo "  データ: " . $both_extracted['data'] . "\n";
35echo "  優先度: " . $both_extracted['priority'] . "\n\n";
36
37// キューから要素を取り出しながら、設定したフラグの影響を確認する
38echo "--- キューから要素を取り出す際の挙動の確認 (EXTR_BOTH のまま) ---\n";
39// extract() メソッドは、キューの先頭要素を取り出し（削除し）、その値を返します。
40while (!$queue->isEmpty()) {
41    $item = $queue->extract(); // EXTR_BOTH が設定されているため、配列として取得
42    echo "取り出した要素:\n";
43    echo "  データ: " . $item['data'] . "\n";
44    echo "  優先度: " . $item['priority'] . "\n";
45}
46
47echo "\n--- 抽出フラグをデータのみに戻して、再度データ追加と確認 ---\n";
48$queue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
49$queue->insert('New Task X', 10);
50$queue->insert('New Task Y', 5);
51
52echo "現在のトップ要素 (データのみ): " . $queue->top() . "\n";

このサンプルコードは、PHPのSplPriorityQueueクラスに属するsetExtractFlagsメソッドの使い方を解説しています。SplPriorityQueueは、各要素に設定された優先度に基づいて管理されるキューです。setExtractFlagsメソッドは、このキューから要素を取り出す際に、どのような情報を取り出すかを設定するために利用されます。

引数$flagsには整数値を指定し、SplPriorityQueueクラスが提供する定数を使用します。具体的には、SplPriorityQueue::EXTR_DATAを設定するとデータ本体のみが抽出され（これはデフォルトの動作です）、SplPriorityQueue::EXTR_PRIORITYを設定すると優先度のみが抽出されます。そして、SplPriorityQueue::EXTR_BOTHを指定すると、データと優先度の両方が連想配列として抽出されます。このメソッド自体は値を返しません。

コードでは、まずキューに優先度付きでデータを追加しています。デフォルトの抽出モードでは、top()メソッドがデータのみを返します。その後、setExtractFlagsを用いて抽出モードを優先度のみや、データと優先度の両方へ切り替えることで、top()やextract()メソッドの戻り値がどのように変化するかを確認できます。これにより、キューから必要な情報形式で要素を取得できるようになります。

Copy
1<?php
2
3/**
4 * SplPriorityQueue::setExtractFlags メソッドのサンプルコード
5 *
6 * この関数は、SplPriorityQueue から要素を抽出 (extract) する際に
7 * 何の情報を返すかを制御するために使用されます。
8 */
9function demonstrateSplPriorityQueueExtractFlags(): void
10{
11    // 優先度キューのインスタンスを作成します
12    $queue = new SplPriorityQueue();
13
14    // キューに要素を追加します (データ, 優先度)
15    // 優先度が高い (数値が大きい) 要素ほど先に取り出されます
16    $queue->insert('書類A', 3);
17    $queue->insert('書類B', 1);
18    $queue->insert('書類C', 2);
19    $queue->insert('書類D', 4);
20
21    echo "--- デフォルトの抽出フラグ (SplPriorityQueue::EXTR_DATA) ---\n";
22    // デフォルトでは、setExtractFlags を呼び出さない限り EXTR_DATA が設定されており、
23    // extract() メソッドは要素の「データ」のみを返します。
24    // 明示的に設定することも可能です。
25    $queue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
26
27    // キューから要素がなくなるまで抽出を繰り返します
28    // 優先度が高いものから順に取り出されます
29    while (!$queue->isEmpty()) {
30        echo "抽出されたデータ: " . $queue->extract() . "\n"; // 例: 書類D, 書類A, 書類C, 書類B
31    }
32
33    // キューを再度データで満たします (前の抽出で空になったため)
34    $queue->insert('書類A', 3);
35    $queue->insert('書類B', 1);
36    $queue->insert('書類C', 2);
37    $queue->insert('書類D', 4);
38
39    echo "\n--- 優先度のみを抽出 (SplPriorityQueue::EXTR_PRIORITY) ---\n";
40    // setExtractFlags を使って、extract() メソッドが「優先度」のみを返すように設定します
41    $queue->setExtractFlags(SplPriorityQueue::EXTR_PRIORITY);
42
43    while (!$queue->isEmpty()) {
44        echo "抽出された優先度: " . $queue->extract() . "\n"; // 例: 4, 3, 2, 1
45    }
46
47    // キューを再度データで満たします
48    $queue->insert('書類A', 3);
49    $queue->insert('書類B', 1);
50    $queue->insert('書類C', 2);
51    $queue->insert('書類D', 4);
52
53    echo "\n--- データと優先度を両方抽出 (SplPriorityQueue::EXTR_BOTH) ---\n";
54    // setExtractFlags を使って、extract() メソッドが「データと優先度」の両方を返すように設定します
55    // この場合、extract() は連想配列 (['data' => データ, 'priority' => 優先度]) を返します
56    $queue->setExtractFlags(SplPriorityQueue::EXTR_BOTH);
57
58    while (!$queue->isEmpty()) {
59        $extracted = $queue->extract(); // ['data' => '書類D', 'priority' => 4] のような配列が返されます
60        echo "抽出された要素: データ='" . $extracted['data'] . "', 優先度='" . $extracted['priority'] . "'\n";
61    }
62}
63
64// サンプル関数を実行します
65demonstrateSplPriorityQueueExtractFlags();

PHP 8のSplPriorityQueue::setExtractFlagsメソッドは、優先度キューからextract()メソッドで要素を取り出す際に、どのような情報を取得するかを設定する機能を提供します。このメソッドはint $flagsという引数を取り、取り出す情報を制御するための定数を指定します。

指定できる主な定数は3つあります。SplPriorityQueue::EXTR_DATAを設定すると、デフォルトの挙動として要素のデータのみが抽出されます。例えば、サンプルコードでは「書類D」のようにデータ文字列が返されます。次に、SplPriorityQueue::EXTR_PRIORITYを指定すると、要素の優先度のみが抽出されるようになります。この場合、サンプルコードでは「4」のように優先度を示す数値が返されます。そして、SplPriorityQueue::EXTR_BOTHを指定すると、要素のデータと優先度の両方が連想配列として抽出されます。この場合、['data' => '書類D', 'priority' => 4]のような形式で取得できます。

このメソッド自体は設定を適用するだけで、特定の値を直接返すことはありません（戻り値はなし）。これにより、キューから取得する情報の種類を必要に応じて柔軟に切り替えることが可能になります。