ZipArchive::getArchiveComment

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

ZipArchive::getArchiveCommentReturns the Zip archive comment

Description

string ZipArchive::getArchiveComment ( void )

Returns the Zip archive comment.

Parameters

This function has no parameters.

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

Copyright © 2010-2024 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout