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

<?php

/**
 * 文字列を圧縮し、圧縮された文字列を返します。
 *
 * @param string $data 圧縮する文字列
 * @return string|false 圧縮された文字列。失敗した場合は false。
 */
function compress_data(string $data): string|false
{
    // 圧縮レベルを指定 (省略した場合はデフォルトの圧縮レベルが使用されます)
    $compressed_data = gzcompress($data);

    if ($compressed_data === false) {
        return false; // 圧縮に失敗した場合
    }

    return $compressed_data;
}

/**
 * 圧縮された文字列を解凍し、元の文字列を返します。
 *
 * @param string $compressed_data 解凍する文字列
 * @return string|false 解凍された文字列。失敗した場合は false。
 */
function uncompress_data(string $compressed_data): string|false
{
    // 圧縮されたデータを解凍
    $uncompressed_data = gzuncompress($compressed_data);

    if ($uncompressed_data === false) {
        return false; // 解凍に失敗した場合
    }

    return $uncompressed_data;
}

// 使用例
$original_string = "This is a string to be compressed and uncompressed.";

// 圧縮
$compressed_string = compress_data($original_string);

if ($compressed_string !== false) {
    echo "圧縮後の文字列: " . base64_encode($compressed_string) . "\n"; // バイナリデータを表示するためにbase64エンコード

    // 解凍
    $uncompressed_string = uncompress_data($compressed_string);

    if ($uncompressed_string !== false) {
        echo "解凍後の文字列: " . $uncompressed_string . "\n";
    } else {
        echo "解凍に失敗しました。\n";
    }
} else {
    echo "圧縮に失敗しました。\n";
}

?>

PHPのgzcompress関数は、文字列を圧縮するために使用されます。第一引数 $data に圧縮したい文字列を渡します。第二引数 $level で圧縮レベルを0から9の間で指定できます。省略した場合、デフォルトの圧縮レベルが使用されます。圧縮レベルが高いほど圧縮率は上がりますが、処理時間も長くなります。第三引数 $encoding は圧縮形式を指定します。通常は ZLIB_ENCODING_DEFLATE が使用されます。

関数は、圧縮された文字列を返します。圧縮に失敗した場合は false を返します。

サンプルコードでは、compress_data 関数で文字列を圧縮し、uncompress_data 関数で圧縮された文字列を解凍しています。圧縮されたデータはバイナリデータであるため、画面に出力する際は base64_encode 関数でエンコードしています。

gzuncompress 関数は、gzcompress 関数で圧縮された文字列を解凍するために使用されます。引数に圧縮された文字列を渡すと、元の文字列が返されます。解凍に失敗した場合は false を返します。

サンプルコードでは、圧縮と解凍が成功したかどうかを if 文で確認し、結果に応じてメッセージを出力しています。

<?php

/**
 * gzcompress, gzdeflate の比較サンプル.
 */

$data = "This is a test string to be compressed.";

// gzcompress を使用してデータを圧縮.
$compressed_data_compress = gzcompress($data, 9); // level 9 は最高の圧縮率.

// gzdeflate を使用してデータを圧縮.
$compressed_data_deflate = gzdeflate($data, 9); // level 9 は最高の圧縮率.

// 圧縮されたデータのサイズを表示.
echo "Original size: " . strlen($data) . " bytes\n";
echo "gzcompress size: " . strlen($compressed_data_compress) . " bytes\n";
echo "gzdeflate size: " . strlen($compressed_data_deflate) . " bytes\n";

// 圧縮データをデコードして比較.
$decompressed_data_compress = gzuncompress($compressed_data_compress);
$decompressed_data_deflate = gzinflate($compressed_data_deflate);

// 元のデータとデコードされたデータが一致するか確認.
if ($data === $decompressed_data_compress) {
    echo "gzcompress: Successfully compressed and decompressed.\n";
} else {
    echo "gzcompress: Compression or decompression failed.\n";
}

if ($data === $decompressed_data_deflate) {
    echo "gzdeflate: Successfully compressed and decompressed.\n";
} else {
    echo "gzdeflate: Compression or decompression failed.\n";
}

?>

PHP 8.4 の gzcompress 関数は、データを圧縮するために使用されます。この関数は、文字列型の $data を引数として受け取り、圧縮された文字列を返します。オプションで、圧縮レベル $level を指定できます。$level は 0 から 9 までの整数で、0 は圧縮なし、9 は最高の圧縮率を示します。デフォルト値は -1 で、zlib ライブラリのデフォルトの圧縮レベルが使用されます。また、$encoding 引数でエンコーディング方式を指定できますが、通常はデフォルト値の ZLIB_ENCODING_DEFLATE を使用します。

サンプルコードでは、gzcompress と gzdeflate という似た機能を持つ関数との比較を行っています。どちらの関数もデータを圧縮しますが、圧縮フォーマットが異なります。gzcompress は zlib フォーマットを使用し、gzdeflate は deflate フォーマットを使用します。

コードでは、まず $data という文字列を定義し、それぞれの関数で圧縮しています。gzcompress($data, 9) は、最高レベルの圧縮を行い、圧縮されたデータを $compressed_data_compress に格納します。同様に、gzdeflate($data, 9) も最高レベルで圧縮し、結果を $compressed_data_deflate に格納します。

その後、元のデータサイズと圧縮後のデータサイズを比較し、圧縮効果を確認しています。圧縮されたデータは、それぞれ gzuncompress 関数および gzinflate 関数で元のデータに戻すことができます。最後に、圧縮・解凍後のデータが元のデータと一致するかどうかを検証し、結果を表示しています。gzcompress で圧縮したデータは gzuncompress で、gzdeflate で圧縮したデータは gzinflate で解凍する必要がある点に注意してください。