PHP 8.3.4 Released!

ZipArchive::setCommentIndex

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

ZipArchive::setCommentIndexSet the comment of an entry defined by its index

Description

public ZipArchive::setCommentIndex(int $index, string $comment): bool

Set the comment of an entry defined by its index.

Parameters

index

Index 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->setCommentIndex(2, 'new entry comment');
$zip->close();
echo
'ok';
} else {
echo
'failed';
}
?>
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top