(PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0)
ZipArchive::addFile — Adds a file to a ZIP archive from the given path
public ZipArchive::addFile ( string $filename [, string $entryname = null [, int $start = 0 [, int $length = 0 [, int $flags = ZipArchive::FL_OVERWRITE ]]]] ) : bool
Adds a file to a ZIP archive from a given path.
Note: For maximum portability, it is recommended to always use forward slashes (
/
) as directory separator in ZIP filenames.
filename
The path to the file to add.
entryname
If supplied, this is the local name inside the ZIP archive that will override the filename
.
start
For partial copy, start position.
length
For partial copy, length to be copied, if 0 or -1 the whole file (starting from start
) is used.
flags
Bitmask consisting of ZipArchive::FL_OVERWRITE
, ZipArchive::FL_ENC_GUESS
, ZipArchive::FL_ENC_UTF_8
, ZipArchive::FL_ENC_CP437
. The behaviour of these constants is described on the ZIP constants page.
Returns true
on success or false
on failure.
Version | Description |
---|---|
8.0.0 / 1.18.0 | flags was added. |
This example opens a ZIP file archive test.zip and add the file /path/to/index.txt. as newname.txt.
Example #1 Open and add
<?php $zip = new ZipArchive; if ($zip->open('test.zip') === TRUE) { $zip->addFile('/path/to/index.txt', 'newname.txt'); $zip->close(); echo 'ok'; } else { echo 'failed'; } ?>
Note:
When a file is set to be added to the archive, PHP will lock the file. The lock is only released once the ZipArchive object has been closed, either via ZipArchive::close() or the ZipArchive object being destroyed. This may prevent you from being able to delete the file being added until after the lock has been released.
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/ziparchive.addfile.php