philip Thu Feb 20 05:54:32 2003 EDT
Modified files:
/phpdoc/en/reference/strings/functions md5.xml md5-file.xml
sha1.xml sha1-file.xml
Log:
Documented newly added raw_output parameter (in PHP 5.0.0)
Index: phpdoc/en/reference/strings/functions/md5.xml
diff -u phpdoc/en/reference/strings/functions/md5.xml:1.4
phpdoc/en/reference/strings/functions/md5.xml:1.5
--- phpdoc/en/reference/strings/functions/md5.xml:1.4 Tue Nov 19 19:14:09 2002
+++ phpdoc/en/reference/strings/functions/md5.xml Thu Feb 20 05:54:32 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.135 -->
<refentry id="function.md5">
<refnamediv>
@@ -11,13 +11,22 @@
<methodsynopsis>
<type>string</type><methodname>md5</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
+ <methodparam
+choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
</methodsynopsis>
<para>
Calculates the MD5 hash of <parameter>str</parameter> using the
<ulink url="&url.rfc;rfc1321.html">RSA Data Security, Inc.
MD5 Message-Digest Algorithm</ulink>, and returns that hash.
- The hash is a 32-character hexadecimal number.
+ The hash is a 32-character hexadecimal number. If the optional
+ <parameter>raw_output</parameter> is set to &true;, then the md5 digest
+ is instead returned in raw binary format with a length of 16.
</para>
+ <note>
+ <simpara>
+ The optional <parameter>raw_output</parameter> parameter was added in
+ PHP 5.0.0 and defaults to &false;
+ </simpara>
+ </note>
<para>
See also <function>crc32</function>, <function>md5_file</function>,
and <function>sha1</function>.
Index: phpdoc/en/reference/strings/functions/md5-file.xml
diff -u phpdoc/en/reference/strings/functions/md5-file.xml:1.3
phpdoc/en/reference/strings/functions/md5-file.xml:1.4
--- phpdoc/en/reference/strings/functions/md5-file.xml:1.3 Sat Jul 27 00:07:06
2002
+++ phpdoc/en/reference/strings/functions/md5-file.xml Thu Feb 20 05:54:32 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry id="function.md5-file">
<refnamediv>
@@ -11,19 +11,30 @@
<methodsynopsis>
<type>string</type><methodname>md5_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam
+choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
</methodsynopsis>
<para>
Calculates the MD5 hash of the specified
<parameter>filename</parameter> using the
<ulink url="&url.rfc;rfc1321.html">RSA Data Security, Inc.
MD5 Message-Digest Algorithm</ulink>, and returns that hash.
+ The hash is a 32-character hexadecimal number. If the optional
+ <parameter>raw_output</parameter> is set to &true;, then the md5 digest
+ is instead returned in raw binary format with a length of 16.
</para>
+ <note>
+ <simpara>
+ The optional <parameter>raw_output</parameter> parameter was added in
+ PHP 5.0.0 and defaults to &false;
+ </simpara>
+ </note>
<para>
This function has the same purpose of the command line utility
md5sum.
</para>
<para>
- See also <function>md5</function> and <function>crc32</function>
+ See also <function>md5</function>, <function>crc32</function>,
+ and <function>sha1_file</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/strings/functions/sha1.xml
diff -u phpdoc/en/reference/strings/functions/sha1.xml:1.2
phpdoc/en/reference/strings/functions/sha1.xml:1.3
--- phpdoc/en/reference/strings/functions/sha1.xml:1.2 Tue Nov 19 19:34:17 2002
+++ phpdoc/en/reference/strings/functions/sha1.xml Thu Feb 20 05:54:32 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.sha1">
<refnamediv>
<refname>sha1</refname>
@@ -10,12 +10,22 @@
<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;rfc3174.html">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>binary</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>
Index: phpdoc/en/reference/strings/functions/sha1-file.xml
diff -u phpdoc/en/reference/strings/functions/sha1-file.xml:1.1
phpdoc/en/reference/strings/functions/sha1-file.xml:1.2
--- phpdoc/en/reference/strings/functions/sha1-file.xml:1.1 Tue Nov 19 19:32:45
2002
+++ phpdoc/en/reference/strings/functions/sha1-file.xml Thu Feb 20 05:54:32 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.sha1-file">
<refnamediv>
<refname>sha1_file</refname>
@@ -10,13 +10,22 @@
<methodsynopsis>
<type>string</type><methodname>sha1_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam
+choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
</methodsynopsis>
<simpara>
Calculates the sha1 hash of <parameter>filename</parameter> using the
<ulink url="&url.rfc;rfc3174.html">US Secure Hash Algorithm 1</ulink>,
and returns that hash. The hash is a 40-character hexadecimal number.
- Upon failure, &false; is returned.
+ Upon failure, &false; is returned. 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_format</parameter> parameter was added in
+ PHP 5.0.0 and defaults to &false;
+ </simpara>
+ </note>
<simpara>
See also <function>sha1</function>, <function>crc32</function>,
and <function>md5_file</function>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
