= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)ZipArchive::addFile — Adds a file to a ZIP archive from the given path說明public Zip">

ZipArchive::addFile

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

ZipArchive::addFile — Adds a file to a ZIP archive from the given path

說明

public ZipArchive::addFile(
    string $filepath,
    string $entryname = "",
    int $start = 0,
    int $length = 0,
    int $flags = ZipArchive::FL_OVERWRITE
): bool

Adds a file to a ZIP archive from a given path.

注意: 為了最大限度地提高代碼可移植性，建議在 ZIP 文件名中使用斜線 (/) 做為目錄分隔符。

參數(shù)

filepath

The path to the file to add.

entryname

If supplied and not empty, this is the local name inside the ZIP archive that will override the filepath.

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.

返回值

成功時返回 true， 或者在失敗時返回 false。

更新日志

版本 說明
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.

示例 #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';
}
?>

注釋

注意:

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.

參見