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

Copy
1<?php
2
3/**
4 * このスクリプトは、文字列から数値を抽出し、
5 * 抽出された数値の中から最大の値を SplMaxHeap を使用して取得する方法を示します。
6 * SplMaxHeap::extract() メソッドは、ヒープから最大の要素を削除して返します。
7 *
8 * @param string $inputString 数値を含む可能性のある入力文字列
9 * @return int|null 抽出された数値の中で最大の数、または数値が見つからない場合は null
10 */
11function extractMaxNumberFromString(string $inputString): ?int
12{
13    // 1. 文字列からすべての数値を抽出する
14    // 正規表現 '/\d+/' は、1つ以上の連続する数字の並び（整数）にマッチします。
15    // preg_match_all は、マッチしたすべての結果を $matches 配列に格納します。
16    preg_match_all('/\d+/', $inputString, $matches);
17
18    // 抽出された文字列形式の数値を整数に変換
19    // $matches[0] には、見つかったすべての数値の文字列が含まれます。
20    $numbers = array_map('intval', $matches[0]);
21
22    // 抽出された数値がない場合は null を返す
23    if (empty($numbers)) {
24        return null;
25    }
26
27    // 2. SplMaxHeap を初期化する
28    // SplMaxHeap は、常に最大の要素を先頭に保つデータ構造です。
29    $maxHeap = new SplMaxHeap();
30
31    // 3. 抽出された数値をヒープに挿入する
32    // insert() メソッドは要素をヒープに追加します。
33    foreach ($numbers as $number) {
34        $maxHeap->insert($number);
35    }
36
37    // 4. SplMaxHeap::extract() を使用して最大の数値を抽出する
38    // extract() メソッドは、ヒープから最大の要素を削除し、その値を返します。
39    // ヒープが空でないことが保証されているため、戻り値は常に mixed ではなく int になります。
40    $largestNumber = $maxHeap->extract();
41
42    return $largestNumber;
43}
44
45// サンプル使用例
46$text1 = "注文番号: #12345。合計金額は 9876 円です。数量は 50 個。";
47$text2 = "バージョン 8.1.0 の PHP は素晴らしい。";
48$text3 = "この文字列には数値がありません。";
49
50echo "文字列: \"$text1\"\n";
51$max1 = extractMaxNumberFromString($text1);
52if ($max1 !== null) {
53    echo "抽出された最大の数値: " . $max1 . "\n\n"; // 9876
54} else {
55    echo "数値が見つかりませんでした。\n\n";
56}
57
58echo "文字列: \"$text2\"\n";
59$max2 = extractMaxNumberFromString($text2);
60if ($max2 !== null) {
61    echo "抽出された最大の数値: " . $max2 . "\n\n"; // 810
62} else {
63    echo "数値が見つかりませんでした。\n\n";
64}
65
66echo "文字列: \"$text3\"\n";
67$max3 = extractMaxNumberFromString($text3);
68if ($max3 !== null) {
69    echo "抽出された最大の数値: " . $max3 . "\n\n";
70} else {
71    echo "数値が見つかりませんでした。\n\n";
72}
73
74?>

このサンプルコードは、PHP 8で利用できるSplMaxHeapクラスと、そのextract()メソッドを使用して、文字列の中から最も大きな数値を効率的に見つけ出す方法を示しています。

SplMaxHeapは、「最大ヒープ」と呼ばれるデータ構造を実装したPHPの組み込みクラスです。このヒープは、要素を追加していくと常に最大の要素が一番取り出しやすい位置に自動的に整理される特性を持っています。

コードでは、まずpreg_match_allという関数を使い、与えられた文字列から数字の並び（整数）をすべて抽出します。次に、これらの抽出された文字列形式の数値をarray_map('intval', ...)で実際の整数に変換します。

その後、変換された各整数をSplMaxHeapインスタンスにinsert()メソッドで一つずつ追加していきます。これにより、ヒープ内部で数値が最大値から順に取り出せるよう整頓されます。

そして、最終的にSplMaxHeap::extract()メソッドを呼び出します。このメソッドは引数を必要とせず、ヒープに現在格納されている要素の中から最も大きな値を削除し、その値を戻り値として返します。この動作により、文字列から抽出された数値の中で最大のものが効率的に得られます。例えば、「注文番号: #12345。合計金額は 9876 円です。」という文字列からは「9876」が最大値として抽出されることが確認できます。

