reference/mysqli/mysqli/get-client-info.xml
035c126c0393fe154bac46e2c3c489ebadce48a5
...
...
@@ -1,42 +1,81 @@
1
-
<?xml version="1.0" encoding="iso-8859-1"?>
1
+
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
3
<refentry xml:id="mysqli.get-client-info" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
+
<refname>mysqli::$client_info</refname>
5
6
<refname>mysqli::get_client_info</refname>
6
7
<refname>mysqli_get_client_info</refname>
7
-
<refpurpose>Returns the MySQL client version as a string</refpurpose>
8
+
<refpurpose>Get MySQL client info</refpurpose>
8
9
</refnamediv>
9
10

10
11
<refsect1 role="description">
11
12
&reftitle.description;
12
-
<methodsynopsis>
13
-
<type>string</type><methodname>mysqli::get_client_info</methodname>
14
-
<void />
13
+
<para>&style.oop;</para>
14
+
<fieldsynopsis><type>string</type><varname linkend="mysqli.get-client-info">mysqli-&gt;client_info</varname></fieldsynopsis>
15
+
<methodsynopsis role="mysqli">
16
+
<modifier>public</modifier> <type>string</type><methodname>mysqli::get_client_info</methodname>
17
+
<void/>
15
18
</methodsynopsis>
19
+
<para>&style.procedural;</para>
16
20
<methodsynopsis>
17
21
<type>string</type><methodname>mysqli_get_client_info</methodname>
18
-
<void />
22
+
<methodparam choice="opt"><type class="union"><type>mysqli</type><type>null</type></type><parameter>mysql</parameter><initializer>&null;</initializer></methodparam>
19
23
</methodsynopsis>
20
24
<para>
21
-
The <function>mysqli_get_client_info</function> function is used to
22
-
return a string representing the client version being used in the
23
-
MySQLi extension.
25
+
Returns a string that represents the MySQL client library version.
24
26
</para>
25
27
</refsect1>
26
28

29
+
<refsect1 role="parameters">
30
+
&reftitle.parameters;
31
+
&no.function.parameters;
32
+
</refsect1>
33
+

27
34
<refsect1 role="returnvalues">
28
35
&reftitle.returnvalues;
29
36
<para>
30
-
A string that represents the MySQL client library version
37
+
A string that represents the MySQL client library version.
31
38
</para>
32
39
</refsect1>
33
40

41
+
<refsect1 role="changelog">
42
+
&reftitle.changelog;
43
+
<informaltable>
44
+
<tgroup cols="2">
45
+
<thead>
46
+
<row>
47
+
<entry>&Version;</entry>
48
+
<entry>&Description;</entry>
49
+
</row>
50
+
</thead>
51
+
<tbody>
52
+
<row>
53
+
<entry>8.1.0</entry>
54
+
<entry>
55
+
Calling <function>mysqli_get_client_info</function> with the
56
+
<parameter>mysql</parameter> argument has been deprecated.
57
+
This function never required a parameter, but incorrectly allowed it as
58
+
an optional parameter.
59
+
</entry>
60
+
</row>
61
+
<row>
62
+
<entry>8.1.0</entry>
63
+
<entry>
64
+
The object-oriented style <methodname>mysqli::get_client_info</methodname>
65
+
has been deprecated.
66
+
</entry>
67
+
</row>
68
+
</tbody>
69
+
</tgroup>
70
+
</informaltable>
71
+
</refsect1>
72
+

34
73
<refsect1 role="examples">
35
74
&reftitle.examples;
36
75
<para>
37
76
<example>
38
77
<title>mysqli_get_client_info</title>
39
-
<programlisting role='php'>
78
+
<programlisting role="php">
40
79
<![CDATA[
41
80
<?php
42
81

...
...
@@ -63,7 +102,6 @@ printf("Client library version: %s\n", mysqli_get_client_info());
63
102
</refsect1>
64
103

65
104
</refentry>
66
-

67
105
<!-- Keep this comment at the end of the file
68
106
Local variables:
69
107
mode: sgml
70
108