ZipArchive::setCommentName
(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0)
ZipArchive::setCommentName — Set the comment of an entry defined by its name
Description
$name
, string $comment
): boolSet the comment of an entry defined by its name.
Parameters
-
name
-
Name of the entry.
-
comment
-
The contents of the comment.
Return Values
Returns true
on success or false
on failure.
Examples
Example #1 Open an archive and set a comment for an entry
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
$zip->setCommentName('entry1.txt', 'new entry comment');
$zip->close();
echo 'ok';
} else {
echo 'failed';
}
?>