unzip()

Extracts a zip archive into a destination directory.

Parameters

$zipFile : string

Path to the zip archive to extract.

$outputPath : string

Directory where the archive is extracted. Created if missing.

$options : array{dryRun?: bool, overwrite?: bool, maxEntries?: int|null, maxSize?: int|null, keepPermissions?: bool} = []

Optional flags, keyed by ZipOption:

• dryRun: If true, no file is written; returns the list of file entries that would be extracted (directory entries excluded). Default: false.
• overwrite: If false, extraction fails when a target file already exists. Default: true.
• maxEntries: If a positive integer, the archive is rejected when it declares more entries than this limit (decompression-bomb guard). Default: null (no limit).
• maxSize: If a positive integer, the archive is pre-scanned and rejected before any file is written when the sum of the entries' uncompressed sizes exceeds this limit (decompression-bomb guard). Default: null (no limit).
• keepPermissions: If true, restores the Unix file mode stored in each entry's external attributes (OPSYS_UNIX) via chmod(). Entries without Unix permissions are left with the default mode. Best-effort: a failing chmod() is ignored. Default: false.

Tags

throws

FileException

If the archive does not exist, cannot be opened, an entry escapes the destination (Zip Slip), a bomb guard trips, or a target already exists while overwrite is disabled.

DirectoryException

If the destination directory (or an entry's parent) cannot be created.

example

// Basic extraction
unzip( '/path/to/archive.zip' , '/output/dir' );

// Dry-run: preview contents without extracting
$files = unzip( '/path/to/archive.zip' , '/output/dir' , [ 'dryRun' => true ] );

// Refuse to overwrite, and guard against decompression bombs
unzip( '/path/to/archive.zip' , '/output/dir' , [
    'overwrite'  => false,
    'maxEntries' => 10_000,
    'maxSize'    => 500 * 1024 * 1024,
]);

author

Marc Alcaraz (ekameleon)

since

1.2.0