Copy
1<?php
2
3/**
4 * 指定されたZIPファイルを指定のディレクトリに展開します。
5 *
6 * この関数は、PHPのZipArchiveクラスを使用してZIPファイル操作を行います。
7 * 提供されたリファレンス情報のSplMaxHeap::extractメソッドは、
8 * データ構造のヒープから最大要素を取り出すためのものであり、
9 * ファイルの圧縮・展開（zip file operations）とは関連がありませんが、
10 * キーワード「php extract zip file」に最も関連性の高い内容としてこのコードを提供します。
11 *
12 * @param string $zipFilePath 展開するZIPファイルのパス
13 * @param string $destinationDir ZIPファイルを展開するディレクトリのパス
14 * @return bool 展開が成功した場合はtrue、失敗した場合はfalse
15 */
16function extractZipFile(string $zipFilePath, string $destinationDir): bool
17{
18    // 展開先のディレクトリが存在しない場合は作成を試みる
19    if (!is_dir($destinationDir)) {
20        // 再帰的にディレクトリを作成し、パーミッションを設定
21        if (!mkdir($destinationDir, 0777, true)) {
22            error_log("エラー: 展開先のディレクトリ '{$destinationDir}' を作成できませんでした。");
23            return false;
24        }
25    }
26
27    // ZipArchiveオブジェクトを初期化
28    $zip = new ZipArchive();
29
30    // ZIPファイルを開く
31    if ($zip->open($zipFilePath) === true) {
32        // ZIPファイル内のすべてのファイルを指定のディレクトリに展開
33        if ($zip->extractTo($destinationDir)) {
34            // 処理が完了したらZIPファイルを閉じる
35            $zip->close();
36            echo "ZIPファイル '{$zipFilePath}' は '{$destinationDir}' に正常に展開されました。\n";
37            return true;
38        } else {
39            error_log("エラー: ZIPファイル '{$zipFilePath}' の展開に失敗しました。");
40            $zip->close(); // エラー時でも閉じる
41            return false;
42        }
43    } else {
44        error_log("エラー: ZIPファイル '{$zipFilePath}' を開けませんでした。ファイルが存在しないか、破損しています。");
45        return false;
46    }
47}
48
49// --- 使用例 ---
50// 実行前に、以下のファイルを適宜作成またはパスを修正してください。
51// 1. 'example.zip' というZIPファイルをこのスクリプトと同じディレクトリに用意します。
52//    (例: いくつかのテキストファイルを圧縮して作成)
53// 2. 'extracted_files' というディレクトリに展開されます。
54
55$zipToExtract = __DIR__ . '/example.zip'; // 展開したいZIPファイルのパス
56$extractToDir = __DIR__ . '/extracted_files'; // 展開先のディレクトリ
57
58// 存在しないZIPファイルを仮で作成 (テスト用)
59// 実際には既存のZIPファイルを使用してください
60if (!file_exists($zipToExtract)) {
61    echo "注意: '{$zipToExtract}' が見つかりません。テスト用の空のZIPファイルを作成します。\n";
62    $testZip = new ZipArchive();
63    if ($testZip->open($zipToExtract, ZipArchive::CREATE | ZipArchive::OVERWRITE) === TRUE) {
64        $testZip->addFromString('hello.txt', 'Hello, PHP World!');
65        $testZip->addFromString('info.txt', 'This is a test file.');
66        $testZip->close();
67        echo "テスト用ZIPファイル '{$zipToExtract}' を作成しました。\n";
68    } else {
69        echo "エラー: テスト用ZIPファイル '{$zipToExtract}' の作成に失敗しました。\n";
70        exit(1);
71    }
72}
73
74
75// ZIPファイルの展開を実行
76if (extractZipFile($zipToExtract, $extractToDir)) {
77    echo "処理が完了しました。\n";
78    // 展開されたファイルを確認 (オプション)
79    if (is_dir($extractToDir)) {
80        echo "展開されたファイル:\n";
81        $files = scandir($extractToDir);
82        foreach ($files as $file) {
83            if ($file !== '.' && $file !== '..') {
84                echo "- " . $file . "\n";
85            }
86        }
87    }
88} else {
89    echo "ZIPファイルの展開中に問題が発生しました。\n";
90}
91

このサンプルコードは、PHPでZIPファイルを指定の場所に展開する方法を示しています。提供されたリファレンス情報のSplMaxHeap::extractメソッドは、データ構造から最大要素を取り出すためのものであり、ZIPファイルの操作とは関連がありません。しかし、キーワードに関連する実用的なコードとして、ZIP展開の処理をご説明します。

extractZipFile関数は、指定されたZIPファイルを特定のディレクトリへ解凍する役割を担います。この関数はPHPのZipArchiveクラスを使用しており、まず展開先のディレクトリが存在しない場合は自動で作成を試みます。次に、ZipArchiveオブジェクトを生成し、openメソッドでZIPファイルを開きます。ファイルが正常に開かれると、extractToメソッドを使ってZIPファイル内のすべてのコンテンツを指定のディレクトリに展開します。処理が完了したら、closeメソッドでファイルを閉じます。

引数$zipFilePathには展開したいZIPファイルのパスを、$destinationDirには展開先のディレクトリパスを指定します。関数が成功すると真（true）を、ファイルが見つからない、ディレクトリが作成できない、展開に失敗すると偽（false）を返します。このコードは、システムのバックアップファイルやダウンロードしたアーカイブの展開など、さまざまな場面でZIPファイルの管理を効率的に行う際に役立ちます。