Horde_Compress_Gzip
extends Horde_Compress_Base
in package
The Horde_Compress_Gzip class allows gzip files to be read.
Tags
Table of Contents
- $canCompress : bool
- Does this driver support compressing data?
- $canDecompress : bool
- Does this driver support decompressing data?
- $_flags : array<string|int, mixed>
- Gzip file flags.
- $_logger : Horde_Log_Logger
- Logger
- __construct() : mixed
- Constructor.
- compress() : mixed
- Compresses the data.
- compressDirectory() : mixed
- Compresses a directory.
- decompress() : string
- Decompresses the data.
Properties
$canCompress
Does this driver support compressing data?
public
bool
$canCompress
= \false
$canDecompress
Does this driver support decompressing data?
public
bool
$canDecompress
= \true
$_flags
Gzip file flags.
protected
array<string|int, mixed>
$_flags
= array('FTEXT' => 0x1, 'FHCRC' => 0x2, 'FEXTRA' => 0x4, 'FNAME' => 0x8, 'FCOMMENT' => 0x10)
$_logger
Logger
protected
Horde_Log_Logger
$_logger
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
-
Additional options for the compressor backend.
Return values
mixed —compress()
Compresses the data.
public
compress(mixed $data[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $data : mixed
-
The data to compress.
- $params : array<string|int, mixed> = array()
-
An array of arguments needed to compress the data.
Tags
Return values
mixed —The compressed data.
compressDirectory()
Compresses a directory.
public
compressDirectory(string $directory[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $directory : string
-
The directory to recursively compress.
- $params : array<string|int, mixed> = array()
-
An array of arguments needed to compress the data.
Tags
Return values
mixed —The compressed data.
decompress()
Decompresses the data.
public
decompress(mixed $data[, array<string|int, mixed> $params = array() ]) : string
Parameters
- $data : mixed
-
The data to decompress.
- $params : array<string|int, mixed> = array()
-
An array of arguments needed to decompress the data.
Return values
string —The uncompressed data.