ZipArchive::registerCancelCallback

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

ZipArchive::registerCancelCallback — アーカイブを閉じている間にキャンセルできるようにコールバックを登録する

説明

public function ZipArchive::registerCancelCallback(callable $callback): bool

アーカイブを閉じている間にキャンセルできるように callback 関数を登録します。

パラメータ

callback: この関数が0を返すと、操作は続行されます。それ以外の値を返すと、操作はキャンセルされます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

この例は、php.zip というZIPファイルを生成し、ある実行時の条件に応じて操作をキャンセルします。

例1 ファイルをアーカイブする

<?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();
}

注意

注意:
この関数は、libzip ≥ 1.6.0 と PHP をビルドした場合のみ利用できます。

参考

ZipArchive::registerProgressCallback() - アーカイブを閉じている間に更新できるようにコールバックを登録する

関連キーワード:

ZipArchive アーカイブキャンセル登録バック registerCancelCallback callback 操作 registerProgressCallback callable 続行成功実行時条件 addFile return someruncondition libzip ビルド参考