Skip to content

Commit dbfcc91

Browse files
GirgiasGirgias
committed
PHP 8.4: Start documenting Pdo\Mysql class
1 parent ae5ceaf commit dbfcc91

File tree

6 files changed

+635
-114
lines changed

6 files changed

+635
-114
lines changed

‎reference/pdo_mysql/configure.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,14 @@ $ ./configure --with-pdo-mysql --with-mysql-sock=/var/mysql/mysql.sock
4848
</screen>
4949
</para>
5050
<para>
51-
SSL support is enabled using the appropriate <link linkend="pdo-mysql.constants">PDO_MySQL constants</link>,
52-
which is equivalent to calling the <link xlink:href="&url.mysql.docs.ssl.set;">MySQL C API function mysql_ssl_set()</link>.
53-
Also, SSL cannot be enabled with <classname>PDO::setAttribute</classname> because the connection
54-
already exists. See also the MySQL documentation about <link xlink:href="&url.mysql.docs.ssl.using;">connecting to
55-
MySQL with SSL</link>.
51+
<acronym>SSL</acronym> support is enabled using the appropriate
52+
<constant>Pdo\Mysql::ATTR_SSL_<replaceable>*</replaceable></constant>,
53+
which is equivalent to calling the
54+
<link xlink:href="&url.mysql.docs.ssl.set;">MySQL C API function mysql_ssl_set()</link>.
55+
Also, SSL cannot be enabled with <methodname>PDO::setAttribute</methodname>
56+
because the connection already exists.
57+
See also the MySQL documentation about
58+
<link xlink:href="&url.mysql.docs.ssl.using;">connecting to MySQL with SSL</link>.
5659
</para>
5760

5861
</section>

‎reference/pdo_mysql/constants.xml

