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

Copy
1<?php
2
3/**
4 * ストリングから数値を抽出し、SplPriorityQueue を使用して数値の大きい順（高い優先度）にソートして返します。
5 *
6 * @param string $inputString 数値が抽出される入力ストリング。
7 * @return array 抽出された数値の配列。数値の大きい順にソートされています。
8 */
9function extractNumbersByPriorityFromString(string $inputString): array
10{
11    // 新しい SplPriorityQueue インスタンスを初期化します。
12    $priorityQueue = new SplPriorityQueue();
13
14    // 正規表現を使用して、ストリング内のすべての浮動小数点数または整数を検索します。
15    // \b\d+(\.\d+)?\b は、単語の境界で区切られた整数または小数（例: 123, 4.56）にマッチします。
16    if (preg_match_all('/\b\d+(\.\d+)?\b/', $inputString, $matches)) {
17        // $matches[0] には、見つかったすべての数値のストリング表現が含まれます。
18        foreach ($matches[0] as $numberString) {
19            // 見つかったストリングを数値（フロート）に変換します。
20            $number = (float) $numberString;
21            // 数値を優先度キューに挿入します。
22            // ここでは、数値自体を優先度として使用します。これにより、数値が大きいほど優先度が高くなります。
23            $priorityQueue->insert($number, $number);
24        }
25    }
26
27    // キューが空の場合（数値が見つからなかった場合）、空の配列を返します。
28    if ($priorityQueue->isEmpty()) {
29        return [];
30    }
31
32    // キューから要素を抽出する際のフラグを設定します。
33    // SplPriorityQueue::EXTR_DATA は、データのみを抽出し、優先度情報は含めないことを示します。
34    // これがデフォルトの動作ですが、明示的に設定することでコードの意図が明確になります。
35    $priorityQueue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
36
37    $extractedNumbers = [];
38    // キューが空になるまで、要素を1つずつ抽出します。
39    // SplPriorityQueue::extract() は、最も優先度の高い（この場合は数値の最も大きい）要素を削除して返します。
40    while (!$priorityQueue->isEmpty()) {
41        $extractedNumbers[] = $priorityQueue->extract();
42    }
43
44    return $extractedNumbers;
45}
46
47// --- 使用例 ---
48
49$text1 = "料金は $12.99, $5.00, $24.50 です。合計から10%割引されます。";
50$numbers1 = extractNumbersByPriorityFromString($text1);
51echo "テキスト1から抽出された数値（大きい順）: " . implode(", ", $numbers1) . "\n";
52// 期待される出力: 24.5, 12.99, 10, 5
53
54$text2 = "ここには数値がありません！";
55$numbers2 = extractNumbersByPriorityFromString($text2);
56echo "テキスト2から抽出された数値: " . implode(", ", $numbers2) . "\n";
57// 期待される出力: (空のストリング)
58
59$text3 = "単一の数値 42。";
60$numbers3 = extractNumbersByPriorityFromString($text3);
61echo "テキスト3から抽出された数値: " . implode(", ", $numbers3) . "\n";
62// 期待される出力: 42
63
64$text4 = "負の数値は -10.5 と -5 です。0 にも注目してください。";
65$numbers4 = extractNumbersByPriorityFromString($text4);
66echo "テキスト4から抽出された数値: " . implode(", ", $numbers4) . "\n";
67// 期待される出力: 0, -5, -10.5 (数値が大きい順に並びます)

このPHPサンプルコードは、入力された文字列の中から数値を抽出し、それらを大きい順に並べ替えて配列として返す関数を定義しています。この処理の中心となるのは、データを優先度に基づいて管理するSplPriorityQueueクラスです。

関数内では、まず正規表現を用いて入力文字列からすべての数値（整数や小数）を検索します。見つかった数値は、SplPriorityQueue::insert()メソッドを使ってキューに一つずつ挿入されます。この際、数値そのものを「優先度」として設定することで、数値が大きいほど高い優先度を持つようになります。

その後、SplPriorityQueue::setExtractFlags(SplPriorityQueue::EXTR_DATA)を呼び出し、キューから要素を取り出す際にデータ本体のみを取得するよう設定します。そして、キューが空になるまでwhileループを繰り返しながら、$priorityQueue->extract()メソッドを使用します。このextractメソッドは、キュー内で最も優先度の高い（つまり、最も大きい）数値を削除して返します。この処理を繰り返すことで、結果として数値は自動的に大きい順に並べられた配列として収集されます。

