ZipArchive::setArchiveComment
(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0)
ZipArchive::setArchiveComment — Set the comment of a ZIP archive
Description
$comment
): boolSet the comment of a ZIP archive.
Parameters
-
comment
-
The contents of the comment.
Return Values
Returns true
on success or false
on failure.
Examples
Example #1 Create an archive and set a comment
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
$zip->addFromString('test.txt', 'file content goes here');
$zip->setArchiveComment('new archive comment');
$zip->close();
echo 'ok';
} else {
echo 'failed';
}
?>