ZipArchive::addFile
ZipArchive::addFile
(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
Description
bool ZipArchive::addFile ( string $filename [, string $localname = NULL [, int $start = 0 [, int $length = 0 ]]] )
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.
Parameters
-
filename -
The path to the file to add.
-
localname -
If supplied, this is the local name inside the ZIP archive that will override the
filename. -
start -
This parameter is not used but is required to extend ZipArchive.
-
length -
This parameter is not used but is required to extend ZipArchive.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
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';
}
?> Notes
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–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/ziparchive.addfile.php
