reference/mysqli/mysqli/ssl-set.xml
497c40ac164d5873fd87f622dfdeb5206392b446
...
...
@@ -10,23 +10,23 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<para>&style.oop;</para>
13
-
<methodsynopsis role="oop">
14
-
<type>bool</type><methodname>mysqli::ssl_set</methodname>
15
-
<methodparam><type>string</type><parameter>key</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
17
-
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
18
-
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
19
-
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
13
+
<methodsynopsis role="mysqli">
14
+
<modifier>public</modifier> <type>true</type><methodname>mysqli::ssl_set</methodname>
15
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter></methodparam>
16
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>certificate</parameter></methodparam>
17
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_certificate</parameter></methodparam>
18
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_path</parameter></methodparam>
19
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>cipher_algos</parameter></methodparam>
20
20
</methodsynopsis>
21
21
<para>&style.procedural;</para>
22
22
<methodsynopsis>
23
-
<type>bool</type><methodname>mysqli_ssl_set</methodname>
24
-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
25
-
<methodparam><type>string</type><parameter>key</parameter></methodparam>
26
-
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
27
-
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
28
-
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
29
-
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
23
+
<type>true</type><methodname>mysqli_ssl_set</methodname>
24
+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
25
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter></methodparam>
26
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>certificate</parameter></methodparam>
27
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_certificate</parameter></methodparam>
28
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_path</parameter></methodparam>
29
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>cipher_algos</parameter></methodparam>
30
30
</methodsynopsis>
31
31
<para>
32
32
Used for establishing secure connections using SSL. It must be called
...
...
@@ -34,13 +34,6 @@
34
34
nothing unless OpenSSL support is enabled.
35
35
</para>
36
36

37
-
<para>
38
-
Note that MySQL Native Driver does not support SSL before PHP 5.3.3,
39
-
so calling this function when using MySQL Native Driver will result
40
-
in an error. MySQL Native Driver is enabled by default on Microsoft
41
-
Windows from PHP version 5.3 onwards.
42
-
</para>
43
-

44
37
</refsect1>
45
38

46
39
<refsect1 role="parameters">
...
...
@@ -57,7 +50,7 @@
57
50
</listitem>
58
51
</varlistentry>
59
52
<varlistentry>
60
-
<term><parameter>cert</parameter></term>
53
+
<term><parameter>certificate</parameter></term>
61
54
<listitem>
62
55
<para>
63
56
The path name to the certificate file.
...
...
@@ -65,7 +58,7 @@
65
58
</listitem>
66
59
</varlistentry>
67
60
<varlistentry>
68
-
<term><parameter>ca</parameter></term>
61
+
<term><parameter>ca_certificate</parameter></term>
69
62
<listitem>
70
63
<para>
71
64
The path name to the certificate authority file.
...
...
@@ -73,16 +66,16 @@
73
66
</listitem>
74
67
</varlistentry>
75
68
<varlistentry>
76
-
<term><parameter>capath</parameter></term>
69
+
<term><parameter>ca_path</parameter></term>
77
70
<listitem>
78
71
<para>
79
72
The pathname to a directory that contains trusted SSL CA certificates
80
-
in PEM format.
73
+
in <acronym>PEM</acronym> format.
81
74
</para>
82
75
</listitem>
83
76
</varlistentry>
84
77
<varlistentry>
85
-
<term><parameter>cipher</parameter></term>
78
+
<term><parameter>cipher_algos</parameter></term>
86
79
<listitem>
87
80
<para>
88
81
A list of allowable ciphers to use for SSL encryption.
...
...
@@ -91,15 +84,12 @@
91
84
</varlistentry>
92
85
</variablelist>
93
86
</para>
94
-
<para>
95
-
Any unused SSL parameters may be given as &null;
96
-
</para>
97
87
</refsect1>
98
88

99
89
<refsect1 role="returnvalues">
100
90
&reftitle.returnvalues;
101
91
<para>
102
-
This function always returns &true; value. If SSL setup is
92
+
&return.true.always; If SSL setup is
103
93
incorrect <function>mysqli_real_connect</function> will return an error
104
94
when you attempt to connect.
105
95
</para>
...
...
@@ -116,7 +106,6 @@
116
106
</refsect1>
117
107

118
108
</refentry>
119
-

120
109
<!-- Keep this comment at the end of the file
121
110
Local variables:
122
111
mode: sgml
123
112