sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.oracle: switch to new style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229089 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-06 01:46:48 +00:00
parent 8cdd8ed9a4
commit d449d9903f
23 changed files with 1005 additions and 213 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
reference/oracle/functions/ora-bind.xml
View file

@ -1,40 +1,142 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-bind">
<refnamediv>
<refname>ora_bind</refname>
<refpurpose>Binds a PHP variable to an Oracle parameter</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_bind</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
<methodparam><type>string</type><parameter>PHP_variable_name</parameter></methodparam>
<methodparam><type>string</type><parameter>SQL_parameter_name</parameter></methodparam>
<methodparam><type>string</type><parameter>phpvar</parameter></methodparam>
<methodparam><type>string</type><parameter>sqlparam</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
This function binds the named PHP variable with a SQL parameter.
The SQL parameter must be in the form ":name". With the optional
type parameter, you can define whether the SQL parameter is an
in/out (0, default), in (1) or out (2) parameter. As of PHP
3.0.1, you can use the constants ORA_BIND_INOUT, ORA_BIND_IN and
ORA_BIND_OUT instead of the numbers.
Binds the named PHP variable with a SQL parameter.
</para>
<para>
<function>ora_bind</function> must be called after
<function>ora_parse</function> and before <function>ora_exec</function>.
Input values can be given by assignment to the bound PHP variables, after
calling <function>ora_exec</function> the bound PHP variables contain the
output values if available.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>phpvar</parameter></term>
<listitem>
<para>
The PHP variable to be bound.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sqlparam</parameter></term>
<listitem>
<para>
The SQL parameter. Must be in the form <literal>:name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
Defines the type of the parameter. It defaults to
<constant>ORA_BIND_INOUT</constant>. Possible values are listed below:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>ORA_BIND_INOUT</constant></entry>
<entry>0</entry>
</row>
<row>
<entry><constant>ORA_BIND_IN</constant></entry>
<entry>1</entry>
</row>
<row>
<entry><constant>ORA_BIND_OUT</constant></entry>
<entry>2</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>
functions.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>3.0.1</entry>
<entry>
The constants for the <parameter>type</parameter> were added.
In previous versions, you should use the numerical values.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<function>ora_bind</function> must be called after <function>ora_parse</function>
and before <function>ora_exec</function>. Input values can be given
by assignment to the bound PHP variables, after calling
<function>ora_exec</function> the bound PHP variables contain the output
values if available.
<example>
<title><function>ora_bind</function> example</title>
<programlisting role="php">
@ -53,6 +155,7 @@
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/oracle/functions/ora-close.xml
View file

@ -1,21 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-close">
<refnamediv>
<refname>ora_close</refname>
<refpurpose>Closes an Oracle cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_close</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
This function closes a data cursor opened with
<function>ora_open</function>.
Closes a data <parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>

44
reference/oracle/functions/ora-columnname.xml
View file

@ -1,23 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-columnname">
<refnamediv>
<refname>ora_columnname</refname>
<refpurpose>Gets the name of an Oracle result column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_columnname</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Returns the name of the field/column
<parameter>column</parameter> on the cursor
<parameter>cursor</parameter>. The returned name is in all
uppercase letters. Column 0 is the first column.
Returns the name of the column on the <parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column number. First is 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name as a string. The returned name is in all uppercase letters.
</para>
</refsect1>
</refentry>

44
reference/oracle/functions/ora-columnsize.xml
View file

@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.10 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-columnsize">
<refnamediv>
<refname>ora_columnsize</refname>
<refpurpose>Returns the size of an Oracle result column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ora_columnsize</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Returns the size of the Oracle column
<parameter>column</parameter> on the cursor
<parameter>cursor</parameter>. Column 0 is the first column.
Returns the size of a <parameter>column</parameter> on the
<parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column number. First is 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the size as an integer, or &false; on error.
</para>
</refsect1>
</refentry>

45
reference/oracle/functions/ora-columntype.xml
View file

@ -1,23 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-columntype">
<refnamediv>
<refname>ora_columntype</refname>
<refpurpose>Gets the type of an Oracle result column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_columntype</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Returns the Oracle data type name of the field/column
<parameter>column</parameter> on the cursor
<parameter>cursor</parameter>. Column 0 is the first column. The returned
type will be one of the following:
Returns the Oracle data type name of the <parameter>column</parameter> on
the <parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column number. First is 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The returned type will be one of the following strings:
<simplelist>
<member><literal>"VARCHAR2"</literal></member>
<member><literal>"VARCHAR"</literal></member>

51
reference/oracle/functions/ora-commit.xml
View file

@ -1,33 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-commit">
<refnamediv>
<refname>ora_commit</refname>
<refpurpose>Commit an Oracle transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_commit</methodname>
<methodparam><type>resource</type><parameter>conn</parameter></methodparam>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
This function commits an Oracle transaction. A transaction is defined as
all the changes on a given connection since the last commit/rollback,
autocommit was turned off or when the connection was established.
Commits an Oracle transaction.
</para>
<para>
A transaction is defined as all the changes on a given connection since
the last commit/rollback, autocommit was turned off or when the connection
was established.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the
error can be retrieved using the <function>ora_error</function>
and <function>ora_errorcode</function> functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>ora_commiton</function> and
<function>ora_commitoff</function>.
<simplelist>
<member><function>ora_commiton</function></member>
<member><function>ora_commitoff</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

46
reference/oracle/functions/ora-commitoff.xml
View file

@ -1,32 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-commitoff">
<refnamediv>
<refname>ora_commitoff</refname>
<refpurpose>Disable automatic commit</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_commitoff</methodname>
<methodparam><type>resource</type><parameter>conn</parameter></methodparam>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
This function turns off automatic commit after each
<function>ora_exec</function> on the given connection.
Turns off automatic commit after each <function>ora_exec</function> on the
given connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>ora_commiton</function> and
<function>ora_commit</function>.
<simplelist>
<member><function>ora_commiton</function></member>
<member><function>ora_commit</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

44
reference/oracle/functions/ora-commiton.xml
View file

@ -1,32 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-commiton">
<refnamediv>
<refname>ora_commiton</refname>
<refpurpose>Enable automatic commit</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_commiton</methodname>
<methodparam><type>resource</type><parameter>conn</parameter></methodparam>
</methodsynopsis>
<para>
This function turns on automatic commit after each
<function>ora_exec</function> on the given connection.
Turns on automatic commit after each <function>ora_exec</function> on the
given connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>conn</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>ora_commitoff</function> and
<function>ora_commit</function>.
<simplelist>
<member><function>ora_commitoff</function></member>
<member><function>ora_commit</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

58
reference/oracle/functions/ora-do.xml
View file

@ -1,33 +1,71 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-do">
<refnamediv>
<refname>ora_do</refname>
<refpurpose>Parse, Exec, Fetch</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ora_do</methodname>
<methodparam><type>resource</type><parameter>conn</parameter></methodparam>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_do</function> is quick combination of <function>ora_parse</function>,
<function>ora_exec</function> and <function>ora_fetch</function>.
It will parse and execute a statement, then fetch the first result row.
Parse and execute a statement, then fetch the first result row.
</para>
<para>
This function is a quick combination of <function>ora_parse</function>,
<function>ora_exec</function> and <function>ora_fetch</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The SQL statement.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns a cursor index or &false; on failure. Details
about the error can be retrieved using the <function>ora_error</function>
and <function>ora_errorcode</function> functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ora_parse</function>,<function>ora_exec</function>,
and <function>ora_fetch</function>.
<simplelist>
<member><function>ora_parse</function></member>
<member><function>ora_exec</function></member>
<member><function>ora_fetch</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

79
reference/oracle/functions/ora-error.xml
View file

@ -1,17 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ora-error">
<refnamediv>
<refname>ora_error</refname>
<refpurpose>Gets an Oracle error message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>cursor_or_connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error message of the last executed statement on the
specified cursor or connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor_or_connection</parameter></term>
<listitem>
<para>
An Oracle cursor or connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an error message of the form
<replaceable>XXX</replaceable>-<replaceable>NNNNN</replaceable>
@ -19,25 +43,58 @@
from and <replaceable>NNNNN</replaceable> identifies the error
message.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<note>
<para>Support for connection ids was added in 3.0.4.</para>
</note>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>3.0.4</entry>
<entry>
Support for connection identifiers was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
On Unix versions of Oracle, you can find details about an error
message like this:
<computeroutput>
$ <userinput>oerr ora
<replaceable>00001</replaceable></userinput> 00001, 00000,
<informalexample>
<programlisting role="shell">
<![CDATA[
$> oerr ora 00001
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
00001, 00000,
"unique constraint (%s.%s) violated" // *Cause: An update or insert
statement attempted to insert a duplicate key // For Trusted
ORACLE configured in DBMS MAC mode, you may see // this message
if a duplicate entry exists at a different level. // *Action: Either
remove the unique restriction or do not insert the key
</computeroutput>
]]>
</screen>
</informalexample>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

