ZipArchive::addFile

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

ZipArchive::addFile — 指定したパスからファイルを ZIP アーカイブに追加する

説明

bool ZipArchive::addFile ( string $filename [, string $localname = NULL [, int $start = 0 [, int $length = 0 ]]] )

指定したパスから、ファイルを ZIP アーカイブに追加します。

パラメータ

filename: 追加するファイルへのパス。
localname: 指定した場合は ZIP アーカイブ内部での名前となり、filename を上書きします。
start: このパラメータは使いませんが、ZipArchive を継承するためには必要です。
length: このパラメータは使いませんが、ZipArchive を継承するためには必要です。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例

この例は、ZIP ファイルアーカイブ test.zip をオープンし、ファイル /path/to/index.txt を newname.txt という名前で追加します。

例1 オープンおよび抽出


<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->addFile('/path/to/index.txt', 'newname.txt');
    $zip->close();
    echo '成功';
} else {
    echo '失敗';
}
?>

注意

注意:
アーカイブにファイルを追加するよう設定すると、PHP はそのファイルのロックを試み、ZIP の操作が完了するまで解放しません。つまり、アーカイブを閉じてからでないと、追加したファイルの削除はできないということです。