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

Copy
1<?php
2
3/**
4 * 指定された文字列からすべての数値を抽出します。
5 * 整数と浮動小数点数の両方に対応しています。
6 *
7 * @param string $text 数値抽出元の文字列
8 * @return array 抽出された数値の配列
9 */
10function extractNumbersFromString(string $text): array
11{
12    // 正規表現パターン:
13    // \d+    -> 1桁以上の数字（整数部分）
14    // (\.\d+)? -> ドットと1桁以上の数字が0回または1回出現する（小数部分、オプション）
15    // PCRE_PATTERN_ORDER は、マッチ全体が返される順序を制御します。
16    // この場合、各数値が独立した要素として配列に格納されます。
17    preg_match_all('/\d+(\.\d+)?/', $text, $matches);
18
19    // $matches[0] に抽出されたすべての数値（文字列形式）が含まれます。
20    // floatval() を使用して、文字列を浮動小数点数に変換します。
21    return array_map('floatval', $matches[0]);
22}
23
24// サンプルコードの実行例
25$sampleString = "この文章には123個のリンゴと45.67個のオレンジ、そして合計890円の費用がかかります。";
26$numbers = extractNumbersFromString($sampleString);
27
28// 抽出された数値を出力
29echo "元の文字列: " . $sampleString . "\n";
30echo "抽出された数値: \n";
31print_r($numbers);
32
33$anotherString = "商品の価格は100ドルで、割引後には99.99ドルになります。";
34$moreNumbers = extractNumbersFromString($anotherString);
35
36echo "\n別の文字列: " . $anotherString . "\n";
37echo "抽出された数値: \n";
38print_r($moreNumbers);
39
40?>

PHP 8で動作するこのサンプルコードは、与えられた文字列からすべての数値を抽出し、浮動小数点数の配列として返すextractNumbersFromString関数を定義しています。文字列中の数値データを効率的に取り出す基本的な手法を示しており、システムエンジニアを目指す初心者の方にとって、データ処理の理解を深める一助となります。

この関数は、$text引数として数値抽出元の文字列を受け取ります。内部ではpreg_match_all関数が正規表現/\d+(\.\d+)?/を用いて文字列中の数値パターンを検索し、整数（例：123）と浮動小数点数（例：45.67）の両方を検出します。

preg_match_allで見つかった数値は文字列形式のため、array_map関数とfloatval関数を組み合わせて全て浮動小数点数に変換されます。最終的に、この数値の配列が戻り値として返されます。ログ解析や設定ファイルの処理、ユーザー入力からの数値取得など、文字列から数値情報を取得する多様な場面で有用です。

Copy
1<?php
2
3/**
4 * SplMinHeapクラスは、SplHeapを継承したヒープ実装の一つです。
5 * データが挿入されると、常に最小の要素が最上位（根）に位置するように管理します。
6 * extractメソッドは、この最上位の要素を取り出し、ヒープから削除します。
7 *
8 * このサンプルコードでは、文字列をヒープに格納し、
9 * SplHeap::extractメソッドを使用してヒープから文字列を「抽出」する方法を示します。
10 * これは、文字列の中から特定の部分を切り出す一般的な「文字列の抽出」とは異なり、
11 * データ構造であるヒープから要素として文字列を取り出す操作です。
12 */
13$heap = new SplMinHeap();
14
15// 文字列をヒープに挿入します。
16// SplMinHeapは、文字列を辞書順（アルファベット順）で比較し、最小のものを最上位に置きます。
17$heap->insert("apple");
18$heap->insert("banana");
19$heap->insert("cherry");
20$heap->insert("date");
21$heap->insert("grape");
22
23echo "ヒープに挿入された要素数: " . $heap->count() . "\n";
24
25// extractメソッドでヒープの最上位要素（この場合は辞書順で最小の文字列）を抽出します。
26// 抽出された要素はヒープから削除されます。
27$extractedString1 = $heap->extract();
28echo "抽出された文字列1: " . $extractedString1 . "\n"; // 出力例: apple
29echo "残りのヒープの要素数: " . $heap->count() . "\n";
30
31// もう一度extractメソッドを呼び出すと、次に小さい文字列が抽出されます。
32$extractedString2 = $heap->extract();
33echo "抽出された文字列2: " . $extractedString2 . "\n"; // 出力例: banana
34echo "残りのヒープの要素数: " . $heap->count() . "\n";
35
36// ヒープが空になるまで残りの要素を抽出し続けます。
37echo "\n--- ヒープの全要素を順に抽出 --- \n";
38while (!$heap->isEmpty()) {
39    $extracted = $heap->extract();
40    echo "抽出された文字列: " . $extracted . "\n";
41}
42
43echo "\nヒープは空になりました。\n";
44echo "最終的なヒープの要素数: " . $heap->count() . "\n";
45
46?>

