(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)
gzencode — Create a gzip compressed string
$data
, int $level
= -1, int $encoding
= ZLIB_ENCODING_GZIP
): string|false
This function returns a compressed version of the input
data
compatible with the output of the
gzip program.
For more information on the GZIP file format, see the document: » GZIP file format specification version 4.3 (RFC 1952).
data
The data to encode.
level
The level of compression. Can be given as 0 for no compression up to 9 for maximum compression. If not given, the default compression level will be the default compression level of the zlib library.
encoding
The encoding mode. Can be FORCE_GZIP
(the default)
or FORCE_DEFLATE
.
FORCE_DEFLATE
generates
RFC 1950 compliant output, consisting of a zlib header, the deflated
data, and an Adler checksum.
The encoded string, or false
if an error occurred.
The resulting data contains the appropriate headers and data structure to make a standard .gz file, e.g.:
Example #1 Creating a gzip file
<?php
$data = file_get_contents("bigfile.txt");
$gzdata = gzencode($data, 9);
file_put_contents("bigfile.txt.gz", $gzdata);
?>