gzencode
(PHP 4 >= 4.0.4, PHP 5, PHP 7)
gzencode — Create a gzip compressed string
Description
$data
[, int $level
= -1
[, int $encoding_mode
= FORCE_GZIP
]] ) : string
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).
Parameters
-
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_mode
-
The encoding mode. Can be
FORCE_GZIP
(the default) orFORCE_DEFLATE
.Prior to PHP 5.4.0, using
FORCE_DEFLATE
results in a standard zlib deflated string (inclusive zlib headers) after a gzip file header but without the trailing crc32 checksum.In PHP 5.4.0 and later,
FORCE_DEFLATE
generates RFC 1950 compliant output, consisting of a zlib header, the deflated data, and an Adler checksum.
Examples
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 = implode("", file("bigfile.txt"));
$gzdata = gzencode($data, 9);
$fp = fopen("bigfile.txt.gz", "w");
fwrite($fp, $gzdata);
fclose($fp);
?>
See Also
- gzdecode() - Decodes a gzip compressed string
- gzdeflate() - Deflate a string
- gzinflate() - Inflate a deflated string
- gzuncompress() - Uncompress a compressed string
- gzcompress() - Compress a string
- » ZLIB Compressed Data Format Specification (RFC 1950)
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.gzencode.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.