reference/openssl/functions/openssl-digest.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="function.openssl-digest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>openssl_digest</refname>
...
...
@@ -10,18 +9,16 @@
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
11
<methodsynopsis>
13
-
<type>string</type><methodname>openssl_digest</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_digest</methodname>
14
13
<methodparam><type>string</type><parameter>data</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>method</parameter></methodparam>
16
-
<methodparam choice="opt"><type>bool</type><parameter>raw_output</parameter><initializer>false</initializer></methodparam>
14
+
<methodparam><type>string</type><parameter>digest_algo</parameter></methodparam>
15
+
<methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
17
16
</methodsynopsis>
18
17
<para>
19
18
Computes a digest hash value for the given data using a given method,
20
19
and returns a raw or binhex encoded string.
21
20
</para>
22
21

23
-
&warn.undocumented.func;
24
-

25
22
</refsect1>
26
23

27
24
<refsect1 role="parameters">
...
...
@@ -37,7 +34,7 @@
37
34
</listitem>
38
35
</varlistentry>
39
36
<varlistentry>
40
-
<term><parameter>method</parameter></term>
37
+
<term><parameter>digest_algo</parameter></term>
41
38
<listitem>
42
39
<para>
43
40
The digest method to use, e.g. "sha256", see <function>openssl_get_md_methods</function> for a list of available digest methods.
...
...
@@ -45,7 +42,7 @@
45
42
</listitem>
46
43
</varlistentry>
47
44
<varlistentry>
48
-
<term><parameter>raw_output</parameter></term>
45
+
<term><parameter>binary</parameter></term>
49
46
<listitem>
50
47
<para>
51
48
Setting to &true; will return as raw output data, otherwise the return
...
...
@@ -68,7 +65,7 @@
68
65
&reftitle.errors;
69
66
<para>
70
67
Emits an <constant>E_WARNING</constant> level error if an unknown signature algorithm
71
-
is passed via the <parameter>method</parameter> parameter.
68
+
is passed via the <parameter>digest_algo</parameter> parameter.
72
69
</para>
73
70
</refsect1>
74
71

...
...
@@ -82,7 +79,6 @@
82
79
</refsect1>
83
80

84
81
</refentry>
85
-

86
82
<!-- Keep this comment at the end of the file
87
83
Local variables:
88
84
mode: sgml
89
85