Home/ Manual/ zip / ziparchive/ ZipArchive::registerProgressCallback

ZipArchive::registerProgressCallback

PHP function Edit on GitHub ✎

(PHP >= 8.0.0, PECL zip >= 1.17.0)

Description

ZipArchive::registerProgressCallback(float $rate, callable $callback): bool

Parameters

rate: Change between each call of the callback (from 0.0 to 1.0).
callback: This function will receive the current state as a float (from 0.0 to 1.0).

Return Values

Success

Examples

This example creates a ZIP file archive php.zip and show progression.

Archive a file

php

$zip = new ZipArchive();
if ($zip->open('php.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE)) {
	$zip->addFile(PHP_BINARY, 'php');
	$zip->registerProgressCallback(0.05, function ($r) {
		printf("%d%%\n", $r * 100);
	});
	$zip->close();
}

Notes

Note

This function is only available if built against libzip ≥ 1.3.0.