reference/openssl/functions/openssl-pkey-export-to-file.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-export-to-file">
3
+
<refentry xml:id="function.openssl-pkey-export-to-file" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_pkey_export_to_file</refname>
6
6
<refpurpose>Gets an exportable representation of a key into a file </refpurpose>
...
...
@@ -10,15 +10,15 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_pkey_export_to_file</methodname>
13
-
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
16
-
<methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam>
13
+
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>key</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>passphrase</parameter><initializer>&null;</initializer></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
<function>openssl_pkey_export_to_file</function> saves an ascii-armoured
20
-
(PEM encoded) rendition of <parameter>key</parameter> into the file named
21
-
by <parameter>outfilename</parameter>.
20
+
(<acronym>PEM</acronym> encoded) rendition of <parameter>key</parameter> into the file named
21
+
by <parameter>output_filename</parameter>.
22
22
</para>
23
23
&note.openssl.cnf;
24
24
</refsect1>
...
...
@@ -35,7 +35,7 @@
35
35
</listitem>
36
36
</varlistentry>
37
37
<varlistentry>
38
-
<term><parameter>outfilename</parameter></term>
38
+
<term><parameter>output_filename</parameter></term>
39
39
<listitem>
40
40
<para>
41
41
Path to the output file.
...
...
@@ -52,13 +52,13 @@
52
52
</listitem>
53
53
</varlistentry>
54
54
<varlistentry>
55
-
<term><parameter>configargs</parameter></term>
55
+
<term><parameter>options</parameter></term>
56
56
<listitem>
57
57
<para>
58
-
<parameter>configargs</parameter> can be used to fine-tune the export
58
+
<parameter>options</parameter> can be used to fine-tune the export
59
59
process by specifying and/or overriding options for the openssl
60
60
configuration file. See <function>openssl_csr_new</function> for more
61
-
information about <parameter>configargs</parameter>.
61
+
information about <parameter>options</parameter>.
62
62
</para>
63
63
</listitem>
64
64
</varlistentry>
...
...
@@ -73,8 +73,31 @@
73
73
</para>
74
74
</refsect1>
75
75

76
+
<refsect1 role="changelog">
77
+
&reftitle.changelog;
78
+
<informaltable>
79
+
<tgroup cols="2">
80
+
<thead>
81
+
<row>
82
+
<entry>&Version;</entry>
83
+
<entry>&Description;</entry>
84
+
</row>
85
+
</thead>
86
+
<tbody>
87
+
<row>
88
+
<entry>8.0.0</entry>
89
+
<entry>
90
+
<parameter>key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
91
+
or <classname>OpenSSLCertificate</classname> instance now;
92
+
previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
93
+
was accepted.
94
+
</entry>
95
+
</row>
96
+
</tbody>
97
+
</tgroup>
98
+
</informaltable>
99
+
</refsect1>
76
100
</refentry>
77
-

78
101
<!-- Keep this comment at the end of the file
79
102
Local variables:
80
103
mode: sgml
81
104