php-doc-en/reference/phar/Phar/getSignature.xml
2013-06-18 05:36:30 +00:00

61 lines
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.getsignature">
<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>
<modifier>public</modifier> <type>array</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.
</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
-->