reference/mysqli/mysqli/options.xml
fbb5e68567180d47b639b57adf196cc01889f4c6
fbb5e68567180d47b639b57adf196cc01889f4c6
...
...
@@ -10,17 +10,17 @@
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::options</methodname>
13
+
<methodsynopsis role="mysqli">
14
+
<modifier>public</modifier> <type>bool</type><methodname>mysqli::options</methodname>
15
15
<methodparam><type>int</type><parameter>option</parameter></methodparam>
16
-
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
16
+
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>value</parameter></methodparam>
17
17
</methodsynopsis>
18
18
<para>&style.procedural;</para>
19
19
<methodsynopsis>
20
20
<type>bool</type><methodname>mysqli_options</methodname>
21
-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
21
+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
22
22
<methodparam><type>int</type><parameter>option</parameter></methodparam>
23
-
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
23
+
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>value</parameter></methodparam>
24
24
</methodsynopsis>
25
25
<para>
26
26
Used to set extra connect options and affect behavior for a connection.
...
...
@@ -45,7 +45,7 @@
45
45
<listitem>
46
46
<para>
47
47
The option that you want to set. It can be one of the following values:
48
-
<table>
48
+
<table xml:id="mysqli.options.parameters">
49
49
<title>Valid options</title>
50
50
<tgroup cols="2">
51
51
<thead>
...
...
@@ -57,20 +57,29 @@
57
57
<tbody>
58
58
<row>
59
59
<entry><constant>MYSQLI_OPT_CONNECT_TIMEOUT</constant></entry>
60
-
<entry>connection timeout in seconds (supported on Windows with TCP/IP since PHP 5.3.1)</entry>
60
+
<entry>Connection timeout in seconds</entry>
61
+
</row>
62
+
<row>
63
+
<entry><constant>MYSQLI_OPT_READ_TIMEOUT</constant></entry>
64
+
<entry>Command execution result timeout in seconds. Available as of PHP 7.2.0.</entry>
61
65
</row>
62
66
<row>
63
67
<entry><constant>MYSQLI_OPT_LOCAL_INFILE</constant></entry>
64
-
<entry>enable/disable use of <literal>LOAD LOCAL INFILE</literal></entry>
68
+
<entry>Enable/disable use of <literal>LOAD LOCAL INFILE</literal></entry>
65
69
</row>
66
70
<row>
67
71
<entry><constant>MYSQLI_INIT_COMMAND</constant></entry>
68
-
<entry>command to execute after when connecting to MySQL server</entry>
72
+
<entry>Command to execute after when connecting to MySQL server</entry>
73
+
</row>
74
+
<row>
75
+
<entry><constant>MYSQLI_SET_CHARSET_NAME</constant></entry>
76
+
<entry>The charset to be set as default.</entry>
69
77
</row>
70
78
<row>
71
79
<entry><constant>MYSQLI_READ_DEFAULT_FILE</constant></entry>
72
80
<entry>
73
81
Read options from named option file instead of <filename>my.cnf</filename>
82
+
Not supported by mysqlnd.
74
83
</entry>
75
84
</row>
76
85
<row>
...
...
@@ -78,6 +87,7 @@
78
87
<entry>
79
88
Read options from the named group from <filename>my.cnf</filename>
80
89
or the file specified with <constant>MYSQL_READ_DEFAULT_FILE</constant>.
90
+
Not supported by mysqlnd.
81
91
</entry>
82
92
</row>
83
93
<row>
...
...
@@ -103,13 +113,14 @@
103
113
<row>
104
114
<entry><constant>MYSQLI_OPT_INT_AND_FLOAT_NATIVE</constant></entry>
105
115
<entry>
106
-
Convert integer and float columns back to PHP numbers. Only valid
107
-
for mysqlnd.
116
+
Convert integer and float columns back to PHP numbers when using non-prepared statements.
117
+
Only valid for mysqlnd.
108
118
</entry>
109
119
</row>
110
120
<row>
111
121
<entry><constant>MYSQLI_OPT_SSL_VERIFY_SERVER_CERT</constant></entry>
112
122
<entry>
123
+
Whether to verify server certificate or not.
113
124
</entry>
114
125
</row>
115
126
</tbody>
...
...
@@ -137,39 +148,9 @@
137
148
</para>
138
149
</refsect1>
139
150
140
-
<refsect1 role="changelog">
141
-
&reftitle.changelog;
142
-
<para>
143
-
<informaltable>
144
-
<tgroup cols="2">
145
-
<thead>
146
-
<row>
147
-
<entry>&Version;</entry>
148
-
<entry>&Description;</entry>
149
-
</row>
150
-
</thead>
151
-
<tbody>
152
-
<row>
153
-
<entry>5.5.0</entry>
154
-
<entry>
155
-
The <constant>MYSQLI_SERVER_PUBLIC_KEY</constant> and
156
-
<constant>MYSQLI_SERVER_PUBLIC_KEY</constant> options were added.
157
-
</entry>
158
-
</row>
159
-
<row>
160
-
<entry>5.3.0</entry>
161
-
<entry>
162
-
The <constant>MYSQLI_OPT_INT_AND_FLOAT_NATIVE</constant>,
163
-
<constant>MYSQLI_OPT_NET_CMD_BUFFER_SIZE</constant>,
164
-
<constant>MYSQLI_OPT_NET_READ_BUFFER_SIZE</constant>, and
165
-
<constant>MYSQLI_OPT_SSL_VERIFY_SERVER_CERT</constant> options were
166
-
added.
167
-
</entry>
168
-
</row>
169
-
</tbody>
170
-
</tgroup>
171
-
</informaltable>
172
-
</para>
151
+
<refsect1 role="errors">
152
+
&reftitle.errors;
153
+
&mysqli.conditionalexception;
173
154
</refsect1>
174
155
175
156
<refsect1 role="examples">
...
...
@@ -195,7 +176,6 @@
195
176
</refsect1>
196
177
197
178
</refentry>
198
-
199
179
<!-- Keep this comment at the end of the file
200
180
Local variables:
201
181
mode: sgml
202
182