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

updated OCI8 docs

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@195287 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Antony Dovgal 2005-09-06 20:18:30 +00:00
parent c4e4c387a0
commit b2da15136d
114 changed files with 2904 additions and 3325 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
reference/oci8/configure.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<section id="oci8.installation">
&reftitle.install;
<para>
@ -8,7 +8,8 @@
your environment variable ORACLE_HOME.
</para>
<para>
If you're using Oracle Instant Client, you need to build PHP with the option
If you're using <ulink url="&url.oracle.instant.client;">Oracle Instant
Client</ulink>, you need to build PHP with the option
<option role="configure">--with-oci8-instant-client[=DIR]</option>. Note
that Oracle Instant Client support first appeared in versions 4.3.11 and
5.0.4.

68
reference/oci8/constants.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<section id="oci8.constants">
&reftitle.constants;
&extension.constants;
@ -24,7 +24,7 @@
<listitem>
<simpara>
Statement execution mode. Use this mode if you don't want
to really execute query, but only get select-list description.
to execute the query, but get the select-list's description.
</simpara>
</listitem>
</varlistentry>
@ -383,6 +383,69 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OCI_SYSOPER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used with <function>oci_connect</function> to connect as SYSOPER
using external credentials (<link
linkend="ini.oci8.privileged_connect">oci8.privileged_connect</link>
should be enabled for this).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OCI_SYSDBA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used with <function>oci_connect</function> to connect as SYSDBA
using external credentials (<link
linkend="ini.oci8.privileged_connect">oci8.privileged_connect</link>
should be enabled for this).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OCI_LOB_BUFFER_FREE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used with <xref linkend="function.oci-lob-flush"/> to free buffers used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OCI_TEMP_CLOB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used with <xref linkend="function.oci-lob-writetemporary"/> to indicate
explicilty that temporary CLOB should be created.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OCI_TEMP_BLOB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used with <xref linkend="function.oci-lob-writetemporary"/> to indicate
explicilty that temporary BLOB should be created.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
@ -406,3 +469,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

72
reference/oci8/functions/OCI-Collection-append.xml
View file

@ -1,25 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.OCI-Collection-append">
<refnamediv>
<refname>OCI-Collection->append</refname>
<refpurpose>Appends an object to the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>OCI-Collection->append</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Appends an object to the end of the collection. Parameter
<parameter>value</parameter> can be a string or a number.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-append">
<refnamediv>
<refname>OCI-Collection->append</refname>
<refpurpose>Appends element to the collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>append</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Appends element to the end of the collection. Parameter
<parameter>value</parameter> can be a string or a number.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to be added to the collection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-assign" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

74
reference/oci8/functions/OCI-Collection-assign.xml
View file

@ -1,26 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.OCI-Collection-assign">
<refnamediv>
<refname>OCI-Collection->assign</refname>
<refpurpose>Assigns a value to the collection from another existing collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>OCI-Collection->assign</methodname>
<methodparam><type>OCI-Collection</type><parameter>from</parameter></methodparam>
</methodsynopsis>
<para>
Assigns a value to the collection from another, previously created
collection. Both collections must be created with
<function>oci_new_collection</function> prior to using them.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.oci-collection-assign">
<refnamediv>
<refname>OCI-Collection->assign</refname>
<refpurpose>Assigns a value to the collection from another existing collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>assign</methodname>
<methodparam><type>OCI-Collection</type><parameter>from</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Assigns a value to the collection from another, previously created
collection. Both collections must be created with
<function>oci_new_collection</function> prior to using them.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>from</parameter></term>
<listitem>
<para>
An instance of OCI-Collection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-append" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/oci8/functions/OCI-Collection-assignElem.xml
View file

@ -1,26 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.OCI-Collection-assignElem">
<refnamediv>
<refname>OCI-Collection->assignElem</refname>
<refpurpose>Assigns a value to the element of the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>OCI-Collection->assignElem</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Assigns a value to the element with index <parameter>index</parameter>.
Parameter <parameter>value</parameter> can be a string or a number.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-collection-element-assign">
<refnamediv>
<refname>OCI-Collection->assignElem</refname>
<refpurpose>Assigns a value to the element of the collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>assignElem</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Assigns a value to the element with index <parameter>index</parameter>.
Parameter <parameter>value</parameter> can be a string or a number.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-element-get" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

55
reference/oci8/functions/OCI-Collection-free.xml
View file

@ -1,24 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.OCI-Collection-free">
<refnamediv>
<refname>OCI-Collection->free</refname>
<refpurpose>Frees resources associated with collection object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>OCI-Collection->free</methodname>
<void />
</methodsynopsis>
<para>
Frees resources associated with collection object.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-collection-free">
<refnamediv>
<refname>OCI-Collection->free</refname>
<refpurpose>Frees the resources associated with the collection object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>free</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Frees the resources associated with the collection object.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-new-collection" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -40,3 +54,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

81
reference/oci8/functions/OCI-Collection-getElem.xml
View file

@ -1,32 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.OCI-Collection-getElem">
<refnamediv>
<refname>OCI-Collection->getElem</refname>
<refpurpose>Returns value of the element</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>OCI-Collection->getElem</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
<para>
Method <function>OCI-Collection->getElem</function> returns value of the
element with index <parameter>index</parameter> (1-based).
</para>
<para>
<function>OCI-Collection->getElem</function> will return &false; if
such element doesn't exist; &null; if element is &null;; string if
element is column of a string datatype or number if element is numeric
field.
</para>
<para>
<function>OCI-Collection->getElem</function> will return &false; in case of
error.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-element-get">
<refnamediv>
<refname>OCI-Collection->getElem</refname>
<refpurpose>Returns value of the element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>getElem</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Returns element's value with the index <parameter>index</parameter> (1-based).
</para>
<para>
<function>OCI-Collection->getElem</function> returns &false; if
such element doesn't exist; &null; if element is &null;; string if
element is column of a string datatype or number if element is numeric
field.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-element-assign" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -48,3 +72,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

55
reference/oci8/functions/OCI-Collection-max.xml
View file

@ -1,26 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.OCI-Collection-max">
<refnamediv>
<refname>OCI-Collection->max</refname>
<refpurpose>Gets the maximum number of elements in the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>OCI-Collection->max</methodname>
<void />
</methodsynopsis>
<para>
Returns the maximum number of elements in the collection.
If the returned value is 0, then the number of elements is not limited.
<function>OCI-Collection->max</function> returns &false; in case of error.
</para>
<para>
See also <function>oci_collection_size</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-max">
<refnamediv>
<refname>OCI-Collection->max</refname>
<refpurpose>Returns the maximum number of elements in the collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>max</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns the maximum number of elements in the collection.
If the returned value is 0, then the number of elements is not limited.
<function>OCI-Collection->max</function> returns &false; in case of error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-size" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

51
reference/oci8/functions/OCI-Collection-size.xml
View file

@ -1,24 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.OCI-Collection-size">
<refnamediv>
<refname>OCI-Collection->size</refname>
<refpurpose>Returns size of the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>OCI-Collection->size</methodname>
<void />
</methodsynopsis>
<para>
Returns the number of elements in the collection.
</para>
<para>
See also <function>oci_collection_max</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-size">
<refnamediv>
<refname>OCI-Collection->size</refname>
<refpurpose>Returns size of the collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>size</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns the number of elements in the collection or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-max" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

74
reference/oci8/functions/OCI-Collection-trim.xml
View file

@ -1,28 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.OCI-Collection-trim">
<refnamediv>
<refname>OCI-Collection->trim</refname>
<refpurpose>Trims elements from the end of the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>OCI-Collection->trim</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Trims <parameter>num</parameter> of elements from the end of the
collection.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_collection_size</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-trim">
<refnamediv>
<refname>OCI-Collection->trim</refname>
<refpurpose>Trims elements from the end of the collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Collection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>trim</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Trims <parameter>num</parameter> of elements from the end of the
collection.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-collection-size" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/oci8/functions/OCI-Lob-append.xml
View file

@ -1,35 +1,61 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
<refpurpose>Appends data from the large object to another large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->append</methodname>
<methodparam><type>OCI-Lob</type><parameter>lob_from</parameter></methodparam>
</methodsynopsis>
<para>
Appends data from the large object to the end of another large object.
</para>
<para>
Writing to the large object with <function>lob->append</function> will
fail if buffering was previously enabled. You must disable buffering
before appending. You may need to flush buffers with
<function>oci_lob_flush</function> before disabling buffering.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_flush</function>,
<function>ocisetbufferinglob</function> and
<function>ocigetbufferinglob</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>OCI-Lob->append</refname>
<refpurpose>Appends data from the large object to another large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>append</methodname>
<methodparam><type>OCI-Lob</type><parameter>lob_from</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Appends data from the large object to the end of another large object.
</para>
<para>
Writing to the large object with <function>OCI-Lob->append</function> will
fail if buffering was previously enabled. You must disable buffering
before appending. You may need to flush buffers with
<xref linkend="function.oci-lob-flush"/> before disabling buffering.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>lob_from</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-flush" /></member>
<member><xref linkend="function.oci-lob-setbuffering" /></member>
<member><xref linkend="function.oci-lob-getbuffering" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

69
reference/oci8/functions/OCI-Lob-close.xml
View file

@ -1,37 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-close">
<refnamediv>
<refname>lob->close</refname>
<refpurpose>Closes LOB descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->close</methodname>
<void />
</methodsynopsis>
<para>
<function>lob->close</function> closes descriptor of LOB or FILE. This
function should be used only with
<function>lob->writeTemporary</function>.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocicloselob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_close</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_write_temporary</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-close">
<refnamediv>
<refname>OCI-Lob->close</refname>
<refpurpose>Closes LOB descriptor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>close</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
<function>OCI-Lob->close</function> closes descriptor of LOB or FILE. This
function should be used only with
<xref linkend="function.oci-lob-writetemporary" />.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-writetemporary" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/oci8/functions/OCI-Lob-eof.xml
View file

@ -1,25 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-eof">
<refnamediv>
<refname>lob->eof</refname>
<refpurpose>Tests for end-of-file on a large object's descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->eof</methodname>
<void />
</methodsynopsis>
<para>
Returns &true; if internal pointer of large object is at the end of LOB.
Otherwise returns &false;.
</para>
<para>
See also <function>oci_lob_size</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-eof">
<refnamediv>
<refname>OCI-Lob->eof</refname>
<refpurpose>Tests for end-of-file on a large object's descriptor<</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>eof</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns &true; if internal pointer of large object is at the end of LOB.
Otherwise returns &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-size" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

94
reference/oci8/functions/OCI-Lob-erase.xml
View file

@ -1,33 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-erase">
<refnamediv>
<refname>lob->erase</refname>
<refpurpose>Erases a specified portion of the internal LOB data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->erase</methodname>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Erases a specified portion of the internal LOB data starting at a
specified <parameter>offset</parameter>. Parameters
<parameter>length</parameter> and <parameter>offset</parameter> are optional.
<function>lob->erase</function> erases all LOB data by default.
</para>
<para>
For BLOBs, erasing means that the existing LOB value is overwritten with
zero-bytes. For CLOBs, the existing LOB value is overwritten with spaces.
</para>
<para>
<function>lob->erase</function> returns the actual number of
characters/bytes erased or &false; in case of error.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-erase">
<refnamediv>
<refname>OCI-Lob->erase</refname>
<refpurpose>Erases a specified portion of the internal LOB data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>erase</methodname>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Erases a specified portion of the internal LOB data starting at a
specified <parameter>offset</parameter>. Parameters
<parameter>length</parameter> and <parameter>offset</parameter> are optional.
<function>OCI-Lob->erase</function> erases all LOB data by default.
</para>
<para>
For BLOBs, erasing means that the existing LOB value is overwritten with
zero-bytes. For CLOBs, the existing LOB value is overwritten with spaces.
</para>
<para>
<function>OCI-Lob->erase</function> returns the actual number of
characters/bytes erased or &false; in case of error.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-truncate" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

96
reference/oci8/functions/OCI-Lob-export.xml
View file

@ -1,30 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-export">
<refnamediv>
<refname>lob->export</refname>
<refpurpose>Exports LOB's contents to a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->export</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Exports LOB's contents to a file, which name is given in parameter
<parameter>filename</parameter>. Optional parameter
<parameter>start</parameter> indicates from what position to start export
and parameter <parameter>length</parameter> - length of data to be
exported.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-export">
<refnamediv>
<refname>OCI-Lob->export</refname>
<refpurpose>Exports LOB's contents to a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>export</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Exports LOB contents to a file. The file name is given in the parameter
<parameter>filename</parameter>. The optional parameter
<parameter>start</parameter> indicates from where to start exporting
and the parameter <parameter>length</parameter> - indicates the length of data to be
exported.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-import" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -46,3 +89,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

92
reference/oci8/functions/OCI-Lob-flush.xml
View file

@ -1,35 +1,65 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-flush">
<refnamediv>
<refname>lob->flush</refname>
<refpurpose>Flushes/writes buffer of the LOB to the server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->flush</methodname>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>
<function>lob->flush</function> actually writes data to the server.
By default, resources are not freed, but using flag
<constant>OCI_LOB_BUFFER_FREE</constant> you can do it explicitly.
Be sure you know what you're doing - next read/write operation to the
same part of LOB will involve a round-trip to the server and initialize
new buffer resources. It is recommended to use
<constant>OCI_LOB_BUFFER_FREE</constant> flag only when you are not going
to work with the LOB anymore.
</para>
<para>
<function>lob->flush</function> returns &false; if buffering was not
enabled or an error occurred.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-flush">
<refnamediv>
<refname>OCI-Lob->flush</refname>
<refpurpose>Flushes/writes buffer of the LOB to the server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>flush</methodname>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>OCI-Lob->flush</function> actually writes data to the server.
By default, resources are not freed, but using flag
<constant>OCI_LOB_BUFFER_FREE</constant> you can do it explicitly.
Be sure you know what you're doing - next read/write operation to the
same part of LOB will involve a round-trip to the server and initialize
new buffer resources. It is recommended to use
<constant>OCI_LOB_BUFFER_FREE</constant> flag only when you are not going
to work with the LOB anymore.
</para>
<para>
<function>OCI-Lob->flush</function> returns &false; if buffering was not
enabled or an error occurred.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flag</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-getbuffering" /></member>
<member><xref linkend="function.oci-lob-setbuffering" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

47
reference/oci8/functions/OCI-Lob-free.xml
View file

@ -1,25 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-free-descriptor">
<refnamediv>
<refname>descriptor->free</refname>
<refpurpose>Frees resources associated with descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>descriptor->free</methodname>
<void />
</methodsynopsis>
<para>
<function>descriptor->free</function> frees resources associated with
descriptor, previously allocated with <function>oci_new_descriptor</function>.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-free">
<refnamediv>
<refname>OCI-Lob->free</refname>
<refpurpose>Frees resources associated with the LOB descriptor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>free</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Frees resources associated with the descriptor, previously allocated with
<function>oci_new_descriptor</function>.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

53
reference/oci8/functions/OCI-Lob-getBuffering.xml
View file

@ -1,25 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ocigetbufferinglob">
<refnamediv>
<refname>lob->getBuffering</refname>
<refpurpose>Returns current state of buffering for large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->getBuffering</methodname>
<void/>
</methodsynopsis>
<para>
Returns &false; if buffering for the large object is off and &true; if
buffering is used.
</para>
<para>
See also <function>ocisetbufferinglob</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-getbuffering">
<refnamediv>
<refname>OCI-Lob->getBuffering</refname>
<refpurpose>Returns current state of buffering for the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>getBuffering</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Returns &false; if buffering for the large object is off and &true; if
buffering is used.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-setbuffering" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/oci8/functions/OCI-Lob-import.xml
View file

@ -1,33 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-import">
<refnamediv>
<refname>lob->import</refname>
<refpurpose>Imports file data to the LOB</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->import</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Writes data from <parameter>filename</parameter> in to the current
position of large object.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocisavelobfile</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_import</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-import">
<refnamediv>
<refname>OCI-Lob->import</refname>
<refpurpose>Imports file data to the LOB</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>import</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Writes data from the <parameter>filename</parameter> in to the current
position of large object.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-export" /></member>
<member><xref linkend="function.oci-lob-write" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/oci8/functions/OCI-Lob-load.xml
View file

@ -1,33 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-load">
<refnamediv>
<refname>lob->load</refname>
<refpurpose>Returns large object's contents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lob->load</methodname>
<void />
</methodsynopsis>
<para>
Returns large object's contents. As script execution is terminated
when the <link linkend="ini.memory-limit">memory_limit</link> is reached,
ensure that the LOB does not exceed this limit. In most cases it's
recommended to use <function>oci_lob_read</function> instead. In case of
error <function>lob->load</function> returns &false;.
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociloadlob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_load</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-load">
<refnamediv>
<refname>OCI-Lob->load</refname>
<refpurpose>Returns large object's contents</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>load</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns large object's contents. As script execution is terminated
when the <link linkend="ini.memory-limit">memory_limit</link> is reached,
ensure that the LOB does not exceed this limit. In most cases it's
recommended to use <xref linkend="function.oci-lob-read" /> instead.
In case of error <function>OCI-Lob->load</function> returns &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-read" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

84
reference/oci8/functions/OCI-Lob-read.xml
View file

@ -1,34 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-read">
<refnamediv>
<refname>lob->read</refname>
<refpurpose>Reads part of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lob->read</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Reads <parameter>length</parameter> bytes from the current position of
LOB's internal pointer. Reading stops when <parameter>length</parameter>
bytes have been read or end of large object is reached.
Internal pointer of large object will be shifted on the amount of bytes
read.
</para>
<para>
Returns &false; in case of error.
</para>
<para>
See also <function>oci_lob_eof</function>,
<function>oci_lob_seek</function>,
<function>oci_lob_tell</function> and
<function>oci_lob_write</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-read">
<refnamediv>
<refname>OCI-Lob->read</refname>
<refpurpose>Reads part of the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>read</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Reads <parameter>length</parameter> bytes from the current position of LOB's internal pointer.
Reading stops when <parameter>length</parameter> bytes have been read or
end of the large object is reached. Internal pointer of the large object will
be shifted on the amount of bytes read.
</para>
<para>
Returns &false; in case of error.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-load" /></member>
<member><xref linkend="function.oci-lob-write" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -50,3 +73,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

60
reference/oci8/functions/OCI-Lob-rewind.xml
View file

@ -1,28 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-rewind">
<refnamediv>
<refname>lob->rewind</refname>
<refpurpose>Moves the internal pointer to the beginning of the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->rewind</methodname>
<void />
</methodsynopsis>
<para>
Sets the internal pointer to the beginning of the large object.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_seek</function> and
<function>oci_lob_tell</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-rewind">
<refnamediv>
<refname>OCI-Lob->rewind</refname>
<refpurpose>Moves the internal pointer to the beginning of the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>rewind</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Sets the internal pointer to the beginning of the large object.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-seek" /></member>
<member><xref linkend="function.oci-lob-tell" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

97
reference/oci8/functions/OCI-Lob-save.xml
View file

@ -1,39 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-save">
<refnamediv>
<refname>lob->save</refname>
<refpurpose>Saves data to the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->save</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
Saves <parameter>data</parameter> to the large object.
Parameter <parameter>offset</parameter> can be used to indicate offset
from the beginning of the large object.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocisavelob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_save</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_write</function> and
<function>oci_lob_import</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-save">
<refnamediv>
<refname>OCI-Lob->save</refname>
<refpurpose>Saves data to the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>save</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Saves <parameter>data</parameter> to the large object.
Parameter <parameter>offset</parameter> can be used to indicate offset
from the beginning of the large object.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-write" /></member>
<member><xref linkend="function.oci-lob-import" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

117
reference/oci8/functions/OCI-Lob-seek.xml
View file

@ -1,44 +1,81 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-seek">
<refnamediv>
<refname>lob->seek</refname>
<refpurpose>Sets the internal pointer of the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>
<para>
Sets the internal pointer of the large object. Parameter
<parameter>offset</parameter> indicates the amount of
bytes, on which internal pointer should be moved from the position,
pointed by <parameter>whence</parameter>:
<simplelist>
<member>
<constant>OCI_SEEK_SET</constant> - sets the position equal to
<parameter>offset</parameter>
</member>
<member>
<constant>OCI_SEEK_CUR</constant> - adds <parameter>offset</parameter>
bytes to the current position
</member>
<member>
<constant>OCI_SEEK_END</constant> - adds <parameter>offset</parameter>
bytes to the end of large object (use negative value to move to a position
before the end of large object)
</member>
</simplelist>
</para>
<para>
See also <function>oci_lob_rewind</function> and
<function>oci_lob_tell</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-seek">
<refnamediv>
<refname>OCI-Lob->seek</refname>
<refpurpose>Sets the internal pointer of the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Sets the internal pointer of the large object. Parameter
<parameter>offset</parameter> indicates the amount of
bytes, on which internal pointer should be moved from the position,
pointed by <parameter>whence</parameter>:
<simplelist>
<member>
<constant>OCI_SEEK_SET</constant> - sets the position equal to
<parameter>offset</parameter>
</member>
<member>
<constant>OCI_SEEK_CUR</constant> - adds <parameter>offset</parameter>
bytes to the current position
</member>
<member>
<constant>OCI_SEEK_END</constant> - adds <parameter>offset</parameter>
bytes to the end of large object (use negative value to move to a position
before the end of large object)
</member>
</simplelist>
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whence</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-rewind" /></member>
<member><xref linkend="function.oci-lob-tell" /></member>
<member><xref linkend="function.oci-lob-eof" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

94
reference/oci8/functions/OCI-Lob-setBuffering.xml
View file

@ -1,38 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.ocisetbufferinglob">
<refnamediv>
<refname>lob->setBuffering</refname>
<refpurpose>Changes current state of buffering for large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->setBuffering</methodname>
<methodparam><type>bool</type><parameter>on_off</parameter></methodparam>
</methodsynopsis>
<para>
<function>lob->setBuffering</function> sets the buffering for the
large object, depending on the value of the <parameter>on_off</parameter>
parameter. Repeated calls to <function>lob->setBuffering</function> with
the same flag will return &true;. The values for <parameter>on_off
</parameter> are: &true; for on and &false; for off.
</para>
<para>
Use of this function may provide performance improvements by buffering
small reads and writes of LOBs by reducing the number of network
round-trips and LOB versions. <function>oci_lob_flush</function> should
be used to flush buffers, when you have finished working with the large
object.
</para>
<para>
&return.success;
</para>
<para>
See also <function>ocigetbufferinglob</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-setbuffering">
<refnamediv>
<refname>OCI-Lob->setBuffering</refname>
<refpurpose>Changes current state of buffering for the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>setBuffering</methodname>
<methodparam><type>bool</type><parameter>on_off</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>lob->setBuffering</function> sets the buffering for the
large object, depending on the value of the <parameter>on_off</parameter>
parameter. Repeated calls to <function>lob->setBuffering</function> with
the same flag will return &true;. The values for <parameter>on_off
</parameter> are: &true; for on and &false; for off.
</para>
<para>
Use of this function may provide performance improvements by buffering
small reads and writes of LOBs by reducing the number of network
round-trips and LOB versions. <function>oci_lob_flush</function> should
be used to flush buffers, when you have finished working with the large
object.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>on_off</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-getbuffering" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

41
reference/oci8/functions/OCI-Lob-size.xml
View file

@ -1,22 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-size">
<refnamediv>
<refname>lob->size</refname>
<refpurpose>Returns size of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->size</methodname>
<void />
</methodsynopsis>
<para>
Returns length of large object value or &false; in case of error.
Empty objects have zero length.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-size">
<refnamediv>
<refname>OCI-Lob->size</refname>
<refpurpose>Returns size of large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>size</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns length of large object value or &false; in case of error.
Empty objects have zero length.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

57
reference/oci8/functions/OCI-Lob-tell.xml
View file

@ -1,26 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-tell">
<refnamediv>
<refname>lob->tell</refname>
<refpurpose>Returns current position of internal pointer of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->tell</methodname>
<void />
</methodsynopsis>
<para>
Returns current position of a LOB's internal pointer or &false; if an
error occurred.
</para>
<para>
See also <function>oci_lob_size</function> and
<function>oci_lob_eof</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-tell">
<refnamediv>
<refname>OCI-Lob->tell</refname>
<refpurpose>Returns current position of internal pointer of large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>tell</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns current position of a LOB's internal pointer or &false; if an
error occurred.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-rewind" /></member>
<member><xref linkend="function.oci-lob-size" /></member>
<member><xref linkend="function.oci-lob-eof" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

79
reference/oci8/functions/OCI-Lob-truncate.xml
View file

@ -1,30 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-truncate">
<refnamediv>
<refname>lob->truncate</refname>
<refpurpose>Truncates large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->truncate</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
If parameter <parameter>length</parameter> is given,
<function>lob->truncate</function> truncates large object to
<parameter>length</parameter> bytes. Otherwise,
<function>lob->truncate</function> will purge the LOB completely.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_erase</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-truncate">
<refnamediv>
<refname>OCI-Lob->truncate</refname>
<refpurpose>Truncates large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>truncate</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
If parameter <parameter>length</parameter> is given,
<function>OCI-Lob->truncate</function> truncates large object to
<parameter>length</parameter> bytes. Otherwise,
<function>OCI-Lob->truncate</function> will purge the LOB completely.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-erase" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
@ -46,4 +72,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

92
reference/oci8/functions/OCI-Lob-write.xml
View file

@ -1,33 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-write">
<refnamediv>
<refname>lob->write</refname>
<refpurpose>Writes data to the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->write</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Writes data from the parameter <parameter>data</parameter> into the
current position of LOB's internal pointer.
If the parameter <parameter>length</parameter> is given, writing will
stop after <parameter>length</parameter> bytes have been written or the
end of <parameter>data</parameter> is reached, whichever comes first.
</para>
<para>
<function>lob->write</function> returns the number of bytes written or
&false; in case of error.
</para>
<para>
See also <function>oci_lob_read</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-write">
<refnamediv>
<refname>OCI-Lob->write</refname>
<refpurpose>Writes data to the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>write</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Writes data from the parameter <parameter>data</parameter> into the
current position of LOB's internal pointer.
If the parameter <parameter>length</parameter> is given, writing will
stop after <parameter>length</parameter> bytes have been written or the
end of <parameter>data</parameter> is reached, whichever comes first.
</para>
<para>
<function>OCI-Lob->write</function> returns the number of bytes written or
&false; in case of error.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-read" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

120
reference/oci8/functions/OCI-Lob-writeTemporary.xml
View file

@ -1,55 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-write-temporary">
<refnamediv>
<refname>lob->writeTemporary</refname>
<refpurpose>Writes temporary large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->writeTemporary</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>lob_type</parameter></methodparam>
</methodsynopsis>
<para>
Creates a temporary large object and writes <parameter>data</parameter>
to it.
</para>
<para>
Parameter <parameter>lob_type</parameter> can be one of the following:
<simplelist>
<member>
<constant>OCI_TEMP_BLOB</constant> is used to create temporary BLOBs
</member>
<member>
<constant>OCI_TEMP_CLOB</constant> is used to create temporary CLOBs
</member>
</simplelist>
</para>
<para>
<function>lob->writeTemporary</function> creates a CLOB by default.
</para>
<para>
You should use <function>oci_lob_close</function> when the work with the
object is over.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociwritetemporarylob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_write_temporary</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_close</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-writetemporary">
<refnamediv>
<refname>OCI-Lob->writeTemporary</refname>
<refpurpose>Writes temporary large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>OCI-Lob</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeTemporary</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>lob_type</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Creates a temporary large object and writes <parameter>data</parameter>
to it.
</para>
<para>
Parameter <parameter>lob_type</parameter> can be one of the following:
<simplelist>
<member>
<constant>OCI_TEMP_BLOB</constant> is used to create temporary BLOBs
</member>
<member>
<constant>OCI_TEMP_CLOB</constant> is used to create temporary CLOBs
</member>
</simplelist>
</para>
<para>
<function>OCI-Lob->writeTemporary</function> creates a CLOB by default.
</para>
<para>
You should use <xref linkend="function.oci-lob-close" /> when the work with the
object is over.
</para>
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>lob_type</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-lob-close" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

5
reference/oci8/functions/oci-bind-by-name.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.oci-bind-by-name">
<refnamediv>
<refname>oci_bind_by_name</refname>
@ -171,7 +171,7 @@ oci_close($conn);
</example>
</para>
<para>
Remember, that this function strips trailing whitespace. See the following
Remember, this function strips trailing whitespaces. See the following
example:
</para>
<para>
@ -262,3 +262,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/oci8/functions/oci-cancel.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-cancel">
<refnamediv>
<refname>oci_cancel</refname>

14
reference/oci8/functions/oci-close.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-close">
<refnamediv>
<refname>oci_close</refname>
@ -17,11 +17,11 @@
</para>
<note>
<para>
As non-persistent links are closed automatically at the end of script
execution, calling this function is not required. Because of this and
the method the extension uses to handle connection resources,
<function>oci_close</function> currently provides no actual
functionality.
Starting from the version 1.1 <function>oci_close</function> correctly
closes the Oracle connection.
Use <link
linkend="ini.oci8.old_oci_close_semantics">oci8.old_oci_close_semantics</link>
option to restore old behaviour of this function.
</para>
</note>
<para>
@ -29,7 +29,7 @@
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociclose</function> instead.
In PHP versions before 5.0.0 you must use <function>ocilogoff</function> instead.
This name still can be used, it was left as alias of
<function>oci_close</function> for downwards compatability.
This, however, is deprecated and not recommended.

10
reference/oci8/functions/oci-commit.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-commit">
<refnamediv>
<refname>oci_commit</refname>
@ -61,6 +61,14 @@
<para>
&return.success;
</para>
<note>
<para>
Transactions are automatically rolled back when you close
the connection, or when the script ends, whichever is soonest. You
need to explicitly call <function>oci_commit</function> to commit
the transaction, or <function>oci_rollback</function> to abort it.
</para>
</note>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocicommit</function> instead.

55
reference/oci8/functions/oci-connect.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.oci-connect">
<refnamediv>
<refname>oci_connect</refname>
<refpurpose>Establishes a connection to Oracle server</refpurpose>
<refpurpose>Establishes a connection to the Oracle server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_connect</function> returns a connection identifier
@ -26,14 +27,41 @@
(<filename>tnsnames.ora</filename>) to determine which database
to connect to.
</para>
<para>
Parameter <parameter>session_mode</parameter> is available since version
1.1 and accepts the following values: <constant>OCI_DEFAULT</constant>,
<constant>OCI_SYSOPER</constant> and <constant>OCI_SYSDBA</constant>.
If either <constant>OCI_SYSOPER</constant> or
<constant>OCI_SYSDBA</constant> were specified,
<function>oci_connect</function> will try to establish privileged
connection using external credentials. Privileged connections are
disabled by default. To enable them you need to set <link
linkend="ini.oci8.privileged_connect">oci8.privileged_connect</link>
to On.
</para>
<note>
<simpara>
<function>oci_connect</function> <emphasis>does not</emphasis> reestablish
the connection, if a connection with such parameters was established
before. In this case, <function>oci_connect</function> will return
identifier of previously opened connection. This means, that you cannot
use this function to separate transactions. To establish a distinctly new
connection, use <function>oci_new_connect</function>.
If you're using PHP with Oracle Instant Client, you can use easy connect
naming method described here:
<ulink
url="http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306">
http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</ulink>.
Basically this means you can specify "//db_host[:port]/database_name"
as database name. But if you want to use the old way of naming you
<emphasis>must</emphasis> set either <constant>ORACLE_HOME</constant> or
<constant>TNS_ADMIN</constant>.
</simpara>
</note>
<note>
<simpara>
The second and subsequent calls to <function>oci_connect</function>
with the same parameters will return the connection handle returned
from the first call. This means that queries issued against one
handle are also applied to the other handles, because they are the
<emphasis>same</emphasis> handle. This behaviour is demonstrated in
Example 1 below. If you require two handles to be transactionally
isolated from each other, you should use
<function>oci_new_connect</function> instead.
</simpara>
</note>
&oci.charset;
@ -139,13 +167,15 @@ echo "</pre>";
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocilogon</function> instead.
This name still can be used, it was left as alias of
This name still can be used, it was left as the alias of
<function>oci_connect</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note> <simpara>
See also <function>oci_pconnect</function> and
<function>oci_new_connect</function>.
</note>
<simpara>
See also <function>oci_pconnect</function>,
<function>oci_new_connect</function> and
<function>oci_close</function>.
</simpara>
</refsect1>
</refentry>
@ -170,3 +200,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

9
reference/oci8/functions/oci-define-by-name.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-define-by-name">
<refnamediv>
<refname>oci_define_by_name</refname>
@ -18,12 +18,12 @@
</methodsynopsis>
<para>
<function>oci_define_by_name</function> defines PHP variables for fetches
of SQL-Columns. Be careful that Oracle uses ALL-UPPERCASE column names,
whereby in your select you can also write lowercase.
of SQL-Columns. Take into consideration that Oracle uses ALL-UPPERCASE column names,
whereby in your select you can also use lowercase.
<function>oci_define_by_name</function> expects
the <parameter>column_name</parameter> to be in uppercase. If you
define a variable that doesn't exists in your select statement, no
error will issued.
error will be issued.
</para>
<para>
If you need to define an abstract datatype (LOB/ROWID/BFILE) you
@ -91,3 +91,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/oci8/functions/oci-error.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.oci-error">
<refnamediv>
<refname>oci_error</refname>

9
reference/oci8/functions/oci-execute.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-execute">
<refnamediv>
<refname>oci_execute</refname>
@ -21,6 +21,13 @@
you should specify <constant>OCI_DEFAULT</constant> as your
<parameter>mode</parameter>.
</para>
<para>
When using <constant>OCI_DEFAULT</constant> mode, you're creating a
transaction. Transactions are automatically rolled back when you close
the connection, or when the script ends, whichever is soonest. You
need to explicitly call <function>oci_commit</function> to commit
the transaction, or <function>oci_rollback</function> to abort it.
</para>
<para>
&return.success;
</para>

5
reference/oci8/functions/oci-fetch-all.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.oci-fetch-all">
<refnamediv>
<refname>oci_fetch_all</refname>
@ -19,7 +19,7 @@
<function>oci_fetch_all</function> fetches all the rows from a
result into a user-defined array.
<function>oci_fetch_all</function> returns the number of rows
fetched or &false; in case of error. <parameter>skip</parameter>
fetched or &false; in case of an error. <parameter>skip</parameter>
is the number of initial rows to ignore when fetching the result
(default value of 0, to start at the first line).
<parameter>maxrows</parameter> is the number of
@ -122,3 +122,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

12
reference/oci8/functions/oci-fetch-array.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-fetch-array">
<refnamediv>
<refname>oci_fetch_array</refname>
@ -16,7 +16,7 @@
</methodsynopsis>
<para>
Returns an array, which corresponds to the next result row or &false; in
case of error or there is no more rows in the result.
case of error or there are no more rows in the result.
</para>
<para>
<function>oci_fetch_array</function> returns an array with both
@ -24,7 +24,7 @@
</para>
&database.fetch-null;
<para>
Optional second parameter can be any combination of the following
An optional second parameter can be any combination of the following
constants:
<simplelist>
<member>
@ -58,8 +58,7 @@
</para>
<note>
<simpara>
Don't forget, that Oracle returns all field names in uppercase and
associative indices in the result array will be uppercased too.
Oracle returns all field names in uppercase and associative indices in the result array will be uppercased too.
</simpara>
</note>
<para>
@ -185,3 +184,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

10
reference/oci8/functions/oci-fetch-assoc.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-fetch-assoc">
<refnamediv>
<refname>oci_fetch_assoc</refname>
@ -19,13 +19,12 @@
</para>
&database.fetch-null;
<para>
Subsequent call to <function>oci_fetch_assoc</function> will return
next row or &false; if there is no more rows.
A subsequent call to <function>oci_fetch_assoc</function> will return
the next row or &false; if there are no more rows.
</para>
<note>
<simpara>
Don't forget, that Oracle returns all field names in uppercase and
associative indices in the result array will be uppercased too.
Oracle returns all field names in uppercase and associative indices in the result array will be uppercased too.
</simpara>
</note>
<para>
@ -57,3 +56,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8
reference/oci8/functions/oci-fetch-object.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-fetch-object">
<refnamediv>
<refname>oci_fetch_object</refname>
@ -18,12 +18,11 @@
&database.fetch-null;
<para>
Subsequent calls to <function>oci_fetch_object</function> will return the
next row from the result or &false; if there is no more rows.
next row from the result or &false; if there are no more rows.
</para>
<note>
<simpara>
Don't forget, that Oracle returns all field names in uppercase and
attributes' names in the result object will be in uppercase as well.
Oracle returns all field names in uppercase and attributes' names in the result object will be in uppercase as well.
</simpara>
</note>
<para>
@ -55,3 +54,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

5
reference/oci8/functions/oci-fetch-row.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-fetch-row">
<refnamediv>
<refname>oci_fetch_row</refname>
@ -20,7 +20,7 @@
&database.fetch-null;
<para>
Subsequent calls to <function>oci_fetch_row</function> will return the
next row from the result data or &false; if there is no more rows.
next row from the result data or &false; if there are no more rows.
</para>
<para>
See also <function>oci_fetch_array</function>,
@ -51,3 +51,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/oci8/functions/oci-field-name.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-field-name">
<refnamediv>
<refname>oci_field_name</refname>

2
reference/oci8/functions/oci-field-precision.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-field-precision">
<refnamediv>
<refname>oci_field_precision</refname>

2
reference/oci8/functions/oci-field-scale.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-field-scale">
<refnamediv>
<refname>oci_field_scale</refname>

2
reference/oci8/functions/oci-field-size.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-field-size">
<refnamediv>
<refname>oci_field_size</refname>

2
reference/oci8/functions/oci-field-type-raw.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-field-type-raw">
<refnamediv>
<refname>oci_field_type_raw</refname>

2
reference/oci8/functions/oci-field-type.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-field-type">
<refnamediv>
<refname>oci_field_type</refname>

2
reference/oci8/functions/oci-internal-debug.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-internal-debug">
<refnamediv>
<refname>oci_internal_debug</refname>

12
reference/oci8/functions/oci-lob-copy.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-lob-copy">
<refnamediv>
<refname>oci_lob_copy</refname>
@ -14,14 +14,13 @@
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Copies large object or a part of large object to another large object.
Copies a large object or a part of a large object to another large object.
Parameter <parameter>length</parameter> indicates the length of data to
be copied. Old data of LOB-recipient will be overwritten.
be copied. Old LOB-recipient data will be overwritten.
</para>
<para>
If you need to copy a particular part of LOB to a particular position of
LOB, you can use <function>oci_lob_seek</function> to move internal
pointers of LOBs.
If you need to copy a particular part of a LOB to a particular position of
a LOB, use <function>oci_lob_seek</function> to move LOB internal pointers.
</para>
<para>
&return.success;
@ -50,3 +49,4 @@ vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

9
reference/oci8/functions/oci-new-collection.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-new-collection">
<refnamediv>
<refname>oci_new_collection</refname>
@ -14,11 +14,11 @@
<methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
</methodsynopsis>
<para>
Allocates new collection object. Parameter <parameter>tdo</parameter>
should be a valid named type (uppercased). Third, optional parameter
Allocates a new collection object. Parameter <parameter>tdo</parameter>
should be a valid named type (uppercase). The third, optional parameter
<parameter>schema</parameter> should point to the scheme, where the
named type was created. <function>oci_new_collection</function> uses
name of the current user as default value of <parameter>schema</parameter>.
the name of the current user as the default value of <parameter>schema</parameter>.
</para>
<para>
<function>oci_new_collection</function> returns &false; on error.
@ -54,3 +54,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

44
reference/oci8/functions/oci-new-connect.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.oci-new-connect">
<refnamediv>
<refname>oci_new_connect</refname>
@ -13,24 +13,50 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_new_connect</function> creates a new connection to an Oracle
server and logs on. The optional third parameter can either contain the name
<function>oci_new_connect</function> establishes a new connection to
an Oracle server and logs on. Unlike <function>oci_connect</function> and
<function>oci_pconnect</function>, <function>oci_new_connect</function>
does not cache connections and will always return a brand-new freshly
opened connection handle. This is useful if your application needs
transactional isolation between two sets of queries.
</para>
<para>
The optional third parameter can either contain the name
of the local Oracle instance or the name of the entry in
<filename>tnsnames.ora</filename>. If the third parameter is not specified,
PHP uses environment variables <literal>ORACLE_SID</literal> and
<literal>TWO_TASK</literal> to determine the name of local Oracle
instance and location of <filename>tnsnames.ora</filename> accordingly.
</para>
&oci.charset;
<para>
<function>oci_new_connect</function> forces the creation of a new connection.
This should be used if you need to isolate a set of transactions. By
default, connections are shared and subsequent calls to
<function>oci_connect</function> will return the same connection
identifier.
Parameter <parameter>session_mode</parameter> is available since version
1.1 and accepts the following values: <constant>OCI_DEFAULT</constant>,
<constant>OCI_SYSOPER</constant> and <constant>OCI_SYSDBA</constant>.
If either <constant>OCI_SYSOPER</constant> or
<constant>OCI_SYSDBA</constant> were specified,
<function>oci_new_connect</function> will try to establish privileged
connection using external credentials. Privileged connections are
disabled by default. To enable them you need to set <link
linkend="ini.oci8.privileged_connect">oci8.privileged_connect</link>
to On.
</para>
<note>
<simpara>
If you're using PHP with Oracle Instant Client, you can use easy connect
naming method described here:
<ulink
url="http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306">
http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</ulink>.
Basically this means you can specify "//db_host[:port]/database_name"
as database name. But if you want to use the old way of naming you
<emphasis>must</emphasis> set either <constant>ORACLE_HOME</constant> or
<constant>TNS_ADMIN</constant>.
</simpara>
</note>
&oci.charset;
<para>
The following demonstrates how you can separate connections.
<example>

2
reference/oci8/functions/oci-new-cursor.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-new-cursor">
<refnamediv>
<refname>oci_new_cursor</refname>

2
reference/oci8/functions/oci-new-descriptor.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.oci-new-descriptor">
<refnamediv>
<refname>oci_new_descriptor</refname>

2
reference/oci8/functions/oci-num-rows.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-num-rows">
<refnamediv>
<refname>oci_num_rows</refname>

2
reference/oci8/functions/oci-parse.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-parse">
<refnamediv>
<refname>oci_parse</refname>

15
reference/oci8/functions/oci-password-change.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.oci-password-change">
<refnamediv>
<refname>oci_password_change</refname>
@ -14,12 +14,25 @@
<methodparam><type>string</type><parameter>old_password</parameter></methodparam>
<methodparam><type>string</type><parameter>new_password</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>oci_password_change</methodname>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>old_password</parameter></methodparam>
<methodparam><type>string</type><parameter>new_password</parameter></methodparam>
</methodsynopsis>
<para>
Changes password for user with <parameter>username</parameter>.
Parameters <parameter>old_password</parameter> and
<parameter>new_password</parameter> should indicate old and new passwords
respectively.
</para>
<note>
<simpara>
The second <function>oci_password_change</function> syntax is available
since version 1.1.
</simpara>
</note>
<para>
&return.success;
</para>

59
reference/oci8/functions/oci-pconnect.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.oci-pconnect">
<refnamediv>
<refname>oci_pconnect</refname>
@ -13,29 +13,66 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_pconnect</function> creates a new persistent connection to
an Oracle server and logs on. The optional third parameter can either contain
<function>oci_pconnect</function> creates a persistent connection
to an Oracle server and logs on. Persistent connections are cached
and re-used between requests, resulting in reduced overhead on each
page load; a typical PHP application will have a single persistent
connection open against an Oracle server per Apache child process
(or PHP FastCGI/CGI process). See the <link
linkend="features.persistent-connections">Persistent Database
Connections</link> section for more information.
</para>
<note>
<simpara>
Starting with version 1.1 of the oci8 extension, the lifetime and
maximum amount of persistent Oracle connections can be tuned by setting
the following configuration values: <link
linkend="ini.oci8.persistent_timeout">oci8.persistent_timeout</link>,
<link linkend="ini.oci8.ping_interval">oci8.ping_interval</link> and
<link linkend="ini.oci8.max_persistent">oci8.max_persistent</link>.
</simpara>
</note>
<para>
The optional third parameter can either contain
the name of the local Oracle instance or the name of the entry in
<filename>tnsnames.ora</filename>. If the third parameter is not specified,
PHP uses environment variables <literal>ORACLE_SID</literal> and
<literal>TWO_TASK</literal> to determine the name of local Oracle
instance and location of <filename>tnsnames.ora</filename> accordingly.
</para>
<para>
Parameter <parameter>session_mode</parameter> is available since version
1.1 and accepts the following values: <constant>OCI_DEFAULT</constant>,
<constant>OCI_SYSOPER</constant> and <constant>OCI_SYSDBA</constant>.
If either <constant>OCI_SYSOPER</constant> or
<constant>OCI_SYSDBA</constant> were specified,
<function>oci_connect</function> will try to establish privileged
connection using external credentials. Privileged connections are
disabled by default. To enable them you need to set <link
linkend="ini.oci8.privileged_connect">oci8.privileged_connect</link>
to On.
</para>
<note>
<simpara>
If you're using PHP with Oracle Instant Client, you can use easy connect
naming method described here:
<ulink
url="http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306">
http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</ulink>.
Basically this means you can specify "//db_host[:port]/database_name"
as database name. But if you want to use the old way of naming you
<emphasis>must</emphasis> set either <constant>ORACLE_HOME</constant> or
<constant>TNS_ADMIN</constant>.
</simpara>
</note>
&oci.charset;
<para>
<function>oci_pconnect</function> returns connection identifier or
&false; on error.
</para>
<note>
<para>
Note, that these kind of links only work if you are using
a module version of PHP. See the
<link linkend="features.persistent-connections">Persistent
Database Connections</link> section for more information.
</para>
</note>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociplogon</function> instead.

10
reference/oci8/functions/oci-rollback.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-rollback">
<refnamediv>
<refname>oci_rollback</refname>
@ -18,6 +18,14 @@
<para>
&return.success;
</para>
<note>
<para>
Transactions are automatically rolled back when you close
the connection, or when the script ends, whichever is soonest. You
need to explicitly call <function>oci_commit</function> to commit
the transaction, or <function>oci_rollback</function> to abort it.
</para>
</note>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocirollback</function> instead.

2
reference/oci8/functions/oci-server-version.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-server-version">
<refnamediv>
<refname>oci_server_version</refname>

7
reference/oci8/functions/oci-set-prefetch.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-set-prefetch">
<refnamediv>
<refname>oci_set_prefetch</refname>
@ -28,6 +28,11 @@
<para>
&return.success;
</para>
<simpara>
See also <link
linkend="ini.oci8.default_prefetch">oci8_.default_prefetch</link>
ini option.
</simpara>
</refsect1>
</refentry>

2
reference/oci8/functions/oci-statement-type.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-statement-type">
<refnamediv>
<refname>oci_statement_type</refname>

140
reference/oci8/functions/ocibindbyname.xml
View file

@ -1,131 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<!--
<!-- $Revision: 1.18 $ -->
<refentry id="function.ocibindbyname">
<refnamediv>
<refname>ocibindbyname</refname>
<refpurpose>&Alias; <function>oci_bind_by_name</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocibindbyname">
<refnamediv>
<refname>ocibindbyname</refname>
<refpurpose>
Bind a PHP variable to an Oracle Placeholder
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocibindbyname</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>string</type><parameter>ph_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">variable</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocibindbyname</function> binds the PHP variable
<parameter>variable</parameter> to the Oracle placeholder
<parameter>ph_name</parameter>. Whether it will be used for
input or output will be determined run-time, and the necessary
storage space will be allocated. The
<parameter>length</parameter> parameter sets the maximum length
for the bind. If you set <parameter>length</parameter> to -1
<function>ocibindbyname</function> will use the current length of
<parameter>variable</parameter> to set the maximum length.
</para>
<para>
If you need to bind an abstract Datatype (LOB/ROWID/BFILE) you
need to allocate it first using
<function>ocinewdescriptor</function> function. The
<parameter>length</parameter> is not used for abstract Datatypes
and should be set to -1. The <parameter>type</parameter> variable
tells oracle, what kind of descriptor we want to use. Possible
values are: OCI_B_FILE (Binary-File), OCI_B_CFILE
(Character-File), OCI_B_CLOB (Character-LOB), OCI_B_BLOB
(Binary-LOB) and OCI_B_ROWID (ROWID).
</para>
<para>
<example>
<title><function>ocibindbyname</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* OCIBindByPos example thies at thieso dot net (980221)
inserts 3 records into emp, and uses the ROWID for updating the
records just after the insert.
*/
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "insert into emp (empno, ename) " .
"values (:empno,:ename) " .
"returning ROWID into :rid");
$data = array(1111 => "Larry", 2222 => "Bill", 3333 => "Jim");
$rowid = OCINewDescriptor($conn, OCI_D_ROWID);
OCIBindByName($stmt, ":empno", $empno, 32);
OCIBindByName($stmt, ":ename", $ename, 32);
OCIBindByName($stmt, ":rid", $rowid, -1, OCI_B_ROWID);
$update = OCIParse($conn, "update emp set sal = :sal where ROWID = :rid");
OCIBindByName($update, ":rid", $rowid, -1, OCI_B_ROWID);
OCIBindByName($update, ":sal", $sal, 32);
$sal = 10000;
foreach ($data as $empno => $ename) {
OCIExecute($stmt);
OCIExecute($update);
}
$rowid->free();
OCIFreeStatement($update);
OCIFreeStatement($stmt);
$stmt = OCIParse($conn, "select * from emp where empno in (1111,2222,3333)");
OCIExecute($stmt);
while (OCIFetchInto($stmt, &$arr, OCI_ASSOC)) {
var_dump($arr);
}
OCIFreeStatement($stmt);
/* delete our "junk" from the emp table.... */
$stmt = OCIParse($conn, "delete from emp where empno in (1111,2222,3333)");
OCIExecute($stmt);
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_bind_by_name</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocibindbyname</function> can also be used.
This is deprecated, however.
</para>
</note>
<warning>
<para>
It is a bad idea to use magic quotes and
<function>ocibindbyname</function> simultaneously as no quoting
is needed on quoted variables and any quotes magically applied
will be written into your database as
<function>ocibindbyname</function> is not able to distinguish
magically added quotings from those added by intention.
</para>
</warning>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_bind_by_name</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/oci8/functions/ocicancel.xml
View file

@ -1,38 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicancel">
<refnamediv>
<refname>ocicancel</refname>
<refpurpose>&Alias; <function>oci_cancel</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.28 -->
<refentry id="function.ocicancel">
<refnamediv>
<refname>ocicancel</refname>
<refpurpose>Cancel reading from cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicancel</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
If you do not want read more data from a cursor, then call
<function>ocicancel</function>.
</para>
<note>
<para>
This function was renamed to <function>oci_cancel</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicancel</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_cancel</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicloselob.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!--
<!-- $Revision: 1.5 $ -->
<refentry id="function.ocicloselob">
<refnamediv>
<refname>ocicloselob</refname>
<refpurpose>&Alias; <xref linkend="function.oci-lob-close" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicloselob">
<refnamediv>
<refname>ocicloselob</refname>
<refpurpose>Closes lob descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicloselob</methodname>
<void />
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_lob_close</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicloselob</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-lob-close" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicollappend.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicollappend">
<refnamediv>
<refname>ocicollappend</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-append" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicollappend">
<refnamediv>
<refname>ocicollappend</refname>
<refpurpose>Append an object to the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicollappend</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_append</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollappend</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-append" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicollassign.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocicollassign">
<refnamediv>
<refname>ocicollassign</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-assign" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.39 -->
<refentry id="function.ocicollassign">
<refnamediv>
<refname>ocicollassign</refname>
<refpurpose>Assign a collection from another existing collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicollassign</methodname>
<methodparam><type>OCI-Collection</type><parameter>from</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_assign</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollassign</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-assign" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

45
reference/oci8/functions/ocicollassignelem.xml
View file

@ -1,35 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicollassignelem">
<refnamediv>
<refname>ocicollassignelem</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-element-assign" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicollassignelem">
<refnamediv>
<refname>ocicollassignelem</refname>
<refpurpose>Assign element val to collection at index ndx</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicollassignelem</methodname>
<methodparam><type>int</type><parameter>ndx</parameter></methodparam>
<methodparam><type>string</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_element_assign</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollassignelem</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-element-assign" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicollgetelem.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ocicollgetelem">
<refnamediv>
<refname>ocicollgetelem</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-element-get" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicollgetelem">
<refnamediv>
<refname>ocicollgetelem</refname>
<refpurpose>Retrieve the value at collection index ndx</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ocicollgetelem</methodname>
<methodparam><type>int</type><parameter>ndx</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_element_get</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollgetelem</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-element-get" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicollmax.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocicollmax">
<refnamediv>
<refname>ocicollmax</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-max" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicollmax">
<refnamediv>
<refname>ocicollmax</refname>
<refpurpose>Gets the maximum number of elements in the collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicollmax</methodname>
<void />
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_max</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollmax</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-max" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicollsize.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicollsize">
<refnamediv>
<refname>ocicollsize</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-size" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicollsize">
<refnamediv>
<refname>ocicollsize</refname>
<refpurpose>Return the size of a collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicollsize</methodname>
<void />
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_size</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicollsize</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-size" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocicolltrim.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicolltrim">
<refnamediv>
<refname>ocicolltrim</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-trim" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicolltrim">
<refnamediv>
<refname>ocicolltrim</refname>
<refpurpose>Trim num elements from the end of a collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicolltrim</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_collection_trim</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolltrim</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-trim" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

52
reference/oci8/functions/ocicolumnisnull.xml
View file

@ -1,42 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicolumnisnull">
<refnamediv>
<refname>ocicolumnisnull</refname>
<refpurpose>&Alias; <function>oci_field_is_null</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocicolumnisnull">
<refnamediv>
<refname>ocicolumnisnull</refname>
<refpurpose>Test whether a result column is &null;</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicolumnisnull</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>mixed</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocicolumnisnull</function> returns &true; if the returned
column <parameter>column</parameter> in the result from the
statement <parameter>stmt</parameter> is &null;. You can either use
the column-number (1-Based) or the column-name, in uppercase, for the
<parameter>col</parameter> parameter.
</para>
<note>
<para>
This function was renamed to <function>oci_field_is_null</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumnisnull</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_is_null</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

83
reference/oci8/functions/ocicolumnname.xml
View file

@ -1,73 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocicolumnname">
<refnamediv>
<refname>ocicolumnname</refname>
<refpurpose>&Alias; <function>oci_field_name</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.15 -->
<refentry id="function.ocicolumnname">
<refnamediv>
<refname>ocicolumnname</refname>
<refpurpose>Returns the name of a column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ocicolumnname</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>ocicolumnname</function> returns the name of the column
corresponding to the column number (1-based) that is passed in.
</simpara>
<para>
<example>
<title><function>ocicolumnname</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "select * from emp");
OCIExecute($stmt);
echo "<table border=\"1\">";
echo "<tr>";
echo "<th>Name</th>";
echo "<th>Type</th>";
echo "<th>Length</th>";
echo "</tr>";
$ncols = OCINumCols($stmt);
for ($i = 1; $i <= $ncols; $i++) {
$column_name = OCIColumnName($stmt, $i);
$column_type = OCIColumnType($stmt, $i);
$column_size = OCIColumnSize($stmt, $i);
echo "<tr>";
echo "<td>$column_name</td>";
echo "<td>$column_type</td>";
echo "<td>$column_size</td>";
echo "</tr>";
}
echo "</table>\n";
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_field_name</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumnname</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_name</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/oci8/functions/ocicolumnprecision.xml
View file

@ -1,44 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ocicolumnprecision">
<refnamediv>
<refname>ocicolumnprecision</refname>
<refpurpose>&Alias; <function>oci_field_precision</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicolumnprecision">
<refnamediv>
<refname>ocicolumnprecision</refname>
<refpurpose>Tell the precision of a column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicolumnprecision</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<para>
Returns precision of the field with <parameter>col</parameter> index
(1-based).
</para>
<para>
For FLOAT columns precision is nonzero and scale is -127.
If precision is 0, then columnt is NUMBER. Else it's
NUMBER(precision, scale).
</para>
<note>
<para>
This function was renamed to <function>oci_field_precision</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumnprecision</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_precision</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

45
reference/oci8/functions/ocicolumnscale.xml
View file

@ -1,35 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ocicolumnscale">
<refnamediv>
<refname>ocicolumnscale</refname>
<refpurpose>&Alias; <function>oci_field_scale</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicolumnscale">
<refnamediv>
<refname>ocicolumnscale</refname>
<refpurpose>Tell the scale of a column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicolumnscale</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_field_scale</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumnscale</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_scale</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

85
reference/oci8/functions/ocicolumnsize.xml
View file

@ -1,75 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocicolumnsize">
<refnamediv>
<refname>ocicolumnsize</refname>
<refpurpose>&Alias; <function>oci_field_size</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.15 -->
<refentry id="function.ocicolumnsize">
<refnamediv>
<refname>ocicolumnsize</refname>
<refpurpose>Return result column size</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicolumnsize</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>mixed</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocicolumnsize</function> returns the size of the column
as given by Oracle. You can either use
the column-number (1-Based) or the column-name for the
<parameter>column</parameter> parameter.
</para>
<para>
<example>
<title><function>ocicolumnsize</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "select * from emp");
OCIExecute($stmt);
echo "<table border=\"1\">";
echo "<tr>";
echo "<th>Name</th>";
echo "<th>Type</th>";
echo "<th>Length</th>";
echo "</tr>";
$ncols = OCINumCols($stmt);
for ($i = 1; $i <= $ncols; $i++) {
$column_name = OCIColumnName($stmt, $i);
$column_type = OCIColumnType($stmt, $i);
$column_size = OCIColumnSize($stmt, $i);
echo "<tr>";
echo "<td>$column_name</td>";
echo "<td>$column_type</td>";
echo "<td>$column_size</td>";
echo "</tr>";
}
echo "</table>";
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_field_size</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumnsize</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_size</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

84
reference/oci8/functions/ocicolumntype.xml
View file

@ -1,74 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocicolumntype">
<refnamediv>
<refname>ocicolumntype</refname>
<refpurpose>&Alias; <function>oci_field_type</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocicolumntype">
<refnamediv>
<refname>ocicolumntype</refname>
<refpurpose>Returns the data type of a column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>ocicolumntype</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>ocicolumntype</function> returns the data type of the
column corresponding to the column number (1-based) that is passed
in.
</simpara>
<para>
<example>
<title><function>ocicolumntype</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "select * from emp");
OCIExecute($stmt);
echo "<table border=\"1\">";
echo "<tr>";
echo "<th>Name</th>";
echo "<th>Type</th>";
echo "<th>Length</th>";
echo "</tr>";
$ncols = OCINumCols($stmt);
for ($i = 1; $i <= $ncols; $i++) {
$column_name = OCIColumnName($stmt, $i);
$column_type = OCIColumnType($stmt, $i);
$column_size = OCIColumnSize($stmt, $i);
echo "<tr>";
echo "<td>$column_name</td>";
echo "<td>$column_type</td>";
echo "<td>$column_size</td>";
echo "</tr>";
}
echo "</table>\n";
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_field_type</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumntype</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_type</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

49
reference/oci8/functions/ocicolumntyperaw.xml
View file

@ -1,39 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocicolumntyperaw">
<refnamediv>
<refname>ocicolumntyperaw</refname>
<refpurpose>&Alias; <function>oci_field_type_raw</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocicolumntyperaw">
<refnamediv>
<refname>ocicolumntyperaw</refname>
<refpurpose>Tell the raw oracle data type of a column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocicolumntyperaw</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>col</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocicolumntyperaw</function> returns Oracle's raw data type of the
field.
</para>
<note>
<para>
This function was renamed to <function>oci_field_type_raw</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicolumntyperaw</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_field_type_raw</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

84
reference/oci8/functions/ocicommit.xml
View file

@ -1,74 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!--
<!-- $Revision: 1.17 $ -->
<refentry id="function.ocicommit">
<refnamediv>
<refname>ocicommit</refname>
<refpurpose>&Alias; <function>oci_commit</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocicommit">
<refnamediv>
<refname>ocicommit</refname>
<refpurpose>Commits outstanding transactions</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocicommit</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocicommit</function> commits all outstanding statements
for the active transaction on Oracle connection <parameter>connection</parameter>.
&return.success;
</para>
<para>
This example demonstrates how <function>ocicommit</function> is used.
<example>
<title><function>ocicommit</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Login to Oracle server
$conn = OCILogon('scott', 'tiger');
// Parse SQL
$stmt = OCIParse($conn, "INSERT INTO employees (name, surname) VALUES ('Maxim', 'Maletsky')");
// Execute statement
OCIExecute($stmt);
// Commit transaction
$committed = OCICommit($conn);
// Test whether commit was successful. If error occurred, return error message
if (!$committed) {
$error = OCIError($conn);
echo 'Commit failed. Oracle reports: ' . $error['message'];
}
// Close connection
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_commit</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocicommit</function> can also be used.
This is deprecated, however.
</para>
</note>
<simpara>
See also <function>ocirollback</function>.
</simpara>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_commit</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

93
reference/oci8/functions/ocidefinebyname.xml
View file

@ -1,83 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!--
<!-- $Revision: 1.14 $ -->
<refentry id="function.ocidefinebyname">
<refnamediv>
<refname>ocidefinebyname</refname>
<refpurpose>&Alias; <function>oci_define_by_name</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocidefinebyname">
<refnamediv>
<refname>ocidefinebyname</refname>
<refpurpose>
Use a PHP variable for the define-step during a SELECT
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocidefinebyname</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>string</type><parameter>column_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">variable</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocidefinebyname</function> binds PHP variables for fetches
of SQL-Columns. Be careful that Oracle uses ALL-UPPERCASE column-names,
whereby in your select you can also write lowercase.
<function>ocidefinebyname</function> expects
the <parameter>column_name</parameter> to be in uppercase. If you
define a variable that doesn't exists in your select statement, no
error will be given!
</para>
<para>
If you need to define an abstract datatype (LOB/ROWID/BFILE) you
need to allocate it first using
<function>ocinewdescriptor</function>. See also the
<function>ocibindbyname</function> function.
</para>
<example>
<title><function>ocidefinebyname</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* OCIDefineByName example - thies at thieso dot net (980219) */
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "select empno, ename from emp");
/* the define MUST be done BEFORE ociexecute! */
OCIDefineByName($stmt, "EMPNO", $empno);
OCIDefineByName($stmt, "ENAME", $ename);
OCIExecute($stmt);
while (OCIFetch($stmt)) {
echo "empno:" . $empno . "\n";
echo "ename:" . $ename . "\n";
}
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
<note>
<para>
This function was renamed to <function>oci_define_by_name</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocidefinebyname</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_define_by_name</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/oci8/functions/ocierror.xml
View file

@ -1,52 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!--
<!-- $Revision: 1.12 $ -->
<refentry id="function.ocierror">
<refnamediv>
<refname>ocierror</refname>
<refpurpose>&Alias; <function>oci_error</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocierror">
<refnamediv>
<refname>ocierror</refname>
<refpurpose>Return the last error of stmt|conn|global</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ocierror</methodname>
<methodparam choice="opt"><type>resource</type><parameter>stmt_or_conn_or_global</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>ocierror</function> returns the last error found. If
the optional <parameter>stmt_or_conn_or_global</parameter> is not
provided, the last error encountered is returned. If no error is
found, <function>ocierror</function> returns
&false;. <function>ocierror</function> returns the error as an
associative array. In this array, <literal>code</literal>
consists the oracle error code and <literal>message</literal>
the oracle errorstring.
</simpara>
<note>
<title>As of PHP 4.3</title>
<simpara>
<literal>offset</literal> and <literal>sqltext</literal> will
also be included in the return array to indicate the location
of the error and the original SQL text which caused it.
</simpara>
</note>
<note>
<para>
This function was renamed to <function>oci_error</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocierror</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_error</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/oci8/functions/ociexecute.xml
View file

@ -1,46 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!--
<!-- $Revision: 1.8 $ -->
<refentry id="function.ociexecute">
<refnamediv>
<refname>ociexecute</refname>
<refpurpose>&Alias; <function>oci_execute</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ociexecute">
<refnamediv>
<refname>ociexecute</refname>
<refpurpose>Execute a statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ociexecute</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>ociexecute</function> executes a previously parsed
statement. (see <function>ociparse</function>). The optional
<parameter>mode</parameter> allows you to specify the
execution-mode (default is OCI_COMMIT_ON_SUCCESS). If you don't
want statements to be committed automatically specify OCI_DEFAULT as
your mode.
</para>
<note>
<para>
This function was renamed to <function>oci_execute</function>
after PHP >= 5.0.0. For downward compatibility
<function>ociexecute</function> can also be used.
This is deprecated, however.
</para>
</note>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_execute</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/oci8/functions/ocifetch.xml
View file

@ -1,38 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ocifetch">
<refnamediv>
<refname>ocifetch</refname>
<refpurpose>&Alias; <function>oci_fetch</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocifetch">
<refnamediv>
<refname>ocifetch</refname>
<refpurpose>Fetches the next row into result-buffer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocifetch</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocifetch</function> fetches the next row (for SELECT
statements) into the internal result-buffer. &return.success;
</para>
<note>
<para>
This function was renamed to <function>oci_fetch</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocifetch</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_fetch</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

2
reference/oci8/functions/ocifetchinto.xml
View file

@ -5,7 +5,7 @@ DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS DEPRECATED.
-->
<!-- $Revision: 1.13 $ -->
<!-- $Revision: 1.14 $ -->
<refentry id="function.ocifetchinto">
<refnamediv>
<refname>ocifetchinto</refname>

54
reference/oci8/functions/ocifetchstatement.xml
View file

@ -1,44 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!--
<!-- $Revision: 1.15 $ -->
<refentry id="function.ocifetchistatement">
<refnamediv>
<refname>ocifetchistatement</refname>
<refpurpose>&Alias; <function>oci_fetch_all</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS DEPRECATED.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocifetchstatement">
<refnamediv>
<refname>ocifetchstatement</refname>
<refpurpose>Fetch all rows of result data into an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocifetchstatement</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">output</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>skip</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxrows</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<note>
<para>
In PHP 5.0.0 this function became an alias for
<function>oci_fetch_all</function>.
This name still can be used, it was left as alias of
<function>oci_fetch_all</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_fetch_array</function>,
<function>oci_fetch_assoc</function>,
<function>oci_fetch_object</function>,
<function>oci_fetch_row</function>.
</para>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_fetch_all</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ocifreecollection.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocifreecollection">
<refnamediv>
<refname>ocifreecollection</refname>
<refpurpose>&Alias; <xref linkend="function.oci-collection-free" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocifreecollection">
<refnamediv>
<refname>ocifreecollection</refname>
<refpurpose>Deletes collection object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocifreecollection</methodname>
<void />
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_free_collection</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocifreecollection</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-collection-free" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/oci8/functions/ocifreecursor.xml
View file

@ -1,40 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!--
<!-- $Revision: 1.8 $ -->
<refentry id="function.ocifreecursor">
<refnamediv>
<refname>ocifreecursor</refname>
<refpurpose>&Alias; <function>oci_free_statement</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.11 -->
<refentry id="function.ocifreecursor">
<refnamediv>
<refname>ocifreecursor</refname>
<refpurpose>
Free all resources associated with a cursor
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocifreecursor</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocifreecursor</function> frees all resources associated with the
cursor <parameter>stmt</parameter>. &return.success;
</para>
<note>
<para>
This function was renamed to <function>oci_free_cursor</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocifreecursor</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_free_statement</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/oci8/functions/ocifreedesc.xml
View file

@ -1,38 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocifreedesc">
<refnamediv>
<refname>ocifreedesc</refname>
<refpurpose>&Alias; <xref linkend="function.oci-lob-free" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocifreedesc">
<refnamediv>
<refname>ocifreedesc</refname>
<refpurpose>Deletes a large object descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocifreedesc</methodname>
<void />
</methodsynopsis>
<para>
<function>ocifreedesc</function> deletes a large object descriptor.
&return.success;
</para>
<note>
<para>
This function was renamed to <function>oci_free_descriptor</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocifreedesc</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-lob-free" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/oci8/functions/ocifreestatement.xml
View file

@ -1,40 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ocifreestatement">
<refnamediv>
<refname>ocifreestatement</refname>
<refpurpose>&Alias; <function>oci_free_statement</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocifreestatement">
<refnamediv>
<refname>ocifreestatement</refname>
<refpurpose>
Free all resources associated with a statement
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocifreestatement</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocifreestatement</function> free all resources associated
with the statement <parameter>stmt</parameter>. &return.success;
</para>
<note>
<para>
This function was renamed to <function>oci_free_statement</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocifreestatement</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_free_statement</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

51
reference/oci8/functions/ociinternaldebug.xml
View file

@ -1,41 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!--
<!-- $Revision: 1.7 $ -->
<refentry id="function.ociinternaldebug">
<refnamediv>
<refname>ociinternaldebug</refname>
<refpurpose>&Alias; <function>oci_internal_debug</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ociinternaldebug">
<refnamediv>
<refname>ociinternaldebug</refname>
<refpurpose>
Enables or disables internal debug output
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>ociinternaldebug</methodname>
<methodparam><type>int</type><parameter>onoff</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>ociinternaldebug</function> enables internal debug
output. Set <parameter>onoff</parameter> to 0 to turn debug
output off, 1 to turn it on.
</simpara>
<note>
<para>
This function was renamed to <function>oci_internal_debug</function>
after PHP >= 5.0.0. For downward compatibility
<function>ociinternaldebug</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_internal_debug</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/oci8/functions/ociloadlob.xml
View file

@ -1,34 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!--
<!-- $Revision: 1.9 $ -->
<refentry id="function.ociloadlob">
<refnamediv>
<refname>ociloadlob</refname>
<refpurpose>&Alias; <xref linkend="function.oci-lob-load" /></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ociloadlob">
<refnamediv>
<refname>ociloadlob</refname>
<refpurpose>Loads a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ociloadlob</methodname>
<void />
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_lob_load</function>
after PHP >= 5.0.0. For downward compatibility
<function>ociloadlob</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<xref linkend="function.oci-lob-load" />.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

55
reference/oci8/functions/ocilogoff.xml
View file

@ -1,45 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!--
<!-- $Revision: 1.10 $ -->
<refentry id="function.ocilogoff">
<refnamediv>
<refname>ocilogoff</refname>
<refpurpose>&Alias; <function>oci_close</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocilogoff">
<refnamediv>
<refname>ocilogoff</refname>
<refpurpose>Disconnects from Oracle server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ocilogoff</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocilogoff</function> closes the Oracle connection
<parameter>connection</parameter>.
</para>
<para>
Using <function>ocilogoff</function> isn't usually necessary,
as non-persistent open links are automatically closed at the end
of the script's execution. See also
<link linkend="language.types.resource.self-destruct">freeing
resources</link>.
</para>
<note>
<para>
This function was renamed to <function>oci_close</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocilogoff</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_close</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

159
reference/oci8/functions/ocilogon.xml
View file

@ -1,149 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!--
<!-- $Revision: 1.15 $ -->
<refentry id="function.ocilogon">
<refnamediv>
<refname>ocilogon</refname>
<refpurpose>&Alias; <function>oci_connect</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocilogon">
<refnamediv>
<refname>ocilogon</refname>
<refpurpose>Establishes a connection to Oracle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ocilogon</methodname>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocilogon</function> returns an connection identifier
needed for most other OCI calls. The optional third parameter
can either contain the name of the local Oracle instance or the
name of the entry in tnsnames.ora to which you want to connect.
If the optional third parameter is not specified, PHP uses the
environment variables ORACLE_SID (Oracle instance) or TWO_TASK
(tnsnames.ora) to determine which database to connect to.
</para>
&oci.charset;
<para>Connections are shared at the page level when using
<function>ocilogon</function>. This means that commits and
rollbacks apply to all open transactions in the page, even if you
have created multiple connections.
</para>
<para>
This example demonstrates how the connections are shared.
<example>
<title><function>ocilogon</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo "<pre>";
$db = "";
$c1 = ocilogon("scott", "tiger", $db);
$c2 = ocilogon("scott", "tiger", $db);
function create_table($conn)
{
$stmt = ociparse($conn, "create table scott.hallo (test varchar2(64))");
ociexecute($stmt);
echo $conn . " created table\n\n";
}
function drop_table($conn)
{
$stmt = ociparse($conn, "drop table scott.hallo");
ociexecute($stmt);
echo $conn . " dropped table\n\n";
}
function insert_data($conn)
{
$stmt = ociparse($conn, "insert into scott.hallo
values('$conn' || ' ' || to_char(sysdate,'DD-MON-YY HH24:MI:SS'))");
ociexecute($stmt, OCI_DEFAULT);
echo $conn . " inserted hallo\n\n";
}
function delete_data($conn)
{
$stmt = ociparse($conn, "delete from scott.hallo");
ociexecute($stmt, OCI_DEFAULT);
echo $conn . " deleted hallo\n\n";
}
function commit($conn)
{
ocicommit($conn);
echo $conn . " committed\n\n";
}
function rollback($conn)
{
ocirollback($conn);
echo $conn . " rollback\n\n";
}
function select_data($conn)
{
$stmt = ociparse($conn, "select * from scott.hallo");
ociexecute($stmt, OCI_DEFAULT);
echo $conn."----selecting\n\n";
while (ocifetch($stmt)) {
echo $conn . " [" . ociresult($stmt, "TEST") . "]\n\n";
}
echo $conn . "----done\n\n";
}
create_table($c1);
insert_data($c1); // Insert a row using c1
insert_data($c2); // Insert a row using c2
select_data($c1); // Results of both inserts are returned
select_data($c2);
rollback($c1); // Rollback using c1
select_data($c1); // Both inserts have been rolled back
select_data($c2);
insert_data($c2); // Insert a row using c2
commit($c2); // Commit using c2
select_data($c1); // Result of c2 insert is returned
delete_data($c1); // Delete all rows in table using c1
select_data($c1); // No rows returned
select_data($c2); // No rows returned
commit($c1); // Commit using c1
select_data($c1); // No rows returned
select_data($c2); // No rows returned
drop_table($c1);
echo "</pre>";
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_connect</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocilogon</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_connect</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

46
reference/oci8/functions/ocinewcollection.xml
View file

@ -1,36 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocinewcollection">
<refnamediv>
<refname>ocinewcollection</refname>
<refpurpose>&Alias; <function>oci_new_collection</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.23 -->
<refentry id="function.ocinewcollection">
<refnamediv>
<refname>ocinewcollection</refname>
<refpurpose>Initialize a new collection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>OCI-Collection</type><methodname>ocinewcollection</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>tdo</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
</methodsynopsis>
<note>
<para>
This function was renamed to <function>oci_new_collection</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocinewcollection</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_new_collection</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

120
reference/oci8/functions/ocinewcursor.xml
View file

@ -1,110 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocinewcursor">
<refnamediv>
<refname>ocinewcursor</refname>
<refpurpose>&Alias; <function>oci_new_cursor</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocinewcursor">
<refnamediv>
<refname>ocinewcursor</refname>
<refpurpose>
Return a new cursor (Statement-Handle)
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ocinewcursor</methodname>
<methodparam><type>resource</type><parameter>conn</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocinewcursor</function> allocates a new statement handle
on the specified connection.
</para>
<para>
<example>
<title>Using a REF CURSOR from a stored procedure in Oracle</title>
<programlisting role="php">
<![CDATA[
<?php
// suppose your stored procedure info.output returns a ref cursor in :data
$conn = OCILogon("scott", "tiger");
$curs = OCINewCursor($conn);
$stmt = OCIParse($conn, "begin info.output(:data); end;");
ocibindbyname($stmt, "data", $curs, -1, OCI_B_CURSOR);
ociexecute($stmt);
ociexecute($curs);
while (OCIFetchInto($curs, $data)) {
var_dump($data);
}
OCIFreeStatement($stmt);
OCIFreeCursor($curs);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Using a REF CURSOR in a select statement in Oracle</title>
<programlisting role="php">
<![CDATA[
<?php
echo "<html><body>";
$conn = OCILogon("scott", "tiger");
$count_cursor = "CURSOR(select count(empno) num_emps from emp " .
"where emp.deptno = dept.deptno) as EMPCNT from dept";
$stmt = OCIParse($conn, "select deptno,dname,$count_cursor");
ociexecute($stmt);
echo "<table border=\"1\">";
echo "<tr>";
echo "<th>DEPT NAME</th>";
echo "<th>DEPT #</th>";
echo "<th># EMPLOYEES</th>";
echo "</tr>";
while (OCIFetchInto($stmt, &$data, OCI_ASSOC)) {
echo "<tr>";
$dname = $data["DNAME"];
$deptno = $data["DEPTNO"];
echo "<td>$dname</td>";
echo "<td>$deptno</td>";
ociexecute($data["EMPCNT"]);
while (OCIFetchInto($data["EMPCNT"], &$subdata, OCI_ASSOC)) {
$num_emps = $subdata["NUM_EMPS"];
echo "<td>$num_emps</td>";
}
echo "</tr>";
}
echo "</table>";
echo "</body></html>";
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_new_cursor</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocinewcursor</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_new_cursor</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

166
reference/oci8/functions/ocinewdescriptor.xml
View file

@ -1,156 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!--
<!-- $Revision: 1.15 $ -->
<refentry id="function.ocinewscriptor">
<refnamediv>
<refname>ocinewscriptor</refname>
<refpurpose>&Alias; <function>oci_new_descriptor</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocinewdescriptor">
<refnamediv>
<refname>ocinewdescriptor</refname>
<refpurpose>
Initialize a new empty LOB or FILE descriptor
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>OCI-Lob</type><methodname>ocinewdescriptor</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocinewdescriptor</function> allocates storage to hold
descriptors or LOB locators. Valid values for
<parameter>type</parameter> are <constant>OCI_D_FILE</constant>,
<constant>OCI_D_LOB</constant> and <constant>OCI_D_ROWID</constant>.
For LOB descriptors, the methods load, save, and savefile are
associated with the descriptor, for BFILE only the load method
exists. See the second example usage hints.
</para>
<para>
<example>
<title><function>ocinewdescriptor</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* This script is designed to be called from a HTML form.
* It expects $user, $password, $table, $where, and $commitsize
* to be passed in from the form. The script then deletes
* the selected rows using the ROWID and commits after each
* set of $commitsize rows. (Use with care, there is no rollback)
*/
$conn = OCILogon($user, $password);
$stmt = OCIParse($conn, "select rowid from $table $where");
$rowid = OCINewDescriptor($conn, OCI_D_ROWID);
OCIDefineByName($stmt, "ROWID", &$rowid);
OCIExecute($stmt);
while (OCIFetch($stmt)) {
$nrows = OCIRowCount($stmt);
$delete = OCIParse($conn, "delete from $table where ROWID = :rid");
OCIBindByName($delete, ":rid", &$rowid, -1, OCI_B_ROWID);
OCIExecute($delete);
echo "$nrows\n";
if (($nrows % $commitsize) == 0) {
OCICommit($conn);
}
}
$nrows = OCIRowCount($stmt);
echo "$nrows deleted...\n";
OCIFreeStatement($stmt);
OCILogoff($conn);
?>
]]>
</programlisting>
<programlisting role="php">
<![CDATA[
<?php
/* This script demonstrates file upload to LOB columns
* The formfield used for this example looks like this
* <form action="upload.php" method="post" enctype="multipart/form-data">
* <input type="file" name="lob_upload" />
* ...
*/
if (!isset($lob_upload) || $lob_upload == 'none'){
?>
<form action="upload.php" method="post" enctype="multipart/form-data">
Upload file: <input type="file" name="lob_upload" /><br />
<input type="submit" value="Upload" /> - <input type="reset" value="Reset" />
</form>
<?php
} else {
// $lob_upload contains the temporary filename of the uploaded file
// see also the features section on file upload,
// if you would like to use secure uploads
$conn = OCILogon($user, $password);
$lob = OCINewDescriptor($conn, OCI_D_LOB);
$stmt = OCIParse($conn, "insert into $table (id, the_blob)
values(my_seq.NEXTVAL, EMPTY_BLOB()) returning the_blob into :the_blob");
OCIBindByName($stmt, ':the_blob', &$lob, -1, OCI_B_BLOB);
OCIExecute($stmt, OCI_DEFAULT);
if ($lob->savefile($lob_upload)){
OCICommit($conn);
echo "Blob successfully uploaded\n";
}else{
echo "Couldn't upload Blob\n";
}
OCIFreeDesc($lob);
OCIFreeStatement($stmt);
OCILogoff($conn);
}
?>
]]>
</programlisting>
</example>
<example>
<title><function>ocinewdescriptor</function> second example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Calling PL/SQL stored procedures which contain clobs as input
* parameters (PHP 4 >= 4.0.6).
* Example PL/SQL stored procedure signature is:
*
* PROCEDURE save_data
* Argument Name Type In/Out Default?
* ------------------------------ ----------------------- ------ --------
* KEY NUMBER(38) IN
* DATA CLOB IN
*
*/
$conn = OCILogon($user, $password);
$stmt = OCIParse($conn, "begin save_data(:key, :data); end;");
$clob = OCINewDescriptor($conn, OCI_D_LOB);
OCIBindByName($stmt, ':key', $key);
OCIBindByName($stmt, ':data', $clob, -1, OCI_B_CLOB);
$clob->WriteTemporary($data);
OCIExecute($stmt, OCI_DEFAULT);
OCICommit($conn);
$clob->close();
$clob->free();
OCIFreeStatement($stmt);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_new_descriptor</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocinewdescriptor</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_new_descriptor</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

163
reference/oci8/functions/ocinlogon.xml
View file

@ -1,153 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!--
<!-- $Revision: 1.14 $ -->
<refentry id="function.ocinlogon">
<refnamediv>
<refname>ocinlogon</refname>
<refpurpose>&Alias; <function>oci_new_connect</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.15 -->
<refentry id="function.ocinlogon">
<refnamediv>
<refname>ocinlogon</refname>
<refpurpose>Establishes a new connection to Oracle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ocinlogon</methodname>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocinlogon</function> creates a new connection to an
Oracle 8 database and logs on. The optional third parameter can
either contain the name of the local Oracle instance or the name
of the entry in tnsnames.ora to which you want to connect. If
the optional third parameter is not specified, PHP uses the
environment variables ORACLE_SID (Oracle instance) or TWO_TASK
(tnsnames.ora) to determine which database to connect to.
</para>
<para>
<function>ocinlogon</function> forces a new connection. This
should be used if you need to isolate a set of transactions. By
default, connections are shared at the page level if using
<function>ocilogon</function> or at the web server process level
if using <function>ociplogon</function>. If you have multiple
connections open using <function>ocinlogon</function>, all
commits and rollbacks apply to the specified connection only.
</para>
&oci.charset;
<para>
This example demonstrates how the connections are separated.
<example>
<title><function>ocinlogon</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo "<html><pre>";
$db = "";
$c1 = ocilogon("scott", "tiger", $db);
$c2 = ocinlogon("scott", "tiger", $db);
function create_table($conn)
{
$stmt = ociparse($conn, "create table scott.hallo (test
varchar2(64))");
ociexecute($stmt);
echo $conn . " created table\n\n";
}
function drop_table($conn)
{
$stmt = ociparse($conn, "drop table scott.hallo");
ociexecute($stmt);
echo $conn . " dropped table\n\n";
}
function insert_data($conn)
{
$stmt = ociparse($conn, "insert into scott.hallo
values('$conn' || ' ' || to_char(sysdate,'DD-MON-YY HH24:MI:SS'))");
ociexecute($stmt, OCI_DEFAULT);
echo $conn . " inserted hallo\n\n";
}
function delete_data($conn)
{
$stmt = ociparse($conn, "delete from scott.hallo");
ociexecute($stmt, OCI_DEFAULT);
echo $conn . " deleted hallo\n\n";
}
function commit($conn)
{
ocicommit($conn);
echo $conn . " committed\n\n";
}
function rollback($conn)
{
ocirollback($conn);
echo $conn . " rollback\n\n";
}
function select_data($conn)
{
$stmt = ociparse($conn, "select * from scott.hallo");
ociexecute($stmt, OCI_DEFAULT);
echo $conn . "----selecting\n\n";
while (ocifetch($stmt)) {
echo $conn . " <" . ociresult($stmt, "TEST") . ">\n\n";
}
echo $conn . "----done\n\n";
}
create_table($c1);
insert_data($c1);
select_data($c1);
select_data($c2);
rollback($c1);
select_data($c1);
select_data($c2);
insert_data($c2);
commit($c2);
select_data($c1);
delete_data($c1);
select_data($c1);
select_data($c2);
commit($c1);
select_data($c1);
select_data($c2);
drop_table($c1);
echo "</pre></html>";
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_new_connect</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocinlogon</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_new_connect</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

78
reference/oci8/functions/ocinumcols.xml
View file

@ -1,68 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocinumcols">
<refnamediv>
<refname>ocinumcols</refname>
<refpurpose>&Alias; <function>oci_num_fields</function></refpurpose>
</refnamediv>
DO NOT TRANSLATE THIS FILE.
THE FUNCTION IT DESCRIBES WAS RENAMED AND THIS NAME IS DEPRECATED.
PLEASE, TRANSLATE THE APPROPRIATE NEW FILE.
-->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocinumcols">
<refnamediv>
<refname>ocinumcols</refname>
<refpurpose>
Return the number of result columns in a statement
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ocinumcols</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocinumcols</function> returns the number of columns in the
statement <parameter>stmt</parameter>.
</para>
<para>
<example>
<title><function>ocinumcols</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo "<pre>\n";
$conn = OCILogon("scott", "tiger");
$stmt = OCIParse($conn, "select * from emp");
OCIExecute($stmt);
while (OCIFetch($stmt)) {
echo "\n";
$ncols = OCINumCols($stmt);
for ($i = 1; $i <= $ncols; $i++) {
$column_name = OCIColumnName($stmt, $i);
$column_value = OCIResult($stmt, $i);
echo $column_name . ': ' . $column_value . "\n";
}
echo "\n";
}
OCIFreeStatement($stmt);
OCILogoff($conn);
echo "</pre>";
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function was renamed to <function>oci_num_fields</function>
after PHP >= 5.0.0. For downward compatibility
<function>ocinumcols</function> can also be used.
This is deprecated, however.
</para>
</note>
</refsect1>
</refentry>
<refsect1 role="description">
&reftitle.description;
<simpara>
&info.function.alias;
<function>oci_num_fields</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

Some files were not shown because too many files have changed in this diff Show more