Implement the new-oo-style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249563 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2007-12-31 14:34:04 +00:00
parent 3eb838771f
commit 32f579f335
4 changed files with 275 additions and 2 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Purpose: database.abstract -->
<!-- Membership: pecl, bundled -->
@ -37,12 +37,18 @@
&reference.pdo.setup;
&reference.pdo.constants;
&reference.pdo.connections;
&reference.pdo.transactions;
&reference.pdo.prepared-statements;
&reference.pdo.error-handling;
&reference.pdo.lobs;
&reference.pdo.reference;
&reference.pdo.pdo;
&reference.pdo.pdostatement;
<!-- FIXME: Find out how to deal with classess without any methods
&reference.pdo.pdoexception;
-->
<part xml:id="pdo.drivers">
<title>PDO Drivers</title>

66
reference/pdo/pdo.xml Normal file
View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="class.pdo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The PDO class</title>
<titleabbrev>PDO</titleabbrev>
<partintro>
<!-- {{{ PDO intro -->
<section xml:id="pdo.intro">
&reftitle.intro;
<para>
Represents a connection between PHP and a database server.
</para>
</section>
<!-- }}} -->
<section xml:id="pdo.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>PDO</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>PDO</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- }}} -->
</classsynopsis>
</section>
</partintro>
&reference.pdo.entities.pdo;
</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:"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
-->

View file

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="class.pdoexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The PDOException class</title>
<titleabbrev>PDOException</titleabbrev>
<partintro>
<!-- {{{ PDOException intro -->
<section xml:id="pdoexception.intro">
&reftitle.intro;
<para>
Represents an error raised by PDO. You should not throw a
<classname>PDOException</classname> from your own code.
See <link linkend='language.exceptions'>Exceptions</link> for more
information about Exceptions in PHP.
</para>
</section>
<!-- }}} -->
<section xml:id="pdoexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>PDOException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>PDOException</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>RuntimeException</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<fieldsynopsis><!-- {{{ errorInfo -->
<modifier>public</modifier>
<type>string</type>
<varname linkend="pdoexception.props.errorinfo">errorInfo</varname>
</fieldsynopsis><!-- }}} -->
<fieldsynopsis><!-- {{{ message -->
<modifier>protected</modifier>
<type>string</type>
<varname linkend="pdoexception.props.message">message</varname>
</fieldsynopsis><!-- }}} -->
<fieldsynopsis><!-- {{{ code -->
<modifier>protected</modifier>
<type>string</type>
<varname linkend="pdoexception.props.code">code</varname>
</fieldsynopsis><!-- }}} -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdoexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- FIXME: Enable when RuntimeException gets documented
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.runtimeexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ PDOException properties -->
<section xml:id="pdoexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="pdoexception.props.errorinfo"><!-- {{{ -->
<term><varname>errorInfo</varname></term>
<listitem>
<para>
Corresponds to <function>PDO::errorInfo</function> or
<function>PDOStatement::errorInfo</function>
</para>
</listitem>
</varlistentry><!-- }}} -->
<varlistentry xml:id="pdoexception.props.message"><!-- {{{ -->
<term><varname>message</varname></term>
<listitem>
<para>
Textual error message. <function>Exception::getMessage</function> to access it.
</listitem>
</varlistentry><!-- }}} -->
<varlistentry xml:id="pdoexception.props.code"><!-- {{{ -->
<term><varname>code</varname></term>
<listitem>
<para>
<literal>SQLSTATE</literal> error code. Use
<function>Exception::getCode</function> to access it.
</para>
</listitem>
</varlistentry><!-- }}} -->
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.pdo.entities.pdoexception;
</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:"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
-->

View file

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="class.pdostatement" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The PDOStatement class</title>
<titleabbrev>PDOStatement</titleabbrev>
<partintro>
<!-- {{{ PDOStatement intro -->
<section xml:id="pdostatement.intro">
&reftitle.intro;
<para>
Represents a prepared statement and, after the statement is executed, an
associated result set.
</para>
</section>
<!-- }}} -->
<section xml:id="pdostatement.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>PDOStatement</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>PDOStatement</classname>
</ooclass>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pdostatement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.pdo.entities.pdostatement;
</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:"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
-->