PHPのSplHeapクラスは、ヒープという特殊なデータ構造を扱うための基底クラスです。ヒープは、要素を効率的に追加し、常に最小または最大の要素を素早く取り出すことができる特徴を持っています。特にSplMinHeapクラスは、要素を挿入すると自動的に最小の要素が最上位（根）に配置されるよう管理します。

SplHeap::extractメソッドは、このヒープの最上位に位置する要素をヒープから取り出し、同時にその要素をヒープから削除する役割を担います。このメソッドには引数がなく、呼び出すだけで現在の最上位要素を取得できます。戻り値はmixed型であり、ヒープに格納されていたどのような型の要素でも、そのままの型で返されます。

サンプルコードでは、SplMinHeapに複数の文字列を挿入しています。SplMinHeapは文字列を辞書順（アルファベット順）で比較するため、挿入された文字列の中から最も辞書順で早いものが常に最上位に置かれます。extractメソッドを呼び出すと、辞書順で最小の文字列（この例では"apple"）が取り出され、ヒープから削除されます。再度呼び出すと、残りの要素の中から再び最小の文字列（"banana"）が取り出されます。このように、SplHeap::extractは、ヒープというデータ構造から要素を順に取り出すためのメソッドであり、一般的な文字列の中から特定の部分を切り出す「文字列の抽出」とは異なる操作である点にご注意ください。ヒープが空になるまでextractを繰り返すことで、全ての要素が順序付けられた状態で取り出されます。

