kjdev / lz4
A compression/decompression with LZ4
Installs: 17
Dependents: 0
Suggesters: 0
Security: 0
Stars: 151
Watchers: 17
Forks: 38
Open Issues: 11
Type:php-ext
Requires
- php: >= 5.6.0
This package is auto-updated.
Last update: 2025-04-14 01:00:02 UTC
README
This extension allows LZ4.
Documentation for LZ4 can be found at » https://github.com/Cyan4973/lz4.
Build from sources
% git clone --recursive --depth=1 https://github.com/kjdev/php-ext-lz4.git
% cd php-ext-lz4
% phpize
% ./configure
% make
% make install
To use the system library
% ./configure --with-lz4-includedir=/usr
Distribution binary packages
Fedora / CentOS / RHEL
RPM packages of this extension are available in » Remi's RPM repository and are named php-lz4.
Debian
DEB packages of this extension are available in » Ondřej Surý's DEB repository and are named php-lz4.
Configuration
php.ini:
extension=lz4.so
Function
- lz4_compress — LZ4 compression
- lz4_uncompress — LZ4 decompression
lz4_compress — LZ4 compression
Description
string lz4_compress ( string $data [ , int $level = 0 , string $extra = NULL ] )
LZ4 compression.
Pameters
-
data
The string to compress.
-
level
The level of compression (1-12, Recommended values are between 4 and 9). (Default to 0, Not High Compression Mode.)
-
extra
Prefix to compressed data.
Return Values
Returns the compressed data or FALSE if an error occurred.
lz4_uncompress — LZ4 decompression
Description
string lz4_uncompress ( string $data [ , long $maxsize = -1 , long $offset = -1 ] )
LZ4 decompression.
Pameters
-
data
The compressed string.
-
maxsize
Allocate size output data.
-
offset
Offset to decompressed data.
Return Values
Returns the decompressed data or FALSE if an error occurred.
Examples
$data = lz4_compress('test');
lz4_uncompress($data);
Compress Data
Default
$data = lz4_compress('test')
Extra prefix data
$data = lz4_compress('test', false, 'PREFIX')
Uncompress Data
Default
lz4_uncompress($data);
Offset
lz4_uncompress($data, 256, 6);