Documentation

CompressFast
in package

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

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$driver  : string
$compress  : CompressFastDriver
Compression driver
__construct()  : mixed
Constructor.
__get()  : mixed
compress()  : string
Compresses a string.
decompress()  : string
Decompresses a string.

Properties

$driver

public string $driver

Returns the name of the compression driver used.

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$opts : array<string|int, mixed> = []

Options:

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

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

compress()

Compresses a string.

public compress(string $text) : string
Parameters
$text : string

The string to compress.

Tags
throws
CompressFastException
Return values
string

The compressed string.

decompress()

Decompresses a string.

public decompress(string $text) : string
Parameters
$text : string

The compressed string.

Tags
throws
CompressFastException
Return values
string

The decompressed string.

Search results