php man page for gzdeflate

GZDEFLATE(3)								 1							      GZDEFLATE(3)

gzdeflate - Deflate a string

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

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

	For details on the DEFLATE compression algorithm see the document "DEFLATE Compressed Data Format Specification version 1.3" (RFC 1951).

PARAMETERS
	      o $data
		- The data to deflate.

	      o $level
		-  The	level of compression. Can be given as 0 for no compression up to 9 for maximum compression. If not given, the default com-
		pression level will be the default compression level of the zlib library.

	      o $encoding
		- One of ZLIB_ENCODING_* constants.

RETURN VALUES
	The deflated string or FALSE if an error occurred.

EXAMPLES
       Example #1

	      gzdeflate(3) example

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

CHANGELOG
       +--------+-----------------------------+
       |Version |			      |
       |	|			      |
       |	|	  Description	      |
       |	|			      |
       +--------+-----------------------------+
       | 5.4.0	|			      |
       |	|			      |
       |	|  Added $encoding parameter. |
       |	|			      |
       +--------+-----------------------------+
SEE ALSO
       gzinflate(3), gzcompress(3), gzuncompress(3), gzencode(3).

PHP Documentation Group 													      GZDEFLATE(3)