【PHP8.x】gzuncompress関数の使い方

<?php

declare(strict_types=1);

/**
 * gzuncompress関数を使用してデータを展開し、結果を出力します。
 * 成功ケースと、意図的にエラーを発生させるケースの両方を扱います。
 */
function runGzuncompressExample(): void
{
    // 1. 成功ケース: 正常なデータを圧縮・展開する
    echo "--- 1. Success Case ---" . PHP_EOL;

    // 圧縮・展開の対象となる元の文字列データ
    $originalData = 'This is a sample string for gzuncompress.';
    echo "Original Data: " . $originalData . PHP_EOL;

    // gzcompress関数でデータを圧縮する
    $compressedData = gzcompress($originalData);
    echo "Compressed Data (binary): " . bin2hex($compressedData) . PHP_EOL;

    // gzuncompress関数で圧縮されたデータを展開する
    // 戻り値は展開後の文字列、またはエラー時に false
    $uncompressedData = gzuncompress($compressedData);

    // 戻り値が false かどうかを厳密にチェックしてエラーハンドリングを行う
    if ($uncompressedData === false) {
        echo "Result: Error! Failed to uncompress the data." . PHP_EOL;
    } else {
        echo "Result: Successfully uncompressed." . PHP_EOL;
        echo "Uncompressed Data: " . $uncompressedData . PHP_EOL;
    }

    echo PHP_EOL;

    // 2. エラーケース: 破損したデータを展開しようとする
    echo "--- 2. Data Error Case ---" . PHP_EOL;

    // 意図的に破損したデータを作成する (圧縮データの末尾の一部を削除)
    // これにより、gzuncompressは有効なデータとして認識できなくなる
    $corruptedData = substr($compressedData, 0, -4);
    echo "Corrupted Data (binary): " . bin2hex($corruptedData) . PHP_EOL;

    // 破損したデータを展開しようと試みる
    $resultOnFailure = gzuncompress($corruptedData);

    // 戻り値が false になるため、エラーメッセージが出力される
    if ($resultOnFailure === false) {
        echo "Result: Error! Failed to uncompress the corrupted data. (gzuncompress returned false as expected)" . PHP_EOL;
    } else {
        // このブロックは実行されない
        echo "Result: Successfully uncompressed." . PHP_EOL;
    }
}

// サンプルコードを実行する
runGzuncompressExample();

gzuncompress関数は、ZLIB形式で圧縮された文字列データを元の状態に展開するために利用されます。

この関数は、最初の引数$dataとして圧縮された文字列データを受け取ります。オプションである第二引数$max_lengthには、展開するデータの最大長をバイト単位で指定でき、0を指定するとサイズ制限なしで展開されます。

処理が成功すると、展開された元の文字列データを返します。しかし、提供されたデータが無効であるなど展開に失敗した場合は、戻り値としてブール値falseを返します。このため、関数の呼び出し後には、戻り値がfalseかどうかを厳密にチェックし、エラーハンドリングを行うことが非常に重要です。

サンプルコードでは、まず「This is a sample string for gzuncompress.」という文字列をgzcompress関数で圧縮し、その圧縮データをgzuncompress関数に渡して正常に展開する成功例を示しています。このケースでは、元の文字列が正確に復元されます。

次に、意図的に圧縮データの一部を削除して破損させたデータをgzuncompress関数に渡すエラーケースを扱っています。データが破損しているため、gzuncompress関数は展開に失敗し、期待通りにfalseを返します。この例を通じて、不正なデータが入力された際のエラー挙動と、それに対する適切なエラー処理の必要性を理解できます。

<?php

/**
 * gzuncompress関数の使用例
 *
 * @param string $compressedData gzip圧縮された文字列
 * @return string|false 解凍された文字列、または失敗した場合はfalse
 */
function gunzipString(string $compressedData): string|false
{
    // gzuncompress関数を使用して文字列を解凍します。
    $uncompressedData = gzuncompress($compressedData);

    // 解凍に成功したかどうかを確認します。
    if ($uncompressedData === false) {
        error_log("Failed to uncompress data."); // エラーログに出力
        return false;
    }

    return $uncompressedData;
}

// gzip圧縮された文字列の例
$originalString = "This is a string to be compressed.";
$compressedString = gzcompress($originalString);

// 解凍を試みる
$uncompressedString = gunzipString($compressedString);

// 結果を表示
if ($uncompressedString !== false) {
    echo "解凍された文字列: " . $uncompressedString . PHP_EOL; // 解凍された文字列を表示
} else {
    echo "解凍に失敗しました。" . PHP_EOL; // エラーメッセージを表示
}

?>

PHPのgzuncompress関数は、gzip圧縮された文字列を解凍するために使用します。引数$dataには、解凍したいgzip圧縮された文字列を渡します。オプションの引数$max_lengthは、解凍後の最大サイズを指定するために使用できます。省略した場合、最大サイズは自動的に決定されます。

この関数は、解凍された文字列を返します。解凍に失敗した場合はfalseを返します。

サンプルコードでは、gunzipStringという関数を定義し、gzuncompress関数を利用してgzip圧縮された文字列を解凍しています。まず、gzuncompress関数に圧縮された文字列を渡します。解凍に失敗した場合（falseが返された場合）は、エラーログにメッセージを出力し、falseを返します。成功した場合は、解凍された文字列を返します。

サンプルでは、最初にgzcompress関数で文字列をgzip圧縮し、その圧縮された文字列をgunzipString関数に渡して解凍を試みます。最後に、解凍された文字列を表示するか、解凍に失敗した場合はエラーメッセージを表示します。この例を通して、gzuncompress関数の基本的な使い方と、エラーハンドリングの方法を理解することができます。