reference/openssl/functions/openssl-x509-read.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
...
...
@@ -1,21 +1,21 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-x509-read">
3
+
<refentry xml:id="function.openssl-x509-read" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_x509_read</refname>
6
-
<refpurpose>Parse an X.509 certificate and return a resource identifier for
6
+
<refpurpose>Parse an X.509 certificate and return an object for
7
7
it</refpurpose>
8
8
</refnamediv>
9
9
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
-
<type>resource</type><methodname>openssl_x509_read</methodname>
14
-
<methodparam><type>mixed</type><parameter>x509certdata</parameter></methodparam>
13
+
<type class="union"><type>OpenSSLCertificate</type><type>false</type></type><methodname>openssl_x509_read</methodname>
14
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>openssl_x509_read</function> parses the certificate supplied by
18
-
<parameter>x509certdata</parameter> and returns a resource identifier for
18
+
<parameter>certificate</parameter> and returns an <classname>OpenSSLCertificate</classname> object for
19
19
it.
20
20
</para>
21
21
</refsect1>
...
...
@@ -25,7 +25,7 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>x509certdata</parameter></term>
28
+
<term><parameter>certificate</parameter></term>
29
29
<listitem>
30
30
<para>
31
31
X509 certificate. See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
...
...
@@ -39,12 +39,40 @@
39
39
<refsect1 role="returnvalues">
40
40
&reftitle.returnvalues;
41
41
<para>
42
-
Returns a resource identifier on success&return.falseforfailure;.
42
+
Returns an <classname>OpenSSLCertificate</classname> on success&return.falseforfailure;.
43
43
</para>
44
44
</refsect1>
45
45

46
+
<refsect1 role="changelog">
47
+
&reftitle.changelog;
48
+
<informaltable>
49
+
<tgroup cols="2">
50
+
<thead>
51
+
<row>
52
+
<entry>&Version;</entry>
53
+
<entry>&Description;</entry>
54
+
</row>
55
+
</thead>
56
+
<tbody>
57
+
<row>
58
+
<entry>8.0.0</entry>
59
+
<entry>
60
+
On success, this function returns an <classname>OpenSSLCertificate</classname> instance now;
61
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was returned.
62
+
</entry>
63
+
</row>
64
+
<row>
65
+
<entry>8.0.0</entry>
66
+
<entry>
67
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
68
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
69
+
</entry>
70
+
</row>
71
+
</tbody>
72
+
</tgroup>
73
+
</informaltable>
74
+
</refsect1>
46
75
</refentry>
47
-

48
76
<!-- Keep this comment at the end of the file
49
77
Local variables:
50
78
mode: sgml
51
79