引数 $inputString は数値を抽出したい文字列を受け取り、戻り値は抽出され大きい順にソートされた数値の配列となります。

Copy
1<?php
2
3/**
4 * SplPriorityQueueを使用して、優先度付きキューから文字列を「抽出（取り出し）」するサンプルコード。
5 *
6 * このコードは、キーワード「php extract string from string」に対し、
7 * SplPriorityQueueから文字列要素を取り出すことを「抽出」と解釈して関連付けています。
8 * 一般的な文字列操作による部分文字列の抽出とは異なりますが、
9 * SplPriorityQueue::extract()メソッドの基本的な使い方と、
10 * キューに格納された文字列要素を優先度順に取り出す挙動を示します。
11 */
12function demonstrateSplPriorityQueueExtract(): void
13{
14    // SplPriorityQueueのインスタンスを作成
15    $queue = new SplPriorityQueue();
16
17    echo "--- 優先度付きキューに文字列を挿入 ---" . PHP_EOL;
18
19    // 異なる優先度を持つ文字列をキューに挿入します。
20    // insert()メソッドは、第一引数に値、第二引数に優先度を取ります。
21    // 優先度が高い（数値が大きい）ものほど先に取り出されます。
22    $queue->insert("低優先度タスク: データベース接続のクリーンアップ", 10);
23    echo "挿入: 'データベース接続のクリーンアップ' (優先度: 10)" . PHP_EOL;
24
25    $queue->insert("中優先度タスク: ユーザーデータのバッチ処理", 50);
26    echo "挿入: 'ユーザーデータのバッチ処理' (優先度: 50)" . PHP_EOL;
27
28    $queue->insert("最高優先度タスク: 緊急アラートの送信", 100);
29    echo "挿入: '緊急アラートの送信' (優先度: 100)" . PHP_EOL;
30
31    $queue->insert("高優先度タスク: ログファイルの圧縮", 75);
32    echo "挿入: 'ログファイルの圧縮' (優先度: 75)" . PHP_EOL;
33
34    echo PHP_EOL;
35
36    echo "--- キューから優先度順に文字列を抽出（取り出し） ---" . PHP_EOL;
37
38    // extract()メソッドは、最も優先度の高い要素をキューから取り除き、その値を返します。
39    // キューが空になるまでループして、格納された文字列を優先度順に「抽出」します。
40    while (!$queue->isEmpty()) {
41        $extractedString = $queue->extract();
42        echo "抽出（取り出し）された文字列: '" . $extractedString . "'" . PHP_EOL;
43    }
44
45    echo PHP_EOL;
46    echo "キューは空になりました。全てのタスクが処理されました。" . PHP_EOL;
47}
48
49// 関数を実行します。
50demonstrateSplPriorityQueueExtract();

SplPriorityQueue::extract()メソッドは、PHP 8の標準ライブラリ（SPL）が提供するSplPriorityQueueクラスに属し、優先度付きキューから最も優先度の高い要素を「抽出」（取り出し）するために使用されます。このメソッドは、「文字列から特定の文字を抽出する」という一般的な意味ではなく、優先度付きキューに格納された「文字列などの要素をキューから取り出す」ことを指します。

extract()メソッドは引数を取りません。呼び出されると、キュー内で設定された優先度が最も高い要素をキューから削除し、その要素の値を戻り値として返します。戻り値の型はmixedであり、キューに格納されたデータの種類（例えば、サンプルコードでは文字列）に応じて変わります。

SplPriorityQueueは、insert()メソッドで値と一緒に優先度（数値）を指定して要素を格納します。この優先度の数値が大きいほど高い優先度と見なされ、extract()メソッドは常にこの優先度に基づいて、最も優先度の高い要素を先に取り出します。

サンプルコードでは、複数の文字列を異なる優先度でキューに挿入し、extract()メソッドを繰り返し呼び出すことで、優先度の高い文字列から順にキューから取り出される様子を示しています。これは、システム内で緊急性の高いタスクから順に処理する必要がある場面などで、効率的なタスク管理を行う際に非常に役立つ機能です。extract()を呼び出すたびにキューから要素が削除されるため、キューが空になるまで処理を続けることができます。