Lines changed: 53 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<section xml:id="pdo-mysql.constants" xmlns="http://docbook.org/ns/docbook">
3+
<section xml:id="ref.pdo-mysql.constants" xmlns="http://docbook.org/ns/docbook">
44
&reftitle.constants;
55
&pdo.driver-constants;
66
<variablelist>
@@ -11,29 +11,8 @@
1111
</term>
1212
<listitem>
1313
<simpara>
14-
By default all statements are executed in
15-
<link linkend="mysqlinfo.concepts.buffering">buffered mode</link>.
16-
If this attribute is set to &false; on a
17-
<classname>PDO</classname> object, the MySQL driver will use the
18-
unbuffered mode.
14+
&Alias; <constant>Pdo\Mysql::ATTR_USE_BUFFERED_QUERY</constant>
1915
</simpara>
20-
<para>
21-
<example><title>Setting MySQL unbuffered mode</title>
22-
<programlisting role="php">
23-
<![CDATA[
24-
<?php
25-
$pdo = new PDO("mysql:host=localhost;dbname=world", 'my_user', 'my_password');
26-
$pdo->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
27-
28-
$unbufferedResult = $pdo->query("SELECT Name FROM City");
29-
foreach ($unbufferedResult as $row) {
30-
echo $row['Name'] . PHP_EOL;
31-
}
32-
?>
33-
]]>
34-
</programlisting>
35-
</example>
36-
</para>
3716
</listitem>
3817
</varlistentry>
3918
<varlistentry xml:id="pdo.constants.mysql-attr-local-infile">
@@ -42,13 +21,9 @@ foreach ($unbufferedResult as $row) {
4221
(<type>int</type>)
4322
</term>
4423
<listitem>
45-
<para>
46-
Enable <literal>LOAD LOCAL INFILE</literal>.
47-
</para>
48-
<para>
49-
Note, this constant can only be used in the <parameter>driver_options</parameter>
50-
array when constructing a new database handle.
51-
</para>
24+
<simpara>
25+
&Alias; <constant>Pdo\Mysql::ATTR_LOCAL_INFILE</constant>
26+
</simpara>
5227
</listitem>
5328
</varlistentry>
5429
<varlistentry xml:id="pdo.constants.mysql-attr-local-infile-directory">
@@ -57,14 +32,9 @@ foreach ($unbufferedResult as $row) {
5732
(<type>string</type>)
5833
</term>
5934
<listitem>
60-
<para>
61-
Allows restricting LOCAL DATA loading to files located in this designated
62-
directory. Available as of PHP 8.1.0.
63-
</para>
64-
<para>
65-
Note, this constant can only be used in the <parameter>driver_options</parameter>
66-
array when constructing a new database handle.
67-
</para>
35+
<simpara>
36+
&Alias; <constant>Pdo\Mysql::ATTR_LOCAL_INFILE_DIRECTORY</constant>
37+
</simpara>
6838
</listitem>
6939
</varlistentry>
7040
<varlistentry xml:id="pdo.constants.mysql-attr-init-command">
@@ -73,14 +43,9 @@ foreach ($unbufferedResult as $row) {
7343
(<type>string</type>)
7444
</term>
7545
<listitem>
76-
<para>
77-
Command to execute when connecting to the MySQL server. Will
78-
automatically be re-executed when reconnecting.
79-
</para>
80-
<para>
81-
Note, this constant can only be used in the <parameter>driver_options</parameter>
82-
array when constructing a new database handle.
83-
</para>
46+
<simpara>
47+
&Alias; <constant>Pdo\Mysql::ATTR_INIT_COMMAND</constant>
48+
</simpara>
8449
</listitem>
8550
</varlistentry>
8651
<varlistentry xml:id="pdo.constants.mysql-attr-read-default-file">
@@ -89,12 +54,9 @@ foreach ($unbufferedResult as $row) {
8954
(<type>int</type>)
9055
</term>
9156
<listitem>
92-
<para>
93-
Read options from the named option file instead of from
94-
<filename>my.cnf</filename>. This option is not available if
95-
mysqlnd is used, because mysqlnd does not read the mysql
96-
configuration files.
97-
</para>
57+
<simpara>
58+
&Alias; <constant>Pdo\Mysql::ATTR_READ_DEFAULT_FILE</constant>
59+
</simpara>
9860
</listitem>
9961
</varlistentry>
10062
<varlistentry xml:id="pdo.constants.mysql-attr-read-default-group">
@@ -103,12 +65,9 @@ foreach ($unbufferedResult as $row) {
10365
(<type>int</type>)
10466
</term>
10567
<listitem>
106-
<para>
107-
Read options from the named group from <filename>my.cnf</filename> or the
108-
file specified with <constant>MYSQL_READ_DEFAULT_FILE</constant>. This option
109-
is not available if mysqlnd is used, because mysqlnd does not read the mysql
110-
configuration files.
111-
</para>
68+
<simpara>
69+
&Alias; <constant>Pdo\Mysql::ATTR_READ_DEFAULT_GROUP</constant>
70+
</simpara>
11271
</listitem>
11372
</varlistentry>
11473
<varlistentry xml:id="pdo.constants.mysql-attr-max-buffer-size">
@@ -117,10 +76,9 @@ foreach ($unbufferedResult as $row) {
11776
(<type>int</type>)
11877
</term>
11978
<listitem>
120-
<para>
121-
Maximum buffer size. Defaults to 1 MiB. This constant is not supported when
122-
compiled against mysqlnd.
123-
</para>
79+
<simpara>
80+
&Alias; <constant>Pdo\Mysql::ATTR_MAX_BUFFER_SIZE</constant>
81+
</simpara>
12482
</listitem>
12583
</varlistentry>
12684
<varlistentry xml:id="pdo.constants.mysql-attr-direct-query">
@@ -129,9 +87,9 @@ foreach ($unbufferedResult as $row) {
12987
(<type>int</type>)
13088
</term>
13189
<listitem>
132-
<para>
133-
Perform direct queries, don't use prepared statements.
134-
</para>
90+
<simpara>
91+
&Alias; <constant>Pdo\Mysql::ATTR_DIRECT_QUERY</constant>
92+
</simpara>
13593
</listitem>
13694
</varlistentry>
13795
<varlistentry xml:id="pdo.constants.mysql-attr-found-rows">
@@ -140,10 +98,9 @@ foreach ($unbufferedResult as $row) {
14098
(<type>int</type>)
14199
</term>
142100
<listitem>
143-
<para>
144-
Return the number of found (matched) rows, not the
145-
number of changed rows.
146-
</para>
101+
<simpara>
102+
&Alias; <constant>Pdo\Mysql::ATTR_FOUND_ROWS</constant>
103+
</simpara>
147104
</listitem>
148105
</varlistentry>
149106
<varlistentry xml:id="pdo.constants.mysql-attr-ignore-space">
@@ -152,10 +109,9 @@ foreach ($unbufferedResult as $row) {
152109
(<type>int</type>)
153110
</term>
154111
<listitem>
155-
<para>
156-
Permit spaces after function names. Makes all functions
157-
names reserved words.
158-
</para>
112+
<simpara>
113+
&Alias; <constant>Pdo\Mysql::ATTR_IGNORE_SPACE</constant>
114+
</simpara>
159115
</listitem>
160116
</varlistentry>
161117
<varlistentry xml:id="pdo.constants.mysql-attr-compress">
@@ -164,9 +120,9 @@ foreach ($unbufferedResult as $row) {
164120
(<type>int</type>)
165121
</term>
166122
<listitem>
167-
<para>
168-
Enable network communication compression.
169-
</para>
123+
<simpara>
124+
&Alias; <constant>Pdo\Mysql::ATTR_COMPRESS</constant>
125+
</simpara>
170126
</listitem>
171127
</varlistentry>
172128

@@ -176,9 +132,9 @@ foreach ($unbufferedResult as $row) {
176132
(<type>int</type>)
177133
</term>
178134
<listitem>
179-
<para>
180-
The file path to the SSL certificate authority.
181-
</para>
135+
<simpara>
136+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_CA</constant>
137+
</simpara>
182138
</listitem>
183139
</varlistentry>
184140

@@ -188,10 +144,9 @@ foreach ($unbufferedResult as $row) {
188144
(<type>int</type>)
189145
</term>
190146
<listitem>
191-
<para>
192-
The file path to the directory that contains the trusted SSL
193-
CA certificates, which are stored in <acronym>PEM</acronym> format.
194-
</para>
147+
<simpara>
148+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_CAPATH</constant>
149+
</simpara>
195150
</listitem>
196151
</varlistentry>
197152

@@ -201,9 +156,9 @@ foreach ($unbufferedResult as $row) {
201156
(<type>int</type>)
202157
</term>
203158
<listitem>
204-
<para>
205-
The file path to the SSL certificate.
206-
</para>
159+
<simpara>
160+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_CERT</constant>
161+
</simpara>
207162
</listitem>
208163
</varlistentry>
209164

@@ -213,10 +168,9 @@ foreach ($unbufferedResult as $row) {
213168
(<type>int</type>)
214169
</term>
215170
<listitem>
216-
<para>
217-
A list of one or more permissible ciphers to use for SSL encryption, in a format
218-
understood by OpenSSL. For example: <literal>DHE-RSA-AES256-SHA:AES128-SHA</literal>
219-
</para>
171+
<simpara>
172+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_CIPHER</constant>
173+
</simpara>
220174
</listitem>
221175
</varlistentry>
222176

@@ -226,9 +180,9 @@ foreach ($unbufferedResult as $row) {
226180
(<type>int</type>)
227181
</term>
228182
<listitem>
229-
<para>
230-
The file path to the SSL key.
231-
</para>
183+
<simpara>
184+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_KEY</constant>
185+
</simpara>
232186
</listitem>
233187
</varlistentry>
234188

@@ -238,13 +192,9 @@ foreach ($unbufferedResult as $row) {
238192
(<type>int</type>)
239193
</term>
240194
<listitem>
241-
<para>
242-
Provides a way to disable verification of the server SSL certificate.
243-
This option is available only with mysqlnd.
244-
</para>
245-
<para>
246-
&version.exists.asof; 7.0.18 and PHP 7.1.4.
247-
</para>
195+
<simpara>
196+
&Alias; <constant>Pdo\Mysql::ATTR_SSL_VERIFY_SERVER_CERT</constant>
197+
</simpara>
248198
</listitem>
249199
</varlistentry>
250200

@@ -254,14 +204,9 @@ foreach ($unbufferedResult as $row) {
254204
(<type>int</type>)
255205
</term>
256206
<listitem>
257-
<para>
258-
Disables multi query execution in both <function>PDO::prepare</function>
259-
and <function>PDO::query</function> when set to &false;.
260-
</para>
261-
<para>
262-
Note, this constant can only be used in the <parameter>driver_options</parameter>
263-
array when constructing a new database handle.
264-
</para>
207+
<simpara>
208+
&Alias; <constant>Pdo\Mysql::ATTR_MULTI_STATEMENTS</constant>
209+
</simpara>
265210
</listitem>
266211
</varlistentry>
267212

0 commit comments

Comments
 (0)