<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phar.getsignature" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Phar::getSignature</refname>
  <refpurpose>Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Phar">
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Phar::getSignature</methodname>
   <void/>
  </methodsynopsis>

  <para>
   Returns the verification signature of a phar archive in a hexadecimal string.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Array with the opened archive's signature in <literal>hash</literal> key and <literal>MD5</literal>,
   <literal>SHA-1</literal>,
   <literal>SHA-256</literal>, <literal>SHA-512</literal>, or <literal>OpenSSL</literal>
   in <literal>hash_type</literal>.  This signature is a hash calculated on the
   entire phar's contents, and may be used to verify the integrity of the archive.
   A valid signature is absolutely required of all executable phar archives if the
   <link linkend="ini.phar.require-hash">phar.require_hash</link> INI variable
   is set to true.
   If there is no signature, the function returns &false;.
  </para>
 </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:"~/.phpdoc/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
-->
