Skip to content

Commit c65251d

Browse files
GirgiasGirgias
committed
PHP 8.4: Document Pdo\Firebird class
1 parent f32f854 commit c65251d

File tree

5 files changed

+293
-6
lines changed

5 files changed

+293
-6
lines changed

‎reference/pdo_firebird/constants.xml

Lines changed: 4 additions & 5 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-firebird.constants" xmlns="http://docbook.org/ns/docbook">
3+
<section xml:id="ref.pdo-firebird.constants" xmlns="http://docbook.org/ns/docbook">
44
&reftitle.constants;
55
&pdo.driver-constants;
66
<variablelist>
@@ -11,7 +11,7 @@
1111
</term>
1212
<listitem>
1313
<para>
14-
Sets the date format.
14+
&Alias; <constant>Pdo\Firebird::ATTR_DATE_FORMAT</constant>.
1515
</para>
1616
</listitem>
1717
</varlistentry>
@@ -22,7 +22,7 @@
2222
</term>
2323
<listitem>
2424
<para>
25-
Sets the time format.
25+
&Alias; <constant>Pdo\Firebird::ATTR_TIME_FORMAT</constant>.
2626
</para>
2727
</listitem>
2828
</varlistentry>
@@ -33,13 +33,12 @@
3333
</term>
3434
<listitem>
3535
<para>
36-
Sets the timestamp format.
36+
&Alias; <constant>Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</constant>.
3737
</para>
3838
</listitem>
3939
</varlistentry>
4040
</variablelist>
4141
</section>
42-
4342
<!-- Keep this comment at the end of the file
4443
Local variables:
4544
mode: sgml

