reference/openssl/functions/openssl-csr-export.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -1,23 +1,23 @@
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">
3
+
<refentry xml:id="function.openssl-csr-export" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_csr_export</refname>
6
-
<refpurpose>Exports a CSR as a string</refpurpose>
6
+
<refpurpose>Exports a <acronym>CSR</acronym> as a string</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</methodname>
13
-
<methodparam><type>mixed</type><parameter>csr</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter role="reference">out</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 role="reference">output</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</function> takes the Certificate Signing
19
19
Request represented by <parameter>csr</parameter> and stores it in
20
-
PEM format in <parameter>out</parameter>, which is passed by
20
+
<acronym>PEM</acronym> format in <parameter>output</parameter>, which is passed by
21
21
reference.
22
22
</para>
23
23
</refsect1>
...
...
@@ -28,15 +28,16 @@
28
28
<variablelist>
29
29
&openssl.param.csr;
30
30
<varlistentry>
31
-
<term><parameter>out</parameter></term>
31
+
<term><parameter>output</parameter></term>
32
32
<listitem>
33
33
<para>
34
-
on success, this string will contain the PEM encoded CSR
34
+
on success, this string will contain the <acronym>PEM</acronym>
35
+
encoded <acronym>CSR</acronym>
35
36
</para>
36
37
</listitem>
37
38
</varlistentry>
38
39
<varlistentry>
39
-
<term><parameter>notext</parameter></term>
40
+
<term><parameter>no_text</parameter></term>
40
41
<listitem>
41
42
&note.openssl.param-notext;
42
43
</listitem>
...
...
@@ -52,6 +53,29 @@
52
53
</para>
53
54
</refsect1>
54
55

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

55
79
<refsect1 role="examples">
56
80
&reftitle.examples;
57
81
<para>
...
...
@@ -92,7 +116,6 @@ echo $csr_string;
92
116
</refsect1>
93
117

94
118
</refentry>
95
-

96
119
<!-- Keep this comment at the end of the file
97
120
Local variables:
98
121
mode: sgml
99
122