60
reference/oracle/functions/ora-errorcode.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-errorcode">
<refnamediv>
<refname>ora_errorcode</refname>
<refpurpose>Gets an Oracle error code</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ora_errorcode</methodname>
<methodparam choice="opt"><type>resource</type><parameter>cursor_or_connection</parameter></methodparam>
@ -15,12 +15,56 @@
<para>
Returns the numeric error code of the last executed statement on
the specified cursor or connection.
<!-- FIXME: should possible values be listed? -->
<note>
<para>Support for connection ids was added in 3.0.4.</para>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor_or_connection</parameter></term>
<listitem>
<para>
An Oracle cursor or connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error code, as an integer.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>3.0.4</entry>
<entry>
Support for connection identifiers was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

57
reference/oracle/functions/ora-exec.xml
View file

@ -1,31 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-exec">
<refnamediv>
<refname>ora_exec</refname>
<refpurpose>Execute a parsed statement on an Oracle cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_exec</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_exec</function> execute the parsed statement
<parameter>cursor</parameter>, already parsed by <function>ora_parse</function>.
Executes the parsed statement <parameter>cursor</parameter>.
</para>
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
</para>
<simpara>
See also <function>ora_parse</function>,
<function>ora_fetch</function>, and <function>ora_do</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, already parsed by <function>ora_parse</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>
functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_parse</function></member>
<member><function>ora_fetch</function></member>
<member><function>ora_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

78
reference/oracle/functions/ora-fetch-into.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.ora-fetch-into">
<refnamediv>
<refname>ora_fetch_into</refname>
<refpurpose>Fetch a row into the specified result array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ora_fetch_into</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
@ -15,15 +15,56 @@
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Fetches a row of data into an array. The <parameter>flags</parameter>
has two flag values: if the <constant>ORA_FETCHINTO_NULLS</constant>
flag is set, columns with <constant>NULL</constant> values are set
in the array; and if the <constant>ORA_FETCHINTO_ASSOC</constant>
flag is set, an associative array is created.
Fetches a row of data into an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Returns the number of columns fetched.
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
An array passed by reference. It will be filled with the fetched
values.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
There are two possible flags.
If <constant>ORA_FETCHINTO_NULLS</constant> is set, columns with
<constant>NULL</constant> values are set in the array; and if the
<constant>ORA_FETCHINTO_ASSOC</constant> flag is set, an associative
array is created.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of columns fetched, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ora_fetch_into</function></title>
@ -42,11 +83,20 @@ echo $results['MyColumn'];
</programlisting>
</example>
</para>
<simpara>
See also <function>ora_parse</function>,<function>ora_exec</function>,
<function>ora_fetch</function>, and <function>ora_do</function>.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_parse</function></member>
<member><function>ora_exec</function></member>
<member><function>ora_fetch</function></member>
<member><function>ora_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

44
reference/oracle/functions/ora-fetch.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-fetch">
<refnamediv>
<refname>ora_fetch</refname>
<refpurpose>Fetch a row of data from a cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_fetch</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
@ -15,6 +15,26 @@
<para>
Retrieves a row of data from the specified <parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; (a row was fetched) or &false; (no more rows, or an
error occurred). If an error occurred, details can be retrieved
@ -22,11 +42,19 @@
<function>ora_errorcode</function> functions. If there was no
error, <function>ora_errorcode</function> will return 0.
</para>
<simpara>
See also <function>ora_parse</function>,<function>ora_exec</function>,
and <function>ora_do</function>.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_parse</function></member>
<member><function>ora_exec</function></member>
<member><function>ora_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/oracle/functions/ora-getcolumn.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-getcolumn">
<refnamediv>
<refname>ora_getcolumn</refname>
<refpurpose>Get data from a fetched column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_getcolumn</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
@ -16,6 +16,34 @@
<para>
Fetches the data for a column or function result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column number, as an integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the column data. If an error occurs, &false; is returned
and <function>ora_errorcode</function>

51
reference/oracle/functions/ora-logoff.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-logoff">
<refnamediv>
<refname>ora_logoff</refname>
<refpurpose>Close an Oracle connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_logoff</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -15,15 +15,42 @@
<para>
Logs out the user and disconnects from the server.
</para>
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
</para>
<simpara>
See also <function>ora_logon</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>
functions.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_logon</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/oracle/functions/ora-logon.xml
View file

