ZipArchive::setArchiveComment

(PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0)

ZipArchive::setArchiveComment — ZIP アーカイブのコメントを設定する

説明

ZipArchive::setArchiveComment ( string $comment ) : bool

ZIP アーカイブのコメントを設定します。

パラメータ

comment

コメントの内容。

返り値

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

例

例1 アーカイブの作成およびコメントの設定

<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
    $zip->addFromString('test.txt', 'ここにファイルの内容を書きます');
    $zip->setArchiveComment('新しいアーカイブのコメント');
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>