ZipArchive::registerCancelCallback
Register a callback to allow cancellation during archive close.
Description
public bool ZipArchive::registerCancelCallback(callable $callback)
Parameters
-
callback
-
If this function return 0 operation will continue, other value it will be cancelled.
Return Values
Returns true on success or false on failure.
Examples
This example creates a ZIP file archive
php.zip and cancel
operation on some run condition.
Example #1 Archive a file
<?php
$zip = new ZipArchive();
if ($zip->open('php.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE)) {
$zip->addFile(PHP_BINARY, 'php');
$zip->registerCancelCallback(function () {
return ($someruncondition ? -1 : 0);
});
$zip->close();
}
Notes
Note:
This function is only available if built against libzip ≥ 1.6.0.
See Also
- ZipArchive::registerProgressCallback