reference/openssl/functions/openssl-csr-export-to-file.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -1,23 +1,24 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-csr-export-to-file">
3
+
<refentry xml:id="function.openssl-csr-export-to-file" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_csr_export_to_file</refname>
6
-
<refpurpose>Exports a CSR to a file</refpurpose>
6
+
<refpurpose>Exports a <acronym>CSR</acronym> to a file</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>openssl_csr_export_to_file</methodname>
13
-
<methodparam><type>mixed</type><parameter>csr</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
15
-
<methodparam choice="opt"><type>bool</type><parameter>notext</parameter><initializer>true</initializer></methodparam>
13
+
<methodparam><type class="union"><type>OpenSSLCertificateSigningRequest</type><type>string</type></type><parameter>csr</parameter></methodparam>
14
+
<methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
15
+
<methodparam choice="opt"><type>bool</type><parameter>no_text</parameter><initializer>&true;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
<function>openssl_csr_export_to_file</function> takes the Certificate
19
19
Signing Request represented by <parameter>csr</parameter> and saves it
20
-
in PEM format into the file named by <parameter>outfilename</parameter>.
20
+
in <acronym>PEM</acronym> format into the file named by
21
+
<parameter>output_filename</parameter>.
21
22
</para>
22
23
</refsect1>
23
24

...
...
@@ -27,7 +28,7 @@
27
28
<variablelist>
28
29
&openssl.param.csr;
29
30
<varlistentry>
30
-
<term><parameter>outfilename</parameter></term>
31
+
<term><parameter>output_filename</parameter></term>
31
32
<listitem>
32
33
<para>
33
34
Path to the output file.
...
...
@@ -35,7 +36,7 @@
35
36
</listitem>
36
37
</varlistentry>
37
38
<varlistentry>
38
-
<term><parameter>notext</parameter></term>
39
+
<term><parameter>no_text</parameter></term>
39
40
<listitem>
40
41
&note.openssl.param-notext;
41
42
</listitem>
...
...
@@ -51,6 +52,29 @@
51
52
</para>
52
53
</refsect1>
53
54

55
+
<refsect1 role="changelog">
56
+
&reftitle.changelog;
57
+
<informaltable>
58
+
<tgroup cols="2">
59
+
<thead>
60
+
<row>
61
+
<entry>&Version;</entry>
62
+
<entry>&Description;</entry>
63
+
</row>
64
+
</thead>
65
+
<tbody>
66
+
<row>
67
+
<entry>8.0.0</entry>
68
+
<entry>
69
+
<parameter>csr</parameter> accepts an <classname>OpenSSLCertificateSigningRequest</classname> instance now;
70
+
previously, a &resource; of type <literal>OpenSSL X.509 CSR</literal> was accepted.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+

54
78
<refsect1 role="examples">
55
79
&reftitle.examples;
56
80
<para>
...
...
@@ -89,7 +113,6 @@ openssl_csr_export_to_file($csr, 'example-csr.pem');
89
113
</refsect1>
90
114

91
115
</refentry>
92
-

93
116
<!-- Keep this comment at the end of the file
94
117
Local variables:
95
118
mode: sgml
96
119