Php/docs/function.gzdeflate

From Get docs

gzdeflate

(PHP 4 >= 4.0.4, PHP 5, PHP 7)

gzdeflateDeflate a string


Description

gzdeflate ( string $data [, int $level = -1 [, int $encoding = ZLIB_ENCODING_RAW ]] ) : string|false

This function compresses the given string using the DEFLATE data format.

For details on the DEFLATE compression algorithm see the document "[http://www.faqs.org/rfcs/rfc1951 » DEFLATE Compressed Data Format Specification version 1.3]" (RFC 1951).


Parameters

data
The data to deflate.
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
One of ZLIB_ENCODING_* constants.


Return Values

The deflated string or FALSE if an error occurred.


Examples

Example #1 gzdeflate() example

<?php$compressed = gzdeflate('Compress me', 9);echo $compressed;?>

See Also