Document new PDO classes and methods #4115
Conversation
| <section xml:id="pdo-sqlite.intro"> | ||
| &reftitle.intro; | ||
| <simpara> | ||
| A concrete <classname>PDO</classname> subclass representing a connection |
There was a problem hiding this comment.
What does "concrete" mean in this context?
| </listitem> | ||
| <listitem> | ||
| <simpara> | ||
| Tests, as necessary. |
There was a problem hiding this comment.
This is taken from the RFC, @mbeccati can you clarify?
There was a problem hiding this comment.
Yeah, in the context of the RFC I meant phpt tests for the custom syntax... so it doesn't belong here ;-)
| <refnamediv> | ||
| <refname>Pdo\Sqlite::createAggregate</refname> | ||
| <refpurpose> | ||
| Registers an aggregating User Defined Function for use in SQL statements |
There was a problem hiding this comment.
| Registers an aggregating User Defined Function for use in SQL statements | |
| Registers an aggregating user-defined function for use in SQL statements |
| <refnamediv> | ||
| <refname>Pdo\Sqlite::createCollation</refname> | ||
| <refpurpose> | ||
| Registers a User Defined Function for use as a collating function in SQL statements |
There was a problem hiding this comment.
| Registers a User Defined Function for use as a collating function in SQL statements | |
| Registers a user-defined function for use as a collating function in SQL statements |
| <refnamediv> | ||
| <refname>Pdo\Sqlite::createFunction</refname> | ||
| <refpurpose> | ||
| Registers a User Defined Function for use in SQL statements |
There was a problem hiding this comment.
| Registers a User Defined Function for use in SQL statements | |
| Registers a user-defined function for use in SQL statements |
| <refentry xml:id="pdo-sqlite.loadextension" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
| <refnamediv> | ||
| <refname>Pdo\Sqlite::loadExtension</refname> | ||
| <refpurpose>Description</refpurpose> |
There was a problem hiding this comment.
Is this still work in progress?
There was a problem hiding this comment.
It is from a commit that adds stubs. because I don't know what this method does.
| <refentry xml:id="pdo-firebird.getapiversion" xmlns="http://docbook.org/ns/docbook"> | ||
| <refnamediv> | ||
| <refname>Pdo\Firebird::getApiVersion</refname> | ||
| <refpurpose>Get the API version </refpurpose> |
There was a problem hiding this comment.
| <refpurpose>Get the API version </refpurpose> | |
| <refpurpose>Get the API version</refpurpose> |
| <refsect1 role="returnvalues"> | ||
| &reftitle.returnvalues; | ||
| <simpara> | ||
| Return the FireBird API as an <type>int</type>. |
There was a problem hiding this comment.
| Return the FireBird API as an <type>int</type>. | |
| Returns the FireBird API as an &integer;. |
| <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> |
| </methodsynopsis> | ||
| <simpara> | ||
| Creates an instance of a <classname>PDO</classname> subclass for the | ||
| database being connection if it exists, |
There was a problem hiding this comment.
Is this correct? What does it mean?
There was a problem hiding this comment.
If a class exists for the driver (e.g. mysql) it will return that instead of a generic PDO instance.
There was a problem hiding this comment.
"... subclass for the corresponding PDO driver if it exists ..."
| <simpara> | ||
| </simpara> |
There was a problem hiding this comment.
| <simpara> | |
| </simpara> | |
| <simpara> | |
| Set transaction isolation level. , this can be one of <constant>Pdo\Firebird::READ_COMMITTED</constant>, | |
| <constant>Pdo\Firebird::REPEATABLE_READ</constant> and <constant>Pdo\Firebird::SERIALIZABLE</constant>. | |
| </simpara> |
| <simpara> | ||
| </simpara> |
There was a problem hiding this comment.
| <simpara> | |
| </simpara> | |
| <simpara> | |
| Flag to denote the transaction isolation level is READ COMMITTED. | |
| This flag is the default. | |
| </simpara> |
| <simpara> | ||
| </simpara> |
There was a problem hiding this comment.
| <simpara> | |
| </simpara> | |
| <simpara> | |
| Flag to denote the transaction isolation level is REPEATABLE READ. | |
| </simpara> |
| <simpara> | ||
| </simpara> |
There was a problem hiding this comment.
| <simpara> | |
| </simpara> | |
| <simpara> | |
| Flag to denote the transaction isolation level is SERIALIZABLE. | |
| </simpara> |
| <simpara> | ||
| </simpara> |
There was a problem hiding this comment.
| <simpara> | |
| </simpara> | |
| <simpara> | |
| Allow write operations to the database. Default is true. | |
| </simpara> |
Reference: https://wiki.php.net/rfc/pdo_driver_specific_subclasses and https://wiki.php.net/rfc/pdo_driver_specific_parsers
Still needs MySQLi, PGSQL, and OCI8 (although that one is going to be low priority)
@SakiTakamachi can you document, either as inline comments or in a follow-up PR the transaction attributes?