PHP8 ZipArchive::addFile
(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)
ZipArchive::addFile — 将文件从给定路径添加到ZIP存档
说明
public ZipArchive::addFile(
string $filepath,
string $entryname = "",
int $start = 0,
int $length = ZipArchive::LENGTH_TO_END,
int $flags = ZipArchive::FL_OVERWRITE
): bool
将文件从给定路径添加到 ZIP 存档。
注意: 为了最大限度地提高代码可移植性,建议在 ZIP 文件名中使用斜线 (/) 做为目录分隔符。
参数
filepath
要添加的文件的路径。
entryname
如果提供且不为空,则这是 ZIP 存档中的本地名称,它将覆盖 .
filepath
start
对于部分复制,起始位置。
length
对于部分副本,要复制的长度, 如果
ZipArchive::LENGTH_TO_END
(0) 使用文件大小, 如果ZipArchive::LENGTH_UNCHECKED
则使用整个文件 (从 开始)。start
flags
位掩码由
ZipArchive::FL_OVERWRITE
、ZipArchive::FL_ENC_GUESS
、ZipArchive::FL_ENC_UTF_8
、ZipArchive::FL_ENC_CP437
、ZipArchive::FL_OPEN_FILE_NOW
组成。 ZIP 常量页面上描述了这些常量的行为。
返回值
成功时返回 true, 或者在失败时返回 false。
更新日志
版本 | 说明 |
---|---|
8.0.0 / 1.18.0 | flags 被添加。 |
8.3.0 / 1.22.1 | 添加了 ZipArchive::FL_OPEN_FILE_NOW 。 |
8.3.0 / 1.22.2 | 添加了 ZipArchive::LENGTH_TO_END 和 ZipArchive::LENGTH_UNCHECKED 。 |
示例
此示例打开一个 ZIP 文件存档并添加 文件 . 如。test.zip/path/to/index.txtnewname.txt
示例 #1 打开并添加
<?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';
}
?>
注释
注意:当一个文件被设置为添加到存档中时,PHP将锁定该文件。这 锁仅在 ZipArchive 对象后释放 已通过 ZipArchive::close() 或 正在销毁的 ZipArchive 对象。这可能 阻止您删除正在添加的文件,直到 锁已解除。
参见
- ZipArchive::replaceFile() - 将ZIP存档中的文件替换为给定路径