BZCOMPRESS(3) 1 BZCOMPRESS(3)
bzcompress - Compress a string into bzip2 encoded data
SYNOPSIS
mixed bzcompress (string $source, [int $blocksize = 4], [int $workfactor])
DESCRIPTION
bzcompress(3) compresses the given string and returns it as bzip2 encoded data.
PARAMETERS
o $source
- The string to compress.
o $blocksize
- Specifies the blocksize used during compression and should be a number from 1 to 9 with 9 giving the best compression, but using
more resources to do so.
o $workfactor
- Controls how the compression phase behaves when presented with worst case, highly repetitive, input data. The value can be
between 0 and 250 with 0 being a special case. Regardless of the $workfactor, the generated output is the same.
RETURN VALUES
The compressed string, or an error number if an error occurred.
EXAMPLES
Example #1
Compressing data
<?php
$str = "sample data";
$bzstr = bzcompress($str, 9);
echo $bzstr;
?>
SEE ALSO
bzdecompress(3).
PHP Documentation Group BZCOMPRESS(3)
