Tidy a bit

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@172415 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2004-11-10 08:04:56 +00:00
parent 18cc72a0f0
commit 8ba5df9576
10 changed files with 113 additions and 101 deletions

View file

@ -1,14 +1,14 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.beginTransaction'>
<refnamediv>
<refname>beginTransaction</refname>
<refpurpose>Begins a transaction.</refpurpose>
<refpurpose>Begins a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>beginTransaction</methodname>
<type>bool</type><methodname>beginTransaction</methodname>
<void />
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,42 +1,40 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.bindParam'>
<refnamediv>
<refname>bindParam</refname>
<refpurpose>Binds a parameter to the specified variable name.</refpurpose>
<refpurpose>Binds a parameter to the specified variable name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>bindParam</methodname>
<methodparam><type>String</type>
<parameter>parameter-name</parameter></methodparam>
<methodparam><type>var</type>
<parameter>variable-name</parameter></methodparam>
<methodparam choice='opt'><type>integer</type>
<parameter>data-type</parameter></methodparam>
<methodparam choice='opt'><type>integer</type>
<parameter>length</parameter></methodparam>
<type>bool</type><methodname>bindParam</methodname>
<methodparam><type>string</type><parameter>parameter_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter role='reference'>variable</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>data_type</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Binds a parameter to the specified variable name.
</para>
<example><title>Execute a prepared statement with bound variables</title>
<programlisting role='php'><![CDATA[
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by binding PHP variables */
$calories = 150;
$colour = 'red';
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < ?' AND colour = ?);
$sth->bindParam(1, $calories, PDO_PARAM_INT)
$sth->bindParam(2, $colour, PDO_PARAM_STR, 12)
WHERE calories < ? AND colour = ?');
$sth->bindParam(1, $calories, PDO_PARAM_INT);
$sth->bindParam(2, $colour, PDO_PARAM_STR, 12);
$sth->execute();
]]>
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>

View file

@ -1,14 +1,14 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.commit'>
<refnamediv>
<refname>commit</refname>
<refpurpose>Commits a transaction.</refpurpose>
<refpurpose>Commits a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>commit</methodname>
<type>bool</type><methodname>commit</methodname>
<void />
</methodsynopsis>
&warn.experimental.func;
@ -19,4 +19,3 @@
</para>
</refsect1>
</refentry>

View file

@ -1,16 +1,15 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.execute'>
<refnamediv>
<refname>execute</refname>
<refpurpose>Executes a prepared statement.</refpurpose>
<refpurpose>Executes a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>execute</methodname>
<methodparam choice='opt'><type>array</type>
<parameter>parameters</parameter></methodparam>
<type>bool</type><methodname>execute</methodname>
<methodparam choice='opt'><type>array</type><parameter>parameters</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
@ -23,31 +22,36 @@
<listitem><para>or pass an array of parameter values</para></listitem>
</itemizedlist>
<example><title>Execute a prepared statement with bound variables</title>
<programlisting role='php'><![CDATA[
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by binding PHP variables */
$calories = 150;
$colour = 'red';
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < ?' AND colour = ?);
$sth->bindParam(1, $calories, PDO_PARAM_INT)
$sth->bindParam(2, $colour, PDO_PARAM_STR, 12)
WHERE calories < ? AND colour = ?');
$sth->bindParam(1, $calories, PDO_PARAM_INT);
$sth->bindParam(2, $colour, PDO_PARAM_STR, 12);
$sth->execute();
]]>
?>
]]>
</programlisting>
</example>
<example><title>Execute a prepared statement by passing an array of
values</title>
<programlisting role='php'><![CDATA[
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by passing an array of values */
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < ?' AND colour = ?);
WHERE calories < ? AND colour = ?');
$sth->execute(array(150, 'red'));
]]>
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

View file

@ -1,48 +1,51 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.fetch'>
<refnamediv>
<refname>fetch</refname>
<refpurpose>Fetches a row from a result set.</refpurpose>
<refpurpose>Fetches a row from a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type> <methodname>fetch</methodname>
<methodparam choice='opt'><type>integer</type>
<parameter>PDO_FETCH_STYLE</parameter></methodparam>
<type>array</type><methodname>fetch</methodname>
<methodparam choice='opt'><type>int</type><parameter>fetch_style</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Fetches a row from a result set associated with a Statement object.
</para>
<para>
<parameter>PDO_FETCH_STYLE</parameter> can be one of the following values:
<parameter>fetch_style</parameter> can be one of the following values:
<itemizedlist>
<listitem><para>PDO_FETCH_NUM: returns an array indexed by column number
as returned in your result set, starting at column 0</para></listitem>
<listitem><para>PDO_FETCH_ASSOC: returns an array indexed by column name
as returned in your result set
<listitem><para>
<literal>PDO_FETCH_NUM</literal>: returns an array indexed by column
number as returned in your result set, starting at column 0
</para></listitem>
<listitem><para>
PDO_FETCH_BOTH (default): returns an array indexed by
both column name and column number as returned in your result set
<literal>PDO_FETCH_ASSOC</literal>: returns an array indexed by column
name as returned in your result set
</para></listitem>
<listitem><para>
PDO_FETCH_OBJ: returns an anonymous object with property names that
correspond to the column names returned in your result set
<literal>PDO_FETCH_BOTH</literal> (default): returns an array indexed by
both column name and column number as returned in your result set
</para></listitem>
<listitem><para>
PDO_FETCH_LAZY: combines PDO_FETCH_BOTH and PDO_FETCH_OBJ, creating
the object variable names as they are accessed
<literal>PDO_FETCH_OBJ</literal>: returns an anonymous object with
property names that correspond to the column names returned in your
result set
</para></listitem>
<listitem><para>
PDO_FETCH_BOUND: returns TRUE and assigns the values of the columns in
your result set to the PHP variables to which they were bound with the
<function>bindParam</function> method
<literal>PDO_FETCH_LAZY</literal>: combines
<literal>PDO_FETCH_BOTH</literal> and <literal>PDO_FETCH_OBJ</literal>,
creating the object variable names as they are accessed
</para></listitem>
<listitem><para>
<literal>PDO_FETCH_BOUND</literal>: returns &true; and assigns the
values of the columns in your result set to the PHP variables to which
they were bound with the <function>bindParam</function> method
</para></listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>

