finished new doc style implementation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260051 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-05-20 15:36:08 +00:00
parent 69d8354771
commit 03dd1c7a37
14 changed files with 278 additions and 125 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-close-all" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_close_all</refname>
@ -16,6 +16,12 @@
connections to database server(s).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_connect</refname>
<refpurpose>Connect to a datasource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_connect</methodname>
<methodparam><type>string</type><parameter>dsn</parameter></methodparam>
@ -15,17 +15,10 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam>
</methodsynopsis>
<para>
Returns an ODBC connection id or 0 (&false;) on
error.
</para>
<simpara>
The connection id returned by this functions is needed by other
ODBC functions. You can have multiple connections open at once as long as
they either use different db or different credentials.
The optional fourth parameter sets the type of cursor to be used
for this connection. This parameter is not normally needed, but
can be useful for working around problems with some ODBC drivers.
</simpara>
<simpara>
With some ODBC drivers, executing a complex stored procedure may
@ -36,37 +29,94 @@
<function>odbc_fetch_row</function>. SQL_CUR_USE_ODBC might help
in that case, too.
</simpara>
<simpara>
The following constants are defined for cursortype:
</simpara>
<para>
<itemizedlist>
<listitem>
<simpara>
SQL_CUR_USE_IF_NEEDED
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_USE_ODBC
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_USE_DRIVER
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_DEFAULT
</simpara></listitem>
</itemizedlist>
</para>
<simpara>
For persistent connections see
<function>odbc_pconnect</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dsn</parameter></term>
<listitem>
<para>
The database source name for the connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cursor_type</parameter></term>
<listitem>
<para>
This sets the type of cursor to be used
for this connection. This parameter is not normally needed, but
can be useful for working around problems with some ODBC drivers.
</para>
<simpara>
The following constants are defined for cursortype:
</simpara>
<para>
<itemizedlist>
<listitem>
<simpara>
SQL_CUR_USE_IF_NEEDED
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_USE_ODBC
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_USE_DRIVER
</simpara>
</listitem>
<listitem>
<simpara>
SQL_CUR_DEFAULT
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC connection id or 0 (&false;) on
error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>For persistent connections: <function>odbc_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-foreignkeys" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_foreignkeys</refname>
<refpurpose>Returns a list of foreign keys in the specified table or a list of foreign keys in other tables that refer to the primary key in the specified table</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_foreignkeys</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-gettypeinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_gettypeinfo</refname>
<refpurpose>Returns a result identifier containing information about data types supported by the data source</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_gettypeinfo</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-pconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_pconnect</refname>
<refpurpose>Open a persistent database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_pconnect</methodname>
<methodparam><type>string</type><parameter>dsn</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-prepare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_prepare</refname>
<refpurpose>Prepares a statement for execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_prepare</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<refentry xml:id="function.odbc-procedurecolumns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_procedurecolumns</refname>
<refpurpose>Retrieve information about parameters to procedures</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_procedurecolumns</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<refentry xml:id="function.odbc-procedures" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_procedures</refname>
<refpurpose>Get the list of procedures stored in a specific data source</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_procedures</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.odbc-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_result</refname>
<refpurpose>Get result data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>odbc_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.odbc-setoption" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_setoption</refname>
<refpurpose>Adjust ODBC settings</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_setoption</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.odbc-specialcolumns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_specialcolumns</refname>
<refpurpose>Returns either the optimal set of columns that uniquely identifies a row in the table or columns that are automatically updated when any value in the row is updated by a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_specialcolumns</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-statistics" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_statistics</refname>
<refpurpose>Retrieve statistics about a table</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_statistics</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-tableprivileges" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_tableprivileges</refname>
<refpurpose>Lists tables and the privileges associated with each table</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_tableprivileges</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
@ -17,8 +17,54 @@
</methodsynopsis>
<para>
Lists tables in the requested range and the privileges associated
with each table. Returns an ODBC result identifier or
&false; on failure.
with each table.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
&odbc.connection.id;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
The qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>owner</parameter></term>
<listitem>
<para>
The owner. Accepts the following search patterns:
('%' to match zero or more characters and '_' to match a single character)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name. Accepts the following search patterns:
('%' to match zero or more characters and '_' to match a single character)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An ODBC result identifier or &false; on failure.
</para>
<para>
The result set has the following columns:
@ -36,12 +82,8 @@
The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and
TABLE_NAME.
</simpara>
<para>
The <parameter>owner</parameter> and <parameter>name</parameter>
arguments accept search patterns ('%' to match zero or more
characters and '_' to match a single character).
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.odbc-tables" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_tables</refname>
<refpurpose>Get the list of table names stored in a specific data source</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_tables</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
@ -17,27 +17,7 @@
<methodparam choice="opt"><type>string</type><parameter>types</parameter></methodparam>
</methodsynopsis>
<para>
Lists all tables in the requested range. Returns an ODBC result
identifier containing the information or &false; on failure.
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
<listitem><simpara>TABLE_OWNER</simpara></listitem>
<listitem><simpara>TABLE_NAME</simpara></listitem>
<listitem><simpara>TABLE_TYPE</simpara></listitem>
<listitem><simpara>REMARKS</simpara></listitem>
</itemizedlist>
</para>
<simpara>
The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER,
TABLE_OWNER and TABLE_NAME.
</simpara>
<para>
The <parameter>owner</parameter> and <parameter>name</parameter>
arguments accept search patterns ('%' to match zero or more
characters and '_' to match a single character).
Lists all tables in the requested range.
</para>
<para>
To support enumeration of qualifiers, owners, and table types,
@ -78,20 +58,93 @@
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
If <parameter>table_type</parameter> is not an empty string, it
must contain a list of comma-separated values for the types of
interest; each value may be enclosed in single quotes (') or
unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the
data source does not support a specified table type,
<function>odbc_tables</function> does not return any results for
that type.
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
&odbc.connection.id;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>qualifier</parameter></term>
<listitem>
<para>
The qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>owner</parameter></term>
<listitem>
<para>
The owner. Accepts search patterns ('%' to match zero or more
characters and '_' to match a single character).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name. Accepts search patterns ('%' to match zero or more
characters and '_' to match a single character).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>types</parameter></term>
<listitem>
<para>
If <parameter>table_type</parameter> is not an empty string, it
must contain a list of comma-separated values for the types of
interest; each value may be enclosed in single quotes (') or
unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the
data source does not support a specified table type,
<function>odbc_tables</function> does not return any results for
that type.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier containing the information
or &false; on failure.
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
<listitem><simpara>TABLE_OWNER</simpara></listitem>
<listitem><simpara>TABLE_NAME</simpara></listitem>
<listitem><simpara>TABLE_TYPE</simpara></listitem>
<listitem><simpara>REMARKS</simpara></listitem>
</itemizedlist>
</para>
<simpara>
See also <function>odbc_tableprivileges</function> to retrieve
associated privileges.
The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER,
TABLE_OWNER and TABLE_NAME.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_tableprivileges</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file