PHP 8.4: Document PDO::connect()

Author: Girgias

reference/pdo/pdo/connect.xml

@@ -0,0 +1,73 @@
+<?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>Description</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 database
+   drivers that support it, 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>