Home > PHP > Function > Bzip2 > bzcompress()

bzcompress()

bzcompress - Compress a string into bzip2 encoded data

Syntax

mixed bzcompress (string $source, int $blocksize, int $workfactor)

Arguments

  • source - The string to compress.
  • 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.
  • 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.

Description

bzcompress() compresses the given string and returns it as bzip2 encoded data.

Version

PHP 4.0.4, 5

Return value

The compressed string or number of error in case of error.