php-doc-en/reference/zip/functions/ziparchive-getarchivecomment.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.ziparchive-getarchivecomment">
 <refnamediv>
  <refname>ZipArchive::getArchiveComment</refname>
  <refpurpose>Returns the Zip archive comment</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>ZipArchive::getArchiveComment</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Returns the Zip archive comment.
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the Zip archive comment or &false; on failure.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
    <example>
     <title>Dump an archive comment</title>
     <programlisting role="php">
<![CDATA[
<?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;
}
?>
]]>
     </programlisting>
    </example>
   </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->