View file

@ -1,15 +1,15 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.prepare'>
<refnamediv>
<refname>prepare</refname>
<refpurpose>Prepares an SQL statement.</refpurpose>
<refpurpose>Prepares an SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>Statement</type> <methodname>prepare</methodname>
<methodparam><type>String</type> <parameter>SQL-statement</parameter></methodparam>
<type>object</type><methodname>prepare</methodname>
<methodparam><type>string</type><parameter>sql_statement</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
@ -19,15 +19,18 @@
</para>
<example><title>Execute a prepared statement by passing an array of
values</title>
<programlisting role='php'><![CDATA[
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by passing an array of values */
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < ?' AND colour = ?);
WHERE calories < ? AND colour = ?');
$sth->execute(array(150, 'red'));
]]></programlisting>
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>

View file

@ -1,14 +1,14 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.rollback'>
<refnamediv>
<refname>rollback</refname>
<refpurpose>Rolls back a transaction.</refpurpose>
<refpurpose>Rolls back a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>rollback</methodname>
<type>bool</type><methodname>rollback</methodname>
<void />
</methodsynopsis>
&warn.experimental.func;
@ -17,4 +17,3 @@
</para>
</refsect1>
</refentry>

View file

@ -1,35 +1,39 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo.setAttribute'>
<refnamediv>
<refname>setAttribute</refname>
<refpurpose>Sets a database connection attribute.</refpurpose>
<refpurpose>Sets a database connection attribute</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>???</type> <methodname>setAttribute</methodname>
<methodparam><type>int</type> <parameter>attribute</parameter></methodparam>
<methodparam><type>int</type> <parameter>value</parameter></methodparam>
<type>bool</type><methodname>setAttribute</methodname>
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets a database connection attribute. The generic PDO connection attributes
include:
<itemizedlist>
<listitem><para>PDO_ATTR_CASE: Force column names to a specific case.
<itemizedlist>
<listitem><para>PDO_CASE_LOWER: Force column names to lower
case.</para></listitem>
<listitem><para>PDO_CASE_NATURAL: Leave column names as returned by
the database driver.</para></listitem>
<listitem><para>PDO_CASE_UPPER: Force column names to upper
case.</para></listitem>
</itemizedlist>
<listitem><para>
<literal>PDO_ATTR_CASE</literal>: Force column names to a specific case.
<itemizedlist>
<listitem><para>
<literal>PDO_CASE_LOWER</literal>: Force column names to lower case.
</para></listitem>
<listitem><para>
<literal>PDO_CASE_NATURAL</literal>: Leave column names as returned by
the database driver.
</para></listitem>
<listitem><para>
<literal>PDO_CASE_UPPER</literal>: Force column names to upper case.
</para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
PDO drivers may define further driver-specific attributes.
</para>
</refsect1>
</refentry>

View file

@ -1,18 +1,18 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pdo'>
<refnamediv>
<refname>PDO</refname>
<refpurpose>Creates a PDO instance to represent a connection to a
database.</refpurpose>
database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type> <methodname>PDO</methodname>
<methodparam><type>String</type> <parameter>DSN</parameter></methodparam>
<methodparam choice='opt'><type>String</type> <parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>String</type> <parameter>password</parameter></methodparam>
<type>object</type><methodname>PDO</methodname>
<methodparam><type>string</type><parameter>DSN</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
@ -38,7 +38,9 @@
by a closed connection handle.
</para>
<example><title>Create a connection</title>
<programlisting role='php'><![CDATA[
<programlisting role='php'>
<![CDATA[
<?php
$database = 'SAMPLE';
$user = 'db2inst1';
$password = 'ibmdb2';
@ -49,9 +51,9 @@ catch (PDOException $e) {
echo "Could not connect to database '$database' as user '$user'.";
echo $e->getMessage();
}
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</refsect1>
</refentry>

View file

@ -1,10 +1,10 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision -->
<!-- $Revision: 1.2 $ -->
<reference id='ref.pdo'>
<title>PHP Data Objects</title>
<titleabbrev>PDO</titleabbrev>
<partintro>
<section id='pdo.initro'>
<section id='pdo.intro'>
&reftitle.intro;
<para>
&warn.experimental;
@ -29,7 +29,7 @@
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><link linkend='function.pdo'>PDO</link> - construct a new PDO
<para><link linkend='function.pdo'>PDO</link> - constructs a new PDO
object</para>
</listitem>
</itemizedlist>
@ -39,10 +39,10 @@
<itemizedlist>
<listitem>
<para><link linkend='function.pdo-beginTransaction'>beginTransaction
</link> - begin a transaction</para>
</link> - begins a transaction</para>
</listitem>
<listitem>
<para><link linkend='function.pdo-commit'>commit</link> - commit a
<para><link linkend='function.pdo-commit'>commit</link> - commits a
transaction</para>
</listitem>
<listitem>
@ -69,7 +69,7 @@
</itemizedlist>
</section>
</section>
<section id='pdo.classes.Statement'>
<section id='pdo.class.Statement'>
<title><classname>Statement</classname></title>
<para>Represents a prepared statement and, after the statement is
executed, an associated result set.</para>