Edit Report a Bug

ZipArchive::getArchiveComment

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

ZipArchive::getArchiveComment — Returns the Zip archive comment

Descrição

public ZipArchive::getArchiveComment(int $flags = 0): string|false

Returns the Zip archive comment.

Parâmetros

flags: If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged comment is returned.

Valor Retornado

Returns the Zip archive comment ou false em caso de falha.

Exemplos

Exemplo #1 Dump an archive comment

<?php
$zip = new ZipArchive;
$res = $zip->open('test_with_comment.zip');
if ($res === TRUE) {
    var_dump($zip->getArchiveComment());
    /* Or using the archive property */
    var_dump($zip->comment);
} else {
    echo 'failed, code:' . $res;
}
?>

add a note

User Contributed Notes

There are no user contributed notes for this page.