gzcompress

Compress a string

&reftitle.description; `string` `gzcompress` `string` `data` `int` `level`-1 `int` `encoding` ZLIB_ENCODING_DEFLATE

This function compress the given string using the `ZLIB` data format.

For details on the ZLIB compression algorithm see the document "ZLIB Compressed Data Format Specification version 3.3" (RFC 1950).

This is not the same as gzip compression, which includes some header data. See `gzencode` for gzip compression.

&reftitle.parameters;

`data`

- The data to compress.

`level`

- The level of compression. Can be given as 0 for no compression up to 9 for maximum compression.

  If -1 is used, the default compression of the zlib library is used which is 6.

`encoding`

- One of `ZLIB_ENCODING_*` constants.

&reftitle.returnvalues;

The compressed string or &false; if an error occurred.

&reftitle.examples;

### `gzcompress` example

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

&reftitle.changelog;

&Version; | &Description;
5.4.0 | Added `encoding` parameter.

&reftitle.seealso;

- `gzdeflate`
- `gzinflate`
- `gzuncompress`
- `gzencode`