‎reference/pdo_firebird/pdo-firebird.xml

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<reference xml:id="class.pdo-firebird" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<title>The Pdo\Firebird class</title>
4+
<titleabbrev>Pdo\Firebird</titleabbrev>
5+
6+
<partintro>
7+
8+
<!-- {{{ ClassName intro -->
9+
<section xml:id="pdo-firebird.intro">
10+
&reftitle.intro;
11+
<simpara>
12+
A concrete <classname>PDO</classname> subclass representing a connection
13+
to a Firebird database.
14+
</simpara>
15+
</section>
16+
<!-- }}} -->
17+
18+
<section xml:id="pdo-firebird.synopsis">
19+
&reftitle.classsynopsis;
20+
<!-- {{{ Synopsis -->
21+
<classsynopsis class="class">
22+
<ooclass>
23+
<classname>Pdo\Firebird</classname>
24+
</ooclass>
25+
26+
<ooclass>
27+
<modifier>extends</modifier>
28+
<classname>PDO</classname>
29+
</ooclass>
30+
31+
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
32+
<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;']]))">
33+
<xi:fallback/>
34+
</xi:include>
35+
36+
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
37+
<fieldsynopsis>
38+
<modifier>public</modifier>
39+
<modifier>const</modifier>
40+
<type>int</type>
41+
<varname linkend="pdo-firebird.constants.attr-date-format">Pdo\Firebird::ATTR_DATE_FORMAT</varname>
42+
</fieldsynopsis>
43+
<fieldsynopsis>
44+
<modifier>public</modifier>
45+
<modifier>const</modifier>
46+
<type>int</type>
47+
<varname linkend="pdo-firebird.constants.attr-time-format">Pdo\Firebird::ATTR_TIME_FORMAT</varname>
48+
</fieldsynopsis>
49+
<fieldsynopsis>
50+
<modifier>public</modifier>
51+
<modifier>const</modifier>
52+
<type>int</type>
53+
<varname linkend="pdo-firebird.constants.attr-timestamp-format">Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</varname>
54+
</fieldsynopsis>
55+
<fieldsynopsis>
56+
<modifier>public</modifier>
57+
<modifier>const</modifier>
58+
<type>int</type>
59+
<varname linkend="pdo-firebird.constants.transaction-isolation-level">Pdo\Firebird::TRANSACTION_ISOLATION_LEVEL</varname>
60+
</fieldsynopsis>
61+
<fieldsynopsis>
62+
<modifier>public</modifier>
63+
<modifier>const</modifier>
64+
<type>int</type>
65+
<varname linkend="pdo-firebird.constants.read-committed">Pdo\Firebird::READ_COMMITTED</varname>
66+
</fieldsynopsis>
67+
<fieldsynopsis>
68+
<modifier>public</modifier>
69+
<modifier>const</modifier>
70+
<type>int</type>
71+
<varname linkend="pdo-firebird.constants.repeatable-read">Pdo\Firebird::REPEATABLE_READ</varname>
72+
</fieldsynopsis>
73+
<fieldsynopsis>
74+
<modifier>public</modifier>
75+
<modifier>const</modifier>
76+
<type>int</type>
77+
<varname linkend="pdo-firebird.constants.serializable">Pdo\Firebird::SERIALIZABLE</varname>
78+
</fieldsynopsis>
79+
<fieldsynopsis>
80+
<modifier>public</modifier>
81+
<modifier>const</modifier>
82+
<type>int</type>
83+
<varname linkend="pdo-firebird.constants.writable-transaction">Pdo\Firebird::WRITABLE_TRANSACTION</varname>
84+
</fieldsynopsis>
85+
86+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
87+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo-firebird')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Pdo\\Firebird'])">
88+
<xi:fallback/>
89+
</xi:include>
90+
91+
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
92+
<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'])">
93+
<xi:fallback/>
94+
</xi:include>
95+
<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'])">
96+
<xi:fallback/>
97+
</xi:include>
98+
</classsynopsis>
99+
<!-- }}} -->
100+
101+
</section>
102+
103+
<section xml:id="pdo-firebird.constants">
104+
&reftitle.constants;
105+
<variablelist>
106+
<varlistentry xml:id="pdo-firebird.constants.attr-date-format">
107+
<term><constant>Pdo\Firebird::ATTR_DATE_FORMAT</constant></term>
108+
<listitem>
109+
<simpara>
110+
Sets the date format.
111+
</simpara>
112+
</listitem>
113+
</varlistentry>
114+
<varlistentry xml:id="pdo-firebird.constants.attr-time-format">
115+
<term><constant>Pdo\Firebird::ATTR_TIME_FORMAT</constant></term>
116+
<listitem>
117+
<simpara>
118+
Sets the time format.
119+
</simpara>
120+
</listitem>
121+
</varlistentry>
122+
<varlistentry xml:id="pdo-firebird.constants.attr-timestamp-format">
123+
<term><constant>Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</constant></term>
124+
<listitem>
125+
<simpara>
126+
Sets the timestamp format.
127+
</simpara>
128+
</listitem>
129+
</varlistentry>
130+
<varlistentry xml:id="pdo-firebird.constants.transaction-isolation-level">
131+
<term><constant>Pdo\Firebird::TRANSACTION_ISOLATION_LEVEL</constant></term>
132+
<listitem>
133+
<simpara>
134+
Attribute to sets the transaction isolation level.
135+
This can be one of <constant>Pdo\Firebird::READ_COMMITTED</constant>,
136+
<constant>Pdo\Firebird::REPEATABLE_READ</constant>,
137+
or <constant>Pdo\Firebird::SERIALIZABLE</constant>.
138+
</simpara>
139+
</listitem>
140+
</varlistentry>
141+
<varlistentry xml:id="pdo-firebird.constants.read-committed">
142+
<term><constant>Pdo\Firebird::READ_COMMITTED</constant></term>
143+
<listitem>
144+
<simpara>
145+
Flag denoting the <acronym>ANSI</acronym> transaction isolation
146+
level is read commited.
147+
This is the default behavior.
148+
</simpara>
149+
</listitem>
150+
</varlistentry>
151+
<varlistentry xml:id="pdo-firebird.constants.repeatable-read">
152+
<term><constant>Pdo\Firebird::REPEATABLE_READ</constant></term>
153+
<listitem>
154+
<simpara>
155+
Flag denoting the <acronym>ANSI</acronym> transaction isolation
156+
level is repeatable read.
157+
This corresponds to Firebird's "snapshot" isolation level.
158+
</simpara>
159+
</listitem>
160+
</varlistentry>
161+
<varlistentry xml:id="pdo-firebird.constants.serializable">
162+
<term><constant>Pdo\Firebird::SERIALIZABLE</constant></term>
163+
<listitem>
164+
<simpara>
165+
Flag denoting the <acronym>ANSI</acronym> transaction isolation
166+
level is serializable.
167+
This corresponds to Firebird's "snapshot table stability" isolation level.
168+
</simpara>
169+
</listitem>
170+
</varlistentry>
171+
<varlistentry xml:id="pdo-firebird.constants.writable-transaction">
172+
<term><constant>Pdo\Firebird::WRITABLE_TRANSACTION</constant></term>
173+
<listitem>
174+
<simpara>
175+
Boolean attribute used to toggle the transaction access mode between
176+
<literal>READ ONLY</literal> and <literal>READ WRITE</literal>.
177+
By default, it is &true; indicating <literal>READ WRITE</literal>.
178+
</simpara>
179+
</listitem>
180+
</varlistentry>
181+
</variablelist>
182+
</section>
183+
</partintro>
184+
185+
&reference.pdo-firebird.pdo.entities.firebird;
186+
187+
</reference>
188+
<!-- Keep this comment at the end of the file
189+
Local variables:
190+
mode: sgml
191+
sgml-omittag:t
192+
sgml-shorttag:t
193+
sgml-minimize-attributes:nil
194+
sgml-always-quote-attributes:t
195+
sgml-indent-step:1
196+
sgml-indent-data:t
197+
indent-tabs-mode:nil
198+
sgml-parent-document:nil
199+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
200+
sgml-exposed-tags:nil
201+
sgml-local-catalogs:nil
202+
sgml-local-ecat-files:nil
203+
End:
204+
vim600: syn=xml fen fdm=syntax fdl=2 si
205+
vim: et tw=78 syn=sgml
206+
vi: ts=1 sw=1
207+
-->