@ -1,21 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ora-logon">
<refnamediv>
<refname>ora_logon</refname>
<refpurpose>Open an Oracle connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ora_logon</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Establishes a connection between PHP and an Oracle database with the
given username <parameter>user</parameter> and password <parameter>password</parameter>.
Establishes a connection between PHP and an Oracle database.
</para>
<para>
Connections can be made using <productname>SQL*Net</productname>
@ -37,8 +36,36 @@ $conn = Ora_Logon("user@TNSNAME", "pass");
environment. For server modules, you should set it in the
server's environment before starting the server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Returns a connection index on success, or &false; on failure.
<variablelist>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password associated with <parameter>user</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection identifier on success, or &false; on failure.
Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>
functions.

52
reference/oracle/functions/ora-numcols.xml
View file

@ -1,26 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-numcols">
<refnamediv>
<refname>ora_numcols</refname>
<refpurpose>Returns the number of columns</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ora_numcols</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_numcols</function> returns the number of columns in a result.
Only returns meaningful values after an parse/exec/fetch sequence.
Returns the number of columns in a result. It only returns meaningful
values after a parse/exec/fetch sequence.
</para>
<simpara>
See also <function>ora_parse</function>,<function>ora_exec</function>,
<function>ora_fetch</function>, and <function>ora_do</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of columns as an integer, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_parse</function></member>
<member><function>ora_exec</function></member>
<member><function>ora_fetch</function></member>
<member><function>ora_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/oracle/functions/ora-numrows.xml
View file

@ -1,19 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-numrows">
<refnamediv>
<refname>ora_numrows</refname>
<refpurpose>Returns the number of rows</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ora_numrows</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
</methodsynopsis>
<para>
<function>ora_numrows</function> returns the number of rows in a result.
Returns the number of rows in a result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows as an integer, or &false; on error.
</para>
</refsect1>
</refentry>

28
reference/oracle/functions/ora-open.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-open">
<refnamediv>
<refname>ora_open</refname>
<refpurpose>Opens an Oracle cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ora_open</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -15,6 +15,26 @@
<para>
Opens an Oracle cursor associated with connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a cursor index or &false; on failure. Details about the
error can be retrieved using the <function>ora_error</function>

63
reference/oracle/functions/ora-parse.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.ora-parse">
<refnamediv>
<refname>ora_parse</refname>
<refpurpose>Parse an SQL statement with Oracle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_parse</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
@ -15,17 +15,60 @@
<methodparam choice="opt"><type>int</type><parameter>defer</parameter></methodparam>
</methodsynopsis>
<para>
This function parses an SQL statement or a PL/SQL block and
associates it with the given cursor.
Parses an SQL statement or a PL/SQL block and associates it with the given
<parameter>cursor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sql_statement</parameter></term>
<listitem>
<para>
The SQL statement, or PL/SQL block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>defer</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<simpara>
See also <function>ora_exec</function>,
<function>ora_fetch</function>, and <function>ora_do</function>.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_exec</function></member>
<member><function>ora_fetch</function></member>
<member><function>ora_do</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

55
reference/oracle/functions/ora-plogon.xml
View file

@ -1,26 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-plogon">
<refnamediv>
<refname>ora_plogon</refname>
<refpurpose>Open a persistent Oracle connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ora_plogon</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Establishes a persistent connection between PHP and an Oracle database with
the username <parameter>user</parameter> and password <parameter>password</parameter>.
Establishes a persistent connection between PHP and an Oracle database/
</para>
<simpara>
See also <function>ora_logon</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password associated with <parameter>user</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a persistent connection identifier, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ora_logon</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/oracle/functions/ora-rollback.xml
View file

@ -1,26 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ora-rollback">
<refnamediv>
<refname>ora_rollback</refname>
<refpurpose>Rolls back a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ora_rollback</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
This function undoes an Oracle transaction. (See
<function>ora_commit</function> for the definition of a
transaction.)
Rollbacks an Oracle transaction.
</para>
<para>
&return.success; Details about the error
can be retrieved using the <function>ora_error</function> and
<function>ora_errorcode</function> functions.
See <function>ora_commit</function> for the definition of a transaction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection identifier, opened with <function>ora_logon</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Details about the error can be retrieved using the
<function>ora_error</function> and <function>ora_errorcode</function>
functions.
</para>
</refsect1>
</refentry>