Unzips the given ZIP file to the destination directory
Example
// Unzip a file
$zip = $config->paths->cache . "my-file.zip";
$dst = $config->paths->cache . "my-files/";
$items = $files->unzip($zip, $dst);
if(count($items)) {
// $items is an array of filenames that were unzipped into $dst
}
Usage
$array = $files->unzip(string $file, string $dst);
Arguments
Name | Type(s) | Description |
---|---|---|
file | string | ZIP file to extract |
dst | string | Directory where files should be unzipped into. Directory is created if it doesn't exist. |
Return value
array
Returns an array of filenames (excluding $dst) that were unzipped.
Exceptions
Method can throw exceptions on error:
WireException
- All error conditions result in WireException being thrown.
See Also
API reference based on ProcessWire core version 3.0.236