reference/mhash/functions/mhash.xml
8a2141dcc084f72feb4e0ae2feaff3b440e5c59e
8a2141dcc084f72feb4e0ae2feaff3b440e5c59e
...
...
@@ -3,20 +3,24 @@
3
3
<refentry xml:id="function.mhash" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>mhash</refname>
6
-
<refpurpose>Compute hash</refpurpose>
6
+
<refpurpose>Computes hash</refpurpose>
7
7
</refnamediv>
8
8
9
+
<refsynopsisdiv>
10
+
&warn.deprecated.function-8-1-0;
11
+
</refsynopsisdiv>
12
+
9
13
<refsect1 role="description">
10
14
&reftitle.description;
11
15
<methodsynopsis>
12
-
<type>string</type><methodname>mhash</methodname>
13
-
<methodparam><type>int</type><parameter>hash</parameter></methodparam>
16
+
<type class="union"><type>string</type><type>false</type></type><methodname>mhash</methodname>
17
+
<methodparam><type>int</type><parameter>algo</parameter></methodparam>
14
18
<methodparam><type>string</type><parameter>data</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
19
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter><initializer>&null;</initializer></methodparam>
16
20
</methodsynopsis>
17
21
<para>
18
22
<function>mhash</function> applies a hash function specified by
19
-
<parameter>hash</parameter> to the <parameter>data</parameter>.
23
+
<parameter>algo</parameter> to the <parameter>data</parameter>.
20
24
</para>
21
25
</refsect1>
22
26
...
...
@@ -25,10 +29,10 @@
25
29
<para>
26
30
<variablelist>
27
31
<varlistentry>
28
-
<term><parameter>hash</parameter></term>
32
+
<term><parameter>algo</parameter></term>
29
33
<listitem>
30
34
<para>
31
-
The hash id. One of the <literal>MHASH_XXX</literal> constants.
35
+
The hash ID. One of the <constant>MHASH_hashname</constant> constants.
32
36
</para>
33
37
</listitem>
34
38
</varlistentry>
...
...
@@ -59,11 +63,42 @@
59
63
&reftitle.returnvalues;
60
64
<para>
61
65
Returns the resulting hash (also called digest) or HMAC as a string, or
62
-
&false; on errors.
66
+
&false; on error.
63
67
</para>
64
68
</refsect1>
65
-
</refentry>
66
69
70
+
<refsect1 role="changelog">
71
+
&reftitle.changelog;
72
+
<para>
73
+
<informaltable>
74
+
<tgroup cols="2">
75
+
<thead>
76
+
<row>
77
+
<entry>&Version;</entry>
78
+
<entry>&Description;</entry>
79
+
</row>
80
+
</thead>
81
+
<tbody>
82
+
<row>
83
+
<entry>8.1.0</entry>
84
+
<entry>
85
+
This function has been deprecated.
86
+
Use the <link linkend="ref.hash"><literal>hash_*()</literal> functions</link> instead.
87
+
</entry>
88
+
</row>
89
+
<row>
90
+
<entry>8.0.0</entry>
91
+
<entry>
92
+
<parameter>key</parameter> is now nullable.
93
+
</entry>
94
+
</row>
95
+
</tbody>
96
+
</tgroup>
97
+
</informaltable>
98
+
</para>
99
+
</refsect1>
100
+
101
+
</refentry>
67
102
<!-- Keep this comment at the end of the file
68
103
Local variables:
69
104
mode: sgml
70
105