reference/phar/PharData/setSignatureAlgorithm.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -2,15 +2,16 @@
2
2
<!-- $Revision$ -->
3
3
<refentry xml:id="phardata.setsignaturealgorithm" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
<refnamediv>
5
-
<refname>Phar::setSignatureAlgorithm</refname>
6
-
<refpurpose>set the signature algorithm for a phar and apply it.</refpurpose>
5
+
<refname>PharData::setSignatureAlgorithm</refname>
6
+
<refpurpose>Set the signature algorithm for a phar and apply it</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
12
-
<modifier>public</modifier> <type>void</type><methodname>Phar::setSignatureAlgorithm</methodname>
13
-
<methodparam><type>int</type><parameter>sigtype</parameter></methodparam>
11
+
<methodsynopsis role="PharData">
12
+
<modifier>public</modifier> <type>void</type><methodname>PharData::setSignatureAlgorithm</methodname>
13
+
<methodparam><type>int</type><parameter>algo</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>privateKey</parameter><initializer>&null;</initializer></methodparam>
14
15
</methodsynopsis>
15
16
&phar.write;
16
17
...
...
@@ -18,8 +19,7 @@
18
19
Set the signature algorithm for a phar and apply it. The
19
20
signature algorithm must be one of <literal>Phar::MD5</literal>,
20
21
<literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>,
21
-
<literal>Phar::SHA512</literal>, or <literal>Phar::PGP</literal>
22
-
(pgp not yet supported and falls back to SHA-1).
22
+
<literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>.
23
23
</para>
24
24
</refsect1>
25
25
...
...
@@ -28,12 +28,12 @@
28
28
<para>
29
29
<variablelist>
30
30
<varlistentry>
31
-
<term><parameter>sigtype</parameter></term>
31
+
<term><parameter>algo</parameter></term>
32
32
<listitem>
33
33
<para>
34
34
One of <literal>Phar::MD5</literal>,
35
35
<literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>,
36
-
<literal>Phar::SHA512</literal>, or <literal>Phar::PGP</literal>
36
+
<literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>
37
37
</para>
38
38
</listitem>
39
39
</varlistentry>
...
...
@@ -59,6 +59,28 @@
59
59
</para>
60
60
</refsect1>
61
61
62
+
<refsect1 role="changelog">
63
+
&reftitle.changelog;
64
+
<informaltable>
65
+
<tgroup cols="2">
66
+
<thead>
67
+
<row>
68
+
<entry>&Version;</entry>
69
+
<entry>&Description;</entry>
70
+
</row>
71
+
</thead>
72
+
<tbody>
73
+
<row>
74
+
<entry>8.0.0</entry>
75
+
<entry>
76
+
<parameter>privateKey</parameter> is now nullable.
77
+
</entry>
78
+
</row>
79
+
</tbody>
80
+
</tgroup>
81
+
</informaltable>
82
+
</refsect1>
83
+
62
84
<refsect1 role="seealso">
63
85
&reftitle.seealso;
64
86
<para>
...
...
@@ -70,7 +92,6 @@
70
92
</refsect1>
71
93
72
94
</refentry>
73
-
74
95
<!-- Keep this comment at the end of the file
75
96
Local variables:
76
97
mode: sgml
77
98