PHP 8.4: Document Pdo\Firebird class

php · Nov 20, 2024 · 6a9e867 · 6a9e867
1 parent 64c5a0d
commit 6a9e867
Show file tree

Hide file tree

Showing 5 changed files with 277 additions and 6 deletions.
diff --git a/reference/pdo_firebird/constants.xml b/reference/pdo_firebird/constants.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<section xml:id="pdo-firebird.constants" xmlns="http://docbook.org/ns/docbook">
+<section xml:id="ref.pdo-firebird.constants" xmlns="http://docbook.org/ns/docbook">
  &reftitle.constants;
  &pdo.driver-constants;
  <variablelist>
@@ -11,7 +11,7 @@
    </term>
    <listitem>
     <para>
-     Sets the date format.
+     &Alias; <constant>Pdo\Firebird::ATTR_DATE_FORMAT</constant>.
     </para>
    </listitem>
   </varlistentry>
@@ -22,7 +22,7 @@
    </term>
    <listitem>
     <para>
-     Sets the time format.
+     &Alias; <constant>Pdo\Firebird::ATTR_TIME_FORMAT</constant>.
     </para>
    </listitem>
   </varlistentry>
@@ -33,13 +33,12 @@
    </term>
    <listitem>
     <para>
-     Sets the timestamp format.
+     &Alias; <constant>Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</constant>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </section>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/pdo_firebird/pdo-firebird.xml b/reference/pdo_firebird/pdo-firebird.xml
@@ -0,0 +1,191 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xml:id="class.pdo-firebird" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The Pdo\Firebird class</title>
+ <titleabbrev>Pdo\Firebird</titleabbrev>
+
+ <partintro>
+
+  <!-- {{{ ClassName intro -->
+  <section xml:id="pdo-firebird.intro">
+   &reftitle.intro;
+   <simpara>
+    A concrete <classname>PDO</classname> subclass representing a connection
+    to a Firebird database.
+   </simpara>
+  </section>
+  <!-- }}} -->
+
+  <section xml:id="pdo-firebird.synopsis">
+   &reftitle.classsynopsis;
+   <!-- {{{ Synopsis -->
+   <classsynopsis class="class">
+    <ooclass>
+     <classname>Pdo\Firebird</classname>
+    </ooclass>
+
+    <ooclass>
+     <modifier>extends</modifier>
+     <classname>PDO</classname>
+    </ooclass>
+
+    <classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
+    <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;']]))">
+     <xi:fallback/>
+    </xi:include>
+
+    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.attr-date-format">Pdo\Firebird::ATTR_DATE_FORMAT</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.attr-time-format">Pdo\Firebird::ATTR_TIME_FORMAT</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.attr-timestamp-format">Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.transaction-isolation-level">Pdo\Firebird::TRANSACTION_ISOLATION_LEVEL</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.read-committed">Pdo\Firebird::READ_COMMITTED</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.repeatable-read">Pdo\Firebird::REPEATABLE_READ</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.serializable">Pdo\Firebird::SERIALIZABLE</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-firebird.constants.writable-transaction">Pdo\Firebird::WRITABLE_TRANSACTION</varname>
+    </fieldsynopsis>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <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'])">
+     <xi:fallback/>
+    </xi:include>
+
+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <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'])">
+     <xi:fallback/>
+    </xi:include>
+    <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'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+   <!-- }}} -->
+
+  </section>
+
+  <section xml:id="pdo-firebird.constants">
+   &reftitle.constants;
+   <variablelist>
+    <varlistentry xml:id="pdo-firebird.constants.attr-date-format">
+     <term><constant>Pdo\Firebird::ATTR_DATE_FORMAT</constant></term>
+     <listitem>
+      <simpara>
+       Sets the date format.
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.attr-time-format">
+     <term><constant>Pdo\Firebird::ATTR_TIME_FORMAT</constant></term>
+     <listitem>
+      <simpara>
+       Sets the time format.
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.attr-timestamp-format">
+     <term><constant>Pdo\Firebird::ATTR_TIMESTAMP_FORMAT</constant></term>
+     <listitem>
+      <simpara>
+       Sets the timestamp format.
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.transaction-isolation-level">
+     <term><constant>Pdo\Firebird::TRANSACTION_ISOLATION_LEVEL</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.read-committed">
+     <term><constant>Pdo\Firebird::READ_COMMITTED</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.repeatable-read">
+     <term><constant>Pdo\Firebird::REPEATABLE_READ</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.serializable">
+     <term><constant>Pdo\Firebird::SERIALIZABLE</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-firebird.constants.writable-transaction">
+     <term><constant>Pdo\Firebird::WRITABLE_TRANSACTION</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+ </partintro>
+
+ &reference.pdo-firebird.pdo.entities.firebird;
+
+</reference>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/pdo_firebird/pdo/firebird/getapiversion.xml b/reference/pdo_firebird/pdo/firebird/getapiversion.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="pdo-firebird.getapiversion" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>Pdo\Firebird::getApiVersion</refname>
+  <refpurpose>Get the API version </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="Pdo\\Firebird">
+   <modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>Pdo\Firebird::getApiVersion</methodname>
+   <void/>
+  </methodsynopsis>
+  <simpara>
+   Returns the Firebird API version as defined by the C constant
+   <constant>FB_API_VER</constant> in <filename class="headerfile">ibase.h</filename>.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   Return the FireBird API as an <type>int</type>.
+  </simpara>
+ </refsect1>
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/pdo_firebird/reference.xml b/reference/pdo_firebird/reference.xml
@@ -7,7 +7,7 @@
   <titleabbrev>Firebird (PDO)</titleabbrev>
   <partintro>
 
-   <section xml:id="pdo-firebird.intro">
+   <section xml:id="ref.pdo-firebird.intro">
    &reftitle.intro;
     <para>
      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
   </refentry>
 
  </reference>
+ &reference.pdo-firebird.pdo-firebird;
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/pdo_firebird/versions.xml b/reference/pdo_firebird/versions.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!--
+  Do NOT translate this file
+-->
+<versions>
+ <function name="pdo\firebird" from="PHP 8 &gt;= 8.4.0"/>
+ <function name="pdo\firebird::getapiversion" from="PHP 8 &gt;= 8.4.0"/>
+</versions>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->