Skip to content

Commit c2d9df1

Browse files
GirgiasGirgias
committed
PHP 8.4: Document Pdo\Odbc class
1 parent 191f5b9 commit c2d9df1

File tree

4 files changed

+229
-33
lines changed

4 files changed

+229
-33
lines changed

‎reference/pdo_odbc/constants.xml‎

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
33

4-
<section xml:id="pdo-odbc.constants" xmlns="http://docbook.org/ns/docbook">
4+
<section xml:id="pdo-odbc.global.constants" xmlns="http://docbook.org/ns/docbook">
55
&reftitle.constants;
66
&pdo.driver-constants;
77
<variablelist>
@@ -22,31 +22,42 @@
2222
(<type>int</type>)
2323
</term>
2424
<listitem>
25-
<para>
26-
This option controls whether the ODBC cursor library is used. The ODBC cursor library
27-
supports some advanced ODBC features (e.g. block scrollable cursors), which may not
28-
be implemented by the driver. The following values are supported:
29-
<itemizedlist>
30-
<listitem>
31-
<para>
32-
<constant>PDO::ODBC_SQL_USE_IF_NEEDED</constant> (the default):
33-
use the ODBC cursor library when needed.
34-
</para>
35-
</listitem>
36-
<listitem>
37-
<para>
38-
<constant>PDO::ODBC_SQL_USE_DRIVER</constant>:
39-
never use the ODBC cursor library.
40-
</para>
41-
</listitem>
42-
<listitem>
43-
<para>
44-
<constant>PDO::ODBC_SQL_USE_ODBC</constant>:
45-
always use the ODBC cursor library.
46-
</para>
47-
</listitem>
48-
</itemizedlist>
49-
</para>
25+
<simpara>
26+
&Alias; <constant>Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY</constant>.
27+
</simpara>
28+
</listitem>
29+
</varlistentry>
30+
<varlistentry xml:id="pdo.constants.odbc-sql-use-if-needed">
31+
<term>
32+
<constant>PDO::ODBC_SQL_USE_IF_NEEDED</constant>
33+
(<type>int</type>)
34+
</term>
35+
<listitem>
36+
<simpara>
37+
&Alias; <constant>Pdo\Odbc::SQL_USE_IF_NEEDED</constant>.
38+
</simpara>
39+
</listitem>
40+
</varlistentry>
41+
<varlistentry xml:id="pdo.constants.odbc-sql-use-driver">
42+
<term>
43+
<constant>PDO::ODBC_SQL_USE_DRIVER</constant>
44+
(<type>int</type>)
45+
</term>
46+
<listitem>
47+
<simpara>
48+
&Alias; <constant>Pdo\Odbc::SQL_USE_DRIVER</constant>.
49+
</simpara>
50+
</listitem>
51+
</varlistentry>
52+
<varlistentry xml:id="pdo.constants.odbc-sql-use-odbc">
53+
<term>
54+
<constant>PDO::ODBC_SQL_USE_ODBC</constant>
55+
(<type>int</type>)
56+
</term>
57+
<listitem>
58+
<simpara>
59+
&Alias; <constant>Pdo\Odbc::SQL_USE_ODBC</constant>.
60+
</simpara>
5061
</listitem>
5162
</varlistentry>
5263
<varlistentry xml:id="pdo.constants.odbc-attr-assume-utf8">
@@ -55,12 +66,9 @@
5566
(<type>bool</type>)
5667
</term>
5768
<listitem>
58-
<para>
59-
Windows only. If &true;, UTF-16 encoded character data (<literal>CHAR</literal>,
60-
<literal>VARCHAR</literal> and <literal>LONGVARCHAR</literal>) is converted to
61-
UTF-8 when reading from or writing data to the database.
62-
If &false; (the default), character encoding conversion may be done by the driver.
63-
</para>
69+
<simpara>
70+
&Alias; <constant>Pdo\Odbc::ATTR_ASSUME_UTF8</constant>.
71+
</simpara>
6472
</listitem>
6573
</varlistentry>
6674
</variablelist>

