Home/ Manual/ zip / ziparchive/ ZipArchive::getCommentIndex

ZipArchive::getCommentIndex

PHP function Edit on GitHub ✎

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

Returns the comment of an entry using the entry index

Description

ZipArchive::getCommentIndex(int $index, int $flags = 0): string|false

Returns the comment of an entry using the entry index.

Parameters

index: Index of the entry
flags: If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged comment is returned.

Return Values

Returns the comment on successFalseforfailure.

Examples

Dump an entry comment

php

<?php
$zip = new ZipArchive;
$res = $zip->open('test1.zip');
if ($res === TRUE) {
    var_dump($zip->getCommentIndex(1));
} else {
    echo 'failed, code:' . $res;
}
?>

Source: reference/zip/ziparchive/getcommentindex.xml · from the official PHP manual (php/doc-en)