‎reference/pdo_firebird/pdo/firebird/getapiversion.xml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="pdo-firebird.getapiversion" xmlns="http://docbook.org/ns/docbook">
3+
<refnamediv>
4+
<refname>Pdo\Firebird::getApiVersion</refname>
5+
<refpurpose>Get the API version</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Pdo\\Firebird">
11+
<modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>Pdo\Firebird::getApiVersion</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
<simpara>
15+
Returns the Firebird API version as defined by the C constant
16+
<constant>FB_API_VER</constant> in <filename class="headerfile">ibase.h</filename>.
17+
</simpara>
18+
</refsect1>
19+
20+
<refsect1 role="parameters">
21+
&reftitle.parameters;
22+
&no.function.parameters;
23+
</refsect1>
24+
25+
<refsect1 role="returnvalues">
26+
&reftitle.returnvalues;
27+
<simpara>
28+
Returns the FireBird API as an <type>int</type>.
29+
</simpara>
30+
</refsect1>
31+
</refentry>
32+
<!-- Keep this comment at the end of the file
33+
Local variables:
34+
mode: sgml
35+
sgml-omittag:t
36+
sgml-shorttag:t
37+
sgml-minimize-attributes:nil
38+
sgml-always-quote-attributes:t
39+
sgml-indent-step:1
40+
sgml-indent-data:t
41+
indent-tabs-mode:nil
42+
sgml-parent-document:nil
43+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
44+
sgml-exposed-tags:nil
45+
sgml-local-catalogs:nil
46+
sgml-local-ecat-files:nil
47+
End:
48+
vim600: syn=xml fen fdm=syntax fdl=2 si
49+
vim: et tw=78 syn=sgml
50+
vi: ts=1 sw=1
51+
-->

‎reference/pdo_firebird/reference.xml

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

10-
<section xml:id="pdo-firebird.intro">
10+
<section xml:id="ref.pdo-firebird.intro">
1111
&reftitle.intro;
1212
<para>
1313
PDO_FIREBIRD is a driver that implements the PHP Data Objects (PDO)
@@ -128,6 +128,7 @@ firebird:dbname=localhost:/var/lib/firebird/2.5/data/test.fdb;charset=utf-8;dial
128128
</refentry>
129129

130130
</reference>
131+
&reference.pdo-firebird.pdo-firebird;
131132
<!-- Keep this comment at the end of the file
132133
Local variables:
133134
mode: sgml

‎reference/pdo_firebird/versions.xml

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

0 commit comments

Comments
 (0)