reference/mhash/functions/mhash-get-block-size.xml
8a2141dcc084f72feb4e0ae2feaff3b440e5c59e
8a2141dcc084f72feb4e0ae2feaff3b440e5c59e
...
...
@@ -3,17 +3,21 @@
3
3
<refentry xml:id="function.mhash-get-block-size" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>mhash_get_block_size</refname>
6
-
<refpurpose>Get the block size of the specified hash</refpurpose>
6
+
<refpurpose>Gets the block size of the specified 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>int</type><methodname>mhash_get_block_size</methodname>
13
-
<methodparam><type>int</type><parameter>hash</parameter></methodparam>
16
+
<type class="union"><type>int</type><type>false</type></type><methodname>mhash_get_block_size</methodname>
17
+
<methodparam><type>int</type><parameter>algo</parameter></methodparam>
14
18
</methodsynopsis>
15
19
<para>
16
-
Gets the size of a block of the specified <parameter>hash</parameter>.
20
+
Gets the size of a block of the specified <parameter>algo</parameter>.
17
21
</para>
18
22
</refsect1>
19
23
...
...
@@ -22,10 +26,10 @@
22
26
<para>
23
27
<variablelist>
24
28
<varlistentry>
25
-
<term><parameter>hash</parameter></term>
29
+
<term><parameter>algo</parameter></term>
26
30
<listitem>
27
31
<para>
28
-
The hash id. One of the <literal>MHASH_XXX</literal> constants.
32
+
The hash ID. One of the <constant>MHASH_hashname</constant> constants.
29
33
</para>
30
34
</listitem>
31
35
</varlistentry>
...
...
@@ -36,11 +40,36 @@
36
40
<refsect1 role="returnvalues">
37
41
&reftitle.returnvalues;
38
42
<para>
39
-
Returns the size in bytes or &false;, if the <parameter>hash</parameter>
43
+
Returns the size in bytes or &false;, if the <parameter>algo</parameter>
40
44
does not exist.
41
45
</para>
42
46
</refsect1>
43
47
48
+
<refsect1 role="changelog">
49
+
&reftitle.changelog;
50
+
<para>
51
+
<informaltable>
52
+
<tgroup cols="2">
53
+
<thead>
54
+
<row>
55
+
<entry>&Version;</entry>
56
+
<entry>&Description;</entry>
57
+
</row>
58
+
</thead>
59
+
<tbody>
60
+
<row>
61
+
<entry>8.1.0</entry>
62
+
<entry>
63
+
This function has been deprecated.
64
+
Use the <link linkend="ref.hash"><literal>hash_*()</literal> functions</link> instead.
65
+
</entry>
66
+
</row>
67
+
</tbody>
68
+
</tgroup>
69
+
</informaltable>
70
+
</para>
71
+
</refsect1>
72
+
44
73
<refsect1 role="examples">
45
74
&reftitle.examples;
46
75
<para>
...
...
@@ -59,7 +88,6 @@ echo mhash_get_block_size(MHASH_MD5); // 16
59
88
</para>
60
89
</refsect1>
61
90
</refentry>
62
-
63
91
<!-- Keep this comment at the end of the file
64
92
Local variables:
65
93
mode: sgml
66
94