PhpRiot
Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...


When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

ZipArchive::getArchiveComment

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

ZipArchive::getArchiveCommentReturns the Zip archive comment

Description

string ZipArchive::getArchiveComment ([ int $flags ] )

Returns the Zip archive comment.

Parameters

flags

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

Return Values

Returns the Zip archive comment or FALSE on failure.

Examples

Example #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;
}
?>

PHP Manual