‎reference/pdo_odbc/pdo-odbc.xml‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<reference xml:id="class.pdo-odbc" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<title>The Pdo\Odbc class</title>
4+
<titleabbrev>Pdo\Odbc</titleabbrev>
5+
6+
<partintro>
7+
8+
<!-- {{{ ClassName intro -->
9+
<section xml:id="pdo-odbc.intro">
10+
&reftitle.intro;
11+
<simpara>
12+
A concrete <classname>PDO</classname> subclass representing a connection
13+
to a ODBC database.
14+
</simpara>
15+
</section>
16+
<!-- }}} -->
17+
18+
<section xml:id="pdo-odbc.synopsis">
19+
&reftitle.classsynopsis;
20+
21+
<!-- {{{ Synopsis -->
22+
<classsynopsis class="class">
23+
<ooclass>
24+
<classname>Pdo\Odbc</classname>
25+
</ooclass>
26+
27+
<ooclass>
28+
<modifier>extends</modifier>
29+
<classname>PDO</classname>
30+
</ooclass>
31+
32+
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
33+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
34+
<xi:fallback/>
35+
</xi:include>
36+
37+
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
38+
<fieldsynopsis>
39+
<modifier>public</modifier>
40+
<modifier>const</modifier>
41+
<type>int</type>
42+
<varname linkend="pdo-odbc.constants.attr-use-cursor-library">Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY</varname>
43+
</fieldsynopsis>
44+
<fieldsynopsis>
45+
<modifier>public</modifier>
46+
<modifier>const</modifier>
47+
<type>int</type>
48+
<varname linkend="pdo-odbc.constants.attr-assume-utf8">Pdo\Odbc::ATTR_ASSUME_UTF8</varname>
49+
</fieldsynopsis>
50+
<fieldsynopsis>
51+
<modifier>public</modifier>
52+
<modifier>const</modifier>
53+
<type>int</type>
54+
<varname linkend="pdo-odbc.constants.sql-use-if-needed">Pdo\Odbc::SQL_USE_IF_NEEDED</varname>
55+
</fieldsynopsis>
56+
<fieldsynopsis>
57+
<modifier>public</modifier>
58+
<modifier>const</modifier>
59+
<type>int</type>
60+
<varname linkend="pdo-odbc.constants.sql-use-driver">Pdo\Odbc::SQL_USE_DRIVER</varname>
61+
</fieldsynopsis>
62+
<fieldsynopsis>
63+
<modifier>public</modifier>
64+
<modifier>const</modifier>
65+
<type>int</type>
66+
<varname linkend="pdo-odbc.constants.sql-use-odbc">Pdo\Odbc::SQL_USE_ODBC</varname>
67+
</fieldsynopsis>
68+
69+
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
70+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='PDO'])">
71+
<xi:fallback/>
72+
</xi:include>
73+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='PDO'])">
74+
<xi:fallback/>
75+
</xi:include>
76+
</classsynopsis>
77+
<!-- }}} -->
78+
79+
</section>
80+
81+
<section xml:id="pdo-odbc.constants">
82+
&reftitle.constants;
83+
<variablelist>
84+
<varlistentry xml:id="pdo-odbc.constants.attr-use-cursor-library">
85+
<term><constant>Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY</constant></term>
86+
<listitem>
87+
<para>
88+
This option controls whether the ODBC cursor library is used.
89+
The ODBC cursor library supports some advanced ODBC features
90+
(e.g. block scrollable cursors),
91+
which may not be implemented by the driver.
92+
The following values are supported:
93+
<variablelist>
94+
<varlistentry xml:id="pdo-odbc.constants.sql-use-if-needed">
95+
<term><constant>Pdo\Odbc::SQL_USE_IF_NEEDED</constant></term>
96+
<listitem>
97+
<simpara>
98+
Use the ODBC cursor library when needed.
99+
This is the default.
100+
</simpara>
101+
</listitem>
102+
</varlistentry>
103+
<varlistentry xml:id="pdo-odbc.constants.sql-use-driver">
104+
<term><constant>Pdo\Odbc::SQL_USE_DRIVER</constant></term>
105+
<listitem>
106+
<simpara>
107+
Never use the ODBC cursor library.
108+
</simpara>
109+
</listitem>
110+
</varlistentry>
111+
<varlistentry xml:id="pdo-odbc.constants.sql-use-odbc">
112+
<term><constant>Pdo\Odbc::SQL_USE_ODBC</constant></term>
113+
<listitem>
114+
<simpara>
115+
Always use the ODBC cursor library.
116+
</simpara>
117+
</listitem>
118+
</varlistentry>
119+
</variablelist>
120+
</para>
121+
</listitem>
122+
</varlistentry>
123+
<varlistentry xml:id="pdo-odbc.constants.attr-assume-utf8">
124+
<term><constant>Pdo\Odbc::ATTR_ASSUME_UTF8</constant></term>
125+
<listitem>
126+
<simpara>
127+
Windows only.
128+
If &true;, UTF-16 encoded character data (<literal>CHAR</literal>,
129+
<literal>VARCHAR</literal> and <literal>LONGVARCHAR</literal>)
130+
is converted to UTF-8 when reading from or writing data to the database.
131+
If &false; (the default), character encoding conversion may be done by the driver.
132+
</simpara>
133+
</listitem>
134+
</varlistentry>
135+
</variablelist>
136+
</section>
137+
</partintro>
138+
139+
</reference>
140+
<!-- Keep this comment at the end of the file
141+
Local variables:
142+
mode: sgml
143+
sgml-omittag:t
144+
sgml-shorttag:t
145+
sgml-minimize-attributes:nil
146+
sgml-always-quote-attributes:t
147+
sgml-indent-step:1
148+
sgml-indent-data:t
149+
indent-tabs-mode:nil
150+
sgml-parent-document:nil
151+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
152+
sgml-exposed-tags:nil
153+
sgml-local-catalogs:nil
154+
sgml-local-ecat-files:nil
155+
End:
156+
vim600: syn=xml fen fdm=syntax fdl=2 si
157+
vim: et tw=78 syn=sgml
158+
vi: ts=1 sw=1
159+
-->

