gzipFile()

Compresses a single file with gzip (DEFLATE), streaming it in chunks.

Parameters

$source : string

Path to the file to compress.

$destination : string|null = null

Output path. Defaults to $source + .gz.

$level : int = -1

Compression level 0–9, or -1 for zlib's default (default: -1).

$overwrite : bool = true

Whether to overwrite an existing destination (default: true).

Tags

throws

FileException

If the source is invalid, zlib is unavailable, the destination exists and $overwrite is false, or compression fails.

author

Marc Alcaraz (ekameleon)

since

1.2.0

example

use function oihana\files\gzipFile;

gzipFile( '/var/log/app.log' ) ;                 // -> /var/log/app.log.gz
gzipFile( '/data/dump.sql' , '/data/dump.gz' , 9 ) ;