File: mysqli.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (431 lines) | stat: -rw-r--r-- 19,579 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="mysqli" namespace="" name="mysqli">
  <member name="mysqli-&gt;affected_rows" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;connect_errno" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;connect_error" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;errno" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;error_list" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="array"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;error" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;field_count" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;client_info" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;client_version" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;host_info" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;protocol_version" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;server_info" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;server_version" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;info" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;insert_id" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="mixed"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;sqlstate" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="string"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;thread_id" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <member name="mysqli-&gt;warning_count" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style">Object oriented style</description>
      <var type="int"/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Open a new connection to the MySQL server">Object oriented style</description>
      <return type="void"/>
    </docblock>
    <parameter name="host" optional="true" byreference="false" type="string"/>
    <parameter name="username" optional="true" byreference="false" type="string"/>
    <parameter name="passwd" optional="true" byreference="false" type="string"/>
    <parameter name="dbname" optional="true" byreference="false" type="string"/>
    <parameter name="port" optional="true" byreference="false" type="int"/>
    <parameter name="socket" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="autocommit" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Turns on or off auto-committing database modifications">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="mode" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="change_user" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Changes the user of the specified database connection">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="user" optional="false" byreference="false" type="string"/>
    <parameter name="password" optional="false" byreference="false" type="string"/>
    <parameter name="database" optional="false" byreference="false" type="string"/>
  </method>
  <method name="character_set_name" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the default character set for the database connection">Object oriented style</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="close" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Closes a previously opened database connection">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="commit" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Commits the current transaction">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
    <parameter name="name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="connect" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Open a new connection to the MySQL server">Object oriented style</description>
      <return type="void"/>
    </docblock>
    <parameter name="host" optional="true" byreference="false" type="string"/>
    <parameter name="username" optional="true" byreference="false" type="string"/>
    <parameter name="passwd" optional="true" byreference="false" type="string"/>
    <parameter name="dbname" optional="true" byreference="false" type="string"/>
    <parameter name="port" optional="true" byreference="false" type="int"/>
    <parameter name="socket" optional="true" byreference="false" type="string"/>
  </method>
  <method name="debug" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Performs debugging operations">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="message" optional="false" byreference="false" type="string"/>
  </method>
  <method name="dump_debug_info" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Dump debugging information into the log">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="get_charset" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a character set object">Object oriented style</description>
      <return type="object"/>
    </docblock>
  </method>
  <method name="get_client_info" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get MySQL client info">Object oriented style</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="get_connection_stats" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns statistics about the client connection">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="get_server_info" abstract="false" static="false" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="get_warnings" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get result of SHOW WARNINGS">Object oriented style</description>
      <return type="mysqli_warning"/>
    </docblock>
  </method>
  <method name="init" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Initializes MySQLi and returns a resource for use with mysqli_real_connect()">Object oriented style</description>
      <return type="mysqli"/>
    </docblock>
  </method>
  <method name="kill" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Asks the server to kill a MySQL thread">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="processid" optional="false" byreference="false" type="int"/>
  </method>
  <method name="more_results" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Check if there are any more query results from a multi query">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="multi_query" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Performs a query on the database">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="next_result" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Prepare next result from multi_query">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="options" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Set options">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="option" optional="false" byreference="false" type="int"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="ping" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Pings a server connection, or tries to reconnect if the connection has gone down">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="poll" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Poll connections">Object oriented style</description>
      <return type="int"/>
    </docblock>
    <parameter name="read" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="error" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="reject" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="sec" optional="false" byreference="false" type="int"/>
    <parameter name="usec" optional="true" byreference="false" type="int"/>
  </method>
  <method name="prepare" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Prepare an SQL statement for execution">Object oriented style</description>
      <return type="mysqli_stmt"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="query" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Performs a query on the database">Object oriented style</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
    <parameter name="resultmode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="real_connect" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Opens a connection to a mysql server">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="host" optional="true" byreference="false" type="string"/>
    <parameter name="username" optional="true" byreference="false" type="string"/>
    <parameter name="passwd" optional="true" byreference="false" type="string"/>
    <parameter name="dbname" optional="true" byreference="false" type="string"/>
    <parameter name="port" optional="true" byreference="false" type="int"/>
    <parameter name="socket" optional="true" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </method>
  <method name="escape_string" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="escapestr" optional="false" byreference="false" type="string"/>
  </method>
  <method name="real_escape_string" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="escapestr" optional="false" byreference="false" type="string"/>
  </method>
  <method name="real_query" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Execute an SQL query">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="reap_async_query" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get result from async query">Object oriented style</description>
      <return type="mysqli_result"/>
    </docblock>
  </method>
  <method name="refresh" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Refreshes">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="options" optional="false" byreference="false" type="int"/>
  </method>
  <method name="rollback" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Rolls back current transaction">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
    <parameter name="name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="rpl_query_type" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns RPL query type">Object oriented style</description>
      <return type="int"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="select_db" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Selects the default database for database queries">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="dbname" optional="false" byreference="false" type="string"/>
  </method>
  <method name="send_query" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Send the query and return">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="set_charset" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the default client character set">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="charset" optional="false" byreference="false" type="string"/>
  </method>
  <method name="set_local_infile_handler" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Set callback function for LOAD DATA LOCAL INFILE command">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="link" optional="false" byreference="false" type="object" class="mysqli"/>
    <parameter name="read_func" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="ssl_set" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Used for establishing secure connections using SSL">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="cert" optional="false" byreference="false" type="string"/>
    <parameter name="ca" optional="false" byreference="false" type="string"/>
    <parameter name="capath" optional="false" byreference="false" type="string"/>
    <parameter name="cipher" optional="false" byreference="false" type="string"/>
  </method>
  <method name="stat" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Gets the current system status">Object oriented style</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="stmt_init" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Initializes a statement and returns an object for use with mysqli_stmt_prepare">Object oriented style</description>
      <return type="mysqli_stmt"/>
    </docblock>
  </method>
  <method name="store_result" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Transfers a result set from the last query">Object oriented style</description>
      <return type="mysqli_result"/>
    </docblock>
    <parameter name="option" optional="true" byreference="false" type="int"/>
  </method>
  <method name="use_result" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Initiate a result set retrieval">Object oriented style</description>
      <return type="mysqli_result"/>
    </docblock>
  </method>
</class>