API Documentation
\

\Horde_Compress_Base

The base class that all compress drivers should extend.

Summary

Methods
Properties
Constants
__construct()
compress()
compressDirectory()
decompress()
$canCompress
$canDecompress
No constants found
No protected methods found
$_logger
N/A
No private methods found
No private properties found
N/A

Properties

$canCompress

$canCompress : boolean

Does this driver support compressing data?

Type

boolean

$canDecompress

$canDecompress : boolean

Does this driver support decompressing data?

Type

boolean

$_logger

$_logger : \Horde_Log_Logger

Logger

Type

\Horde_Log_Logger

Methods

__construct()

__construct(array  $options = array())

Constructor.

Parameters

array $options

Additional options for the compressor backend.

compress()

compress(mixed  $data, array  $params = array()) : mixed

Compresses the data.

Parameters

mixed $data

The data to compress.
array $params

An array of arguments needed to compress the data.

Throws

\Horde_Compress_Exception

Returns

mixed —

The compressed data.

compressDirectory()

compressDirectory(string  $directory, array  $params = array()) : mixed

Compresses a directory.

Parameters

string $directory

The directory to recursively compress.
array $params

An array of arguments needed to compress the data.

Throws

\Horde_Compress_Exception

Returns

mixed —

The compressed data.

decompress()

decompress(mixed  $data, array  $params = array()) : mixed

Decompresses the data.

Parameters

mixed $data

The data to decompress.
array $params

An array of arguments needed to decompress the data.

Throws

\Horde_Compress_Exception

Returns

mixed —

The decompressed data.