README

PHP library to allow Zstandard compression and decompression, without the need to install an additional PHP extension.

Dependencies

ZSTD, example installation on Ubuntu:

sudo apt install zstd

Installation

composer require appoly/zstd-php

Usage

Basic

Decompress a file on the local filesystem:

use Appoly\ZstdPhp\ZSTD;

ZSTD::decompress('path/to/file.zst', 'path/to/output/file');

Compress a file on the local filesystem:

use Appoly\ZstdPhp\ZSTD;

ZSTD::compress('path/to/file', 'path/to/output/file.zst');

Advanced

Decompress from a stream, and handle the output yourself in chunks. Can be used with custom filesystems etc to minimise memory usage.

use Appoly\ZstdPhp\ZSTD;

$inputStream = fopen('path/to/file.zst', 'r');
$outputCallback = function ($outputChunk) {
    // Do something with the output chunk
    echo $outputChunk;
};

ZSTD::decompressDataFromStream(
    inputStream: $inputStream,
    outputCallback: $outputCallback
);

fclose($inputStream);

Compress from a stream, and handle the output yourself in chunks. Can be used with custom filesystems etc to minimise memory usage.

use Appoly\ZstdPhp\ZSTD;

$inputStream = fopen('path/to/file', 'r');
$outputCallback = function ($outputChunk) {
    // Do something with the output chunk
    echo $outputChunk;
};

ZSTD::compressDataToStream(
    inputStream: $inputStream,
    outputCallback: $outputCallback
);

fclose($inputStream);

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

appoly / zstd-php

Maintainers

Details