ZipArchive::close

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)

ZipArchive::close — Close the active archive (opened or newly created)

Description

public function ZipArchive::close(): bool

Close opened or created archive and save changes. This method is automatically called at the end of the script.

Note:

All modifications to the archive (adding, removing, or renaming entries) are performed in memory and only written to disk when this method is called. As a result, errors related to file system operations (such as permission denied or missing directories) will only surface at close time rather than when the modification methods are called.

If the archive contains no files, the file is completely removed by default (no empty archive is written) according to the value of the ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE global flag.

Parameters

This function has no parameters.

Return Values

Returns true on success or false on failure.

Errors/Exceptions

Throws a ValueError if the archive is not open, for example because it was never opened or has already been closed.

Changelog

Version Description
8.0.0 Now throws a ValueError if the archive is not open. Previously, an E_WARNING was raised and false was returned.

See Also