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

<?php

/**
 * Base64 でエンコードされた、gzip 圧縮されたデータを展開します。
 *
 * @param string $base64EncodedGzippedData Base64 エンコードされた gzip 圧縮データ
 * @return string|false 展開されたデータ。失敗した場合は false
 */
function inflateBase64GzipData(string $base64EncodedGzippedData): string|false
{
    // Base64 デコード
    $gzippedData = base64_decode($base64EncodedGzippedData);

    if ($gzippedData === false) {
        return false; // Base64 デコードに失敗
    }

    // gzinflate で展開
    $inflatedData = gzinflate($gzippedData);

    if ($inflatedData === false) {
        return false; // gzinflate に失敗
    }

    return $inflatedData;
}

// 使用例
$originalData = "This is a test string to be compressed and then inflated.";
$gzippedData = gzdeflate($originalData);
$base64EncodedGzippedData = base64_encode($gzippedData);

$inflatedData = inflateBase64GzipData($base64EncodedGzippedData);

if ($inflatedData !== false) {
    // echo "Original Data: " . $originalData . "\n"; // オリジナルデータ
    // echo "Inflated Data: " . $inflatedData . "\n"; // 展開されたデータ

    if ($originalData === $inflatedData) {
        // echo "Successfully inflated the data.\n"; // 成功
    } else {
        // echo "Failed to inflate the data.\n"; // 失敗
    }
} else {
    // echo "Failed to inflate the data.\n"; // 失敗
}

このサンプルコードは、Base64エンコードされたgzip圧縮データを展開するinflateBase64GzipData関数を定義しています。gzinflate関数とbase64_decode関数を組み合わせて使用することで、圧縮されたデータを元の状態に戻します。

まず、関数は引数としてBase64エンコードされたgzip圧縮された文字列 $base64EncodedGzippedData を受け取ります。この文字列は、base64_decode関数によってデコードされ、gzip圧縮されたデータ $gzippedData に変換されます。もしデコードに失敗した場合、関数は false を返します。

次に、gzinflate関数が $gzippedData を展開します。gzinflate関数は、圧縮されたデータを展開し、元の文字列を返します。もし展開に失敗した場合、gzinflate関数は false を返します。inflateBase64GzipData関数も同様に false を返します。

最後に、展開されたデータ $inflatedData が返されます。サンプルコードでは、gzdeflate関数で圧縮し、base64_encode関数でエンコードしたデータを用いて、展開処理のテストを行っています。展開されたデータと元のデータを比較することで、処理が正常に行われたかを確認できます。

gzinflate関数の引数 $data には、gzip圧縮された文字列を指定します。オプションの引数 $max_length は、展開するデータの最大長を指定します。省略した場合、最大長は制限されません。gzinflate関数は、展開された文字列を返すか、エラーが発生した場合は false を返します。

<?php

/**
 * gzinflate 関数を使ったサンプルコード
 *
 * 圧縮されたデータを解凍します。
 */

$compressed_data = gzdeflate("This is a sample string to be compressed.");

// 圧縮されたデータを解凍する
$original_data = gzinflate($compressed_data);

if ($original_data !== false) {
    echo "解凍されたデータ: " . $original_data . PHP_EOL;
} else {
    echo "解凍に失敗しました。" . PHP_EOL;
}


// 最大長を指定して解凍する例
$compressed_data_with_extra = gzdeflate("This is a longer sample string to be compressed.  This part exceeds the max_length.");
$max_length = 50;
$inflated_data_with_max_length = gzinflate($compressed_data_with_extra, $max_length);


if ($inflated_data_with_max_length !== false) {
    echo "最大長を指定して解凍されたデータ (" . $max_length . " バイト): " . substr($inflated_data_with_max_length, 0, $max_length) . PHP_EOL;
} else {
    echo "最大長を指定した解凍に失敗しました。" . PHP_EOL;
}
?>

PHPのgzinflate関数は、圧縮された文字列データを解凍するために使用します。この関数は、zlibライブラリを利用してデータを解凍します。

第1引数$dataには、解凍したい圧縮された文字列を指定します。第2引数$max_lengthはオプションで、解凍するデータの最大長をバイト単位で指定できます。$max_lengthを省略した場合、または0を指定した場合、データ全体が解凍されます。

関数は、解凍された文字列を返します。もし解凍に失敗した場合（例えば、データが有効な圧縮形式でない場合や、$max_lengthを超えた場合）、falseを返します。

サンプルコードでは、まずgzdeflate関数を使って文字列を圧縮しています。次に、gzinflate関数を使って圧縮されたデータを解凍し、元の文字列に戻します。解凍が成功した場合は、解凍されたデータを出力します。また、$max_lengthを指定して解凍する例も示しており、この場合、指定された最大長までのデータが解凍されます。解凍結果がfalseでないか確認することで、解凍が正常に行われたかどうかを判断できます。システムエンジニアを目指す方は、この関数を利用して、圧縮されたデータを効率的に扱うことができます。