API Documentation
\

\Horde_Compress_Fast

Provides fast compression of strings using the best-available algorithm.

Summary

Methods
Properties
Constants
__construct()
__get()
compress()
decompress()
$driver
No constants found
No protected methods found
$_compress
N/A
No private methods found
No private properties found
N/A

Properties

$driver

$driver : string

Returns the name of the compression driver used.

Type

string

Methods

__construct()

__construct(array  $opts = array())

Constructor.

Parameters

array $opts

Options:

  - drivers: (array) A list of driver names (Horde_Compress_Fast_Base
             class names) to use instead of auto-detecting.
  - zlib: (boolean) Consider zlib to be a "fast" compression algorithm.
          Only used if 'drivers' is empty. (@since 1.1.0).

Throws

\Horde_Compress_Fast_Exception

__get()

__get(  $name)

Parameters

$name

compress()

compress(string  $text) : string

Compresses a string.

Parameters

string $text

The string to compress.

Throws

\Horde_Compress_Fast_Exception

Returns

string —

The compressed string.

decompress()

decompress(string  $text) : string

Decompresses a string.

Parameters

string $text

The compressed string.

Throws

\Horde_Compress_Fast_Exception

Returns

string —

The decompressed string.