‎reference/pdo_odbc/reference.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<titleabbrev>ODBC and DB2 (PDO)</titleabbrev>
88
<partintro>
99

10-
<section xml:id="pdo-odbc.intro">
10+
<section xml:id="ref.pdo-odbc.intro">
1111
&reftitle.intro;
1212
<para>
1313
PDO_ODBC is a driver that implements the <link linkend="intro.pdo">PHP Data
@@ -160,6 +160,7 @@ odbc:Driver={Microsoft Access Driver (*.mdb)};Dbq=C:\\db.mdb;Uid=Admin
160160
</refentry>
161161

162162
</reference>
163+
&reference.pdo-odbc.pdo-odbc;
163164
<!-- Keep this comment at the end of the file
164165
Local variables:
165166
mode: sgml

‎reference/pdo_odbc/versions.xml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!--
4+
Do NOT translate this file
5+
-->
6+
<versions>
7+
<function name="pdo\odbc" from="PHP 8 &gt;= 8.4.0"/>
8+
</versions>
9+
<!-- Keep this comment at the end of the file
10+
Local variables:
11+
mode: sgml
12+
sgml-omittag:t
13+
sgml-shorttag:t
14+
sgml-minimize-attributes:nil
15+
sgml-always-quote-attributes:t
16+
sgml-indent-step:1
17+
sgml-indent-data:t
18+
indent-tabs-mode:nil
19+
sgml-parent-document:nil
20+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
21+
sgml-exposed-tags:nil
22+
sgml-local-catalogs:nil
23+
sgml-local-ecat-files:nil
24+
End:
25+
vim600: syn=xml fen fdm=syntax fdl=2 si
26+
vim: et tw=78 syn=sgml
27+
vi: ts=1 sw=1
28+
-->

0 commit comments

Comments
 (0)