Document new PDO classes and methods

reference/pdo/pdo/connect.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="pdo.connect" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refnamediv>
+  <refname>PDO::connect</refname>
+  <refpurpose>Connect to a database and return a PDO subclass for drivers that support it</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="PDO">
+   <modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>PDO::connect</methodname>
+   <methodparam><type>string</type><parameter>dsn</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>username</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>string</type><type>null</type></type><parameter>password</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   Creates an instance of a <classname>PDO</classname> subclass for the
+   database being connection if it exists,
+   otherwise return a generic <classname>PDO</classname> instance.
+  </simpara>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo.construct')/db:refsect1[@role='parameters']/.)">
+  <xi:fallback/>
+ </xi:include>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   Returns an instance of a <classname>PDO</classname> subclass for the
+   corresponding PDO driver if it exists,
+   or a generic <classname>PDO</classname> instance.
+  </simpara>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo.construct')/db:refsect1[@role='errors']/.)">
+  <xi:fallback/>
+ </xi:include>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><classname>Pdo\Dblib</classname></member>
+   <member><classname>Pdo\Firebird</classname></member>
+   <member><classname>Pdo\Mysql</classname></member>
+   <member><classname>Pdo\Odbc</classname></member>
+   <member><classname>Pdo\Pgsql</classname></member>
+   <member><classname>Pdo\Sqlite</classname></member>
+   <member><methodname>PDO::__construct</methodname></member>
+  </simplelist>
+ </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
+-->

reference/pdo/pdo/construct.xml

@@ -114,8 +114,9 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   <methodname>PDO::__construct</methodname> throws a <classname>PDOException</classname> if the attempt
-   to connect to the requested database fails, regardless of which <constant>PDO::ATTR_ERRMODE</constant> is currently set.
+   A <classname>PDOException</classname> is thrown if the attempt
+   to connect to the requested database fails,
+   regardless of which <constant>PDO::ATTR_ERRMODE</constant> is currently set.
   </para>
  </refsect1>
 

reference/pdo_dblib/pdo-dblib.xml

@@ -0,0 +1,164 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xml:id="class.pdo-dblib" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The Pdo\Dblib class</title>
+ <titleabbrev>Pdo\Dblib</titleabbrev>
+
+ <partintro>
+
+  <!-- {{{ ClassName intro -->
+  <section xml:id="pdo-dblib.intro">
+   &reftitle.intro;
+   <simpara>
+    A <classname>PDO</classname> subclass representing a connection using
+    the DBLib PDO driver.
+   </simpara>
+  </section>
+  <!-- }}} -->
+
+  <section xml:id="pdo-dblib.synopsis">
+   &reftitle.classsynopsis;
+   <!-- {{{ Synopsis -->
+   <classsynopsis class="class">
+    <ooclass>
+     <classname>Pdo\Dblib</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-dblib.constants.attr-connection-timeout">Pdo\Dblib::ATTR_CONNECTION_TIMEOUT</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-query-timeout">Pdo\Dblib::ATTR_QUERY_TIMEOUT</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-stringify-uniqueidentifier">Pdo\Dblib::ATTR_STRINGIFY_UNIQUEIDENTIFIER</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-version">Pdo\Dblib::ATTR_VERSION</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-tds-version">Pdo\Dblib::ATTR_TDS_VERSION</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-skip-empty-rowsets">Pdo\Dblib::ATTR_SKIP_EMPTY_ROWSETS</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="pdo-dblib.constants.attr-datetime-convert">Pdo\Dblib::ATTR_DATETIME_CONVERT</varname>
+    </fieldsynopsis>
+    <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-dblib.constants">
+   &reftitle.constants;
+   <variablelist>
+    <varlistentry xml:id="pdo-dblib.constants.attr-connection-timeout">
+     <term><constant>Pdo\Dblib::ATTR_CONNECTION_TIMEOUT</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-query-timeout">
+     <term><constant>Pdo\Dblib::ATTR_QUERY_TIMEOUT</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-stringify-uniqueidentifier">
+     <term><constant>Pdo\Dblib::ATTR_STRINGIFY_UNIQUEIDENTIFIER</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-version">
+     <term><constant>Pdo\Dblib::ATTR_VERSION</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-tds-version">
+     <term><constant>Pdo\Dblib::ATTR_TDS_VERSION</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-skip-empty-rowsets">
+     <term><constant>Pdo\Dblib::ATTR_SKIP_EMPTY_ROWSETS</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="pdo-dblib.constants.attr-datetime-convert">
+     <term><constant>Pdo\Dblib::ATTR_DATETIME_CONVERT</constant></term>
+     <listitem>
+      <simpara>
+      </simpara>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+ </partintro>
+
+</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
+-->

reference/pdo_dblib/reference.xml

@@ -7,7 +7,7 @@
   <titleabbrev>MS SQL Server (PDO)</titleabbrev>
   <partintro>
 
-   <section xml:id="pdo-dblib.intro">
+   <section xml:id="ref.pdo-dblib.intro">
    &reftitle.intro;
     <para>
      PDO_DBLIB is a driver that implements the <link linkend="intro.pdo">PHP
@@ -120,6 +120,7 @@ dblib:host=localhost;dbname=testdb
   </refentry>
 
  </reference>
+ &reference.pdo-dblib.pdo-dblib;
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

reference/pdo_dblib/versions.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!--
+  Do NOT translate this file
+-->
+<versions>
+ <function name="pdo\dblib" 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
+-->

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