Copy
1<?php
2
3/**
4 * 指定されたZIPファイルを指定されたディレクトリに展開します。
5 *
6 * @param string $zipFilePath 展開するZIPファイルのパス
7 * @param string $extractToPath 展開先のディレクトリパス
8 * @return bool 展開が成功した場合はtrue、失敗した場合はfalse
9 */
10function extractZipFile(string $zipFilePath, string $extractToPath): bool
11{
12    // ZipArchiveオブジェクトを作成
13    $zip = new ZipArchive;
14
15    // ZIPファイルが存在しない場合はエラー
16    if (!file_exists($zipFilePath)) {
17        echo "エラー: ZIPファイル '{$zipFilePath}' が見つかりません。\n";
18        return false;
19    }
20
21    // ZIPファイルを開く
22    if ($zip->open($zipFilePath) === true) {
23        // 展開先ディレクトリが存在しない場合は作成
24        if (!is_dir($extractToPath)) {
25            // trueを指定することで、必要に応じて親ディレクトリも再帰的に作成
26            // 0777 はディレクトリのパーミッション（読み書き実行の権限）
27            mkdir($extractToPath, 0777, true);
28        }
29
30        // 指定したディレクトリにファイルを展開
31        if ($zip->extractTo($extractToPath)) {
32            echo "ZIPファイルを正常に展開しました: '{$zipFilePath}' から '{$extractToPath}' へ\n";
33            $zip->close();
34            return true;
35        } else {
36            echo "エラー: ZIPファイルの展開に失敗しました。\n";
37            $zip->close();
38            return false;
39        }
40    } else {
41        // ZIPファイルが開けなかった場合のエラーコードをチェックすることも可能
42        // 例: $zip->open($zipFilePath) !== true の戻り値
43        echo "エラー: ZIPファイル '{$zipFilePath}' を開けませんでした。\n";
44        return false;
45    }
46}
47
48// --- サンプル使用例 ---
49// このコードは単体で動作するように、一時的なZIPファイルの作成と後処理を含みます。
50
51$sampleZipFileName = 'sample_archive.zip';
52$extractedDirName = 'extracted_data';
53$sampleFileContent = 'これはZIPファイル内のテストコンテンツです。';
54$sampleFileNameInZip = 'test_document.txt';
55
56// 1. 展開テスト用のダミーZIPファイルを作成
57echo "ダミーZIPファイルを作成中...\n";
58$zip = new ZipArchive();
59if ($zip->open($sampleZipFileName, ZipArchive::CREATE | ZipArchive::OVERWRITE) === true) {
60    $zip->addFromString($sampleFileNameInZip, $sampleFileContent);
61    $zip->close();
62    echo "ダミーZIPファイル '{$sampleZipFileName}' が作成されました。\n";
63} else {
64    echo "エラー: ダミーZIPファイルの作成に失敗しました。\n";
65    exit(1); // 処理を終了
66}
67
68// 2. 作成したダミーZIPファイルを展開
69echo "\nZIPファイルの展開処理を開始...\n";
70if (extractZipFile($sampleZipFileName, $extractedDirName)) {
71    echo "ZIP展開処理が正常に完了しました。\n";
72    $extractedFilePath = $extractedDirName . '/' . $sampleFileNameInZip;
73    if (file_exists($extractedFilePath)) {
74        echo "展開されたファイル '{$extractedFilePath}' の内容:\n";
75        echo file_get_contents($extractedFilePath) . "\n";
76    }
77} else {
78    echo "ZIP展開処理中にエラーが発生しました。\n";
79}
80
81// 3. 後処理: 作成したダミーファイルとディレクトリを削除
82echo "\n後処理を開始...\n";
83if (file_exists($sampleZipFileName)) {
84    unlink($sampleZipFileName);
85    echo "ダミーZIPファイル '{$sampleZipFileName}' を削除しました。\n";
86}
87
88if (is_dir($extractedDirName)) {
89    $extractedFilePath = $extractedDirName . '/' . $sampleFileNameInZip;
90    if (file_exists($extractedFilePath)) {
91        unlink($extractedFilePath); // 展開されたファイルを削除
92    }
93    rmdir($extractedDirName); // 展開ディレクトリを削除
94    echo "展開先ディレクトリ '{$extractedDirName}' を削除しました。\n";
95}
96echo "後処理が完了しました。\n";
97
98?>

このPHPコードは、指定されたZIPファイルを特定のディレクトリに展開する機能を提供します。提供されたリファレンス情報のSplHeap::extractは、ヒープデータ構造から最上位の要素を取り出すメソッドですが、このサンプルコードが主に使用しているのは、ZIPアーカイブの操作を行うZipArchiveクラスのextractToメソッドです。

extractZipFile関数は、引数として渡された$zipFilePath（展開するZIPファイルのパス）を$extractToPath（展開先のディレクトリパス）へ展開します。戻り値は、展開が成功した場合はtrue、失敗した場合はfalseを返します。

関数内部では、まずZipArchiveオブジェクトを作成し、指定されたZIPファイルをopenメソッドで開きます。ファイルが存在しない場合や開けない場合は処理を中断し、エラーメッセージを表示します。ZIPファイルが正常に開かれた後、展開先のディレクトリが存在しなければmkdir関数で作成し、extractToメソッドを用いてファイル群を指定ディレクトリへ展開します。処理の完了後にはcloseメソッドでZIPファイルを閉じます。

コードの後半にあるサンプル使用例では、一時的なダミーZIPファイルを作成し、それをextractZipFile関数で展開し、最後に作成されたファイルとディレクトリを削除するまでの一連の流れが示されており、実際の利用方法を試すことができます。