php-doc-en/reference/strings/functions/sha1.xml
2003-05-07 21:31:31 +00:00

55 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.sha1">
<refnamediv>
<refname>sha1</refname>
<refpurpose>Calculate the sha1 hash of a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>sha1</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
</methodsynopsis>
<simpara>
Calculates the sha1 hash of <parameter>str</parameter> using the
<ulink url="&url.rfc;3174">US Secure Hash Algorithm 1</ulink>,
and returns that hash. The hash is a 40-character hexadecimal number.
If the optional <parameter>raw_output</parameter> is set to &true;,
then the sha1 digest is instead returned in raw binary format with a
length of 20.
</simpara>
<note>
<simpara>
The optional <parameter>raw_output</parameter> parameter was added in
PHP 5.0.0 and defaults to &false;
</simpara>
</note>
<simpara>
See also <function>sha1_file</function>, <function>crc32</function>,
and <function>md5</function>
</simpara>
</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
-->