cvs: phpdoc /en/reference/oci8/functions oci-bind-array-by-name.xml oci-bind-by-name.xml oci-cancel.xml oci-close.xml oci-collection-append.xml
oci-collection-assign.xml oci-collection-assignelem.xml oci-collection-free.xml oci-collection-getelem.xml oci-collection-max.xml
oci-collection-size.xml oci-collection-trim.xml oci-commit.xml oci-connect.xml oci-define-by-name.xml oci-error.xml oci-execute.xml oci-fetch-all.xml
oci-fetch-array.xml oci-fetch-assoc.xml oci-fetch-object.xml oci-fetch-row.xml oci-fetch.xml oci-field-is-null.xml oci-field-name.xml
oci-field-precision.xml oci-field-scale.xml oci-field-size.xml oci-field-type-raw.xml oci-field-type.xml oci-free-statement.xml oci-internal-debug.xml
oci-lob-append.xml oci-lob-close.xml oci-lob-copy.xml oci-lob-eof.xml oci-lob-erase.xml oci-lob-export.xml oci-lob-flush.xml oci-lob-free.xml
oci-lob-getbuffering.xml oci-lob-import.xml oci-lob-is-equal.xml oci-lob-load.xml oci-lob-read.xml oci-lob-rewind.xml oci-lob-sav! e.xml
oci-lob-savefile.xml oci-lob-seek.xml oci-lob-setbuffering.xml oci-lob-size.xml oci-lob-tell.xml oci-lob-truncate.xml oci-lob-write.xml
oci-lob-writetemporary.xml oci-lob-writetofile.xml oci-new-collection.xml oci-new-connect.xml oci-new-cursor.xml oci-new-descriptor.xml
oci-num-fields.xml oci-num-rows.xml oci-parse.xml oci-password-change.xml oci-pconnect.xml oci-result.xml oci-rollback.xml oci-server-version.xml
oci-set-prefetch.xml oci-statement-type.xml ocibindbyname.xml ocicancel.xml ocicloselob.xml ocicollappend.xml ocicollassign.xml ocicollassignelem.xml
ocicollgetelem.xml ocicollmax.xml ocicollsize.xml ocicolltrim.xml ocicolumnisnull.xml ocicolumnname.xml ocicolumnprecision.xml ocicolumnscale.xml
ocicolumnsize.xml ocicolumntype.xml ocicolumntyperaw.xml ocicommit.xml ocidefinebyname.xml ocierror.xml ociexecute.xml ocifetch.xml ocifetchinto.xml
ocifetchstatement.xml ocifreecollection.xml ocifreecursor.xml ocifreedesc.xml ocifreestatement.xml ociinternaldebug.xml! ociloadlob.xml ocilogoff.xml
ocilogon.xml ocinewcollection.xml ocinewcursor.xml ocinewdescriptor.xml ocinlogon.xml ocinumcols.xml ociparse.xml ociplogon.xml ociresult.xml
ocirollback.xml ocirowcount.xml ocisavelob.xml ocisavelobfile.xml ociserverversion.xml ocisetprefetch.xml ocistatementtype.xml ociwritelobtofile.xml
ociwr

From:	Mehdi Achour	Date:	Mon, 05 Feb 2007 03:10:18 +0000
Subject:	cvs: phpdoc /en/reference/oci8/functions oci-bind-array-by-name.xml oci-bind-by-name.xml oci-cancel.xml oci-close.xml oci-collection-append.xml oci-collection-assign.xml oci-collection-assignelem.xml oci-collection-free.xml oci-collection-getelem.xml oci-collection-max.xml oci-collection-size.xml oci-collection-trim.xml oci-commit.xml oci-connect.xml oci-define-by-name.xml oci-error.xml oci-execute.xml oci-fetch-all.xml oci-fetch-array.xml oci-fetch-assoc.xml oci-fetch-object.xml oci-fetch-row.xml oci-fetch.xml oci-field-is-null.xml oci-field-name.xml oci-field-precision.xml oci-field-scale.xml oci-field-size.xml oci-field-type-raw.xml oci-field-type.xml oci-free-statement.xml oci-internal-debug.xml oci-lob-append.xml oci-lob-close.xml oci-lob-copy.xml oci-lob-eof.xml oci-lob-erase.xml oci-lob-export.xml oci-lob-flush.xml oci-lob-free.xml oci-lob-getbuffering.xml oci-lob-import.xml oci-lob-is-equal.xml oci-lob-load.xml oci-lob-read.xml oci-lob-rewind.xml oci-lob-sav! e.xml oci-lob-savefile.xml oci-lob-seek.xml oci-lob-setbuffering.xml oci-lob-size.xml oci-lob-tell.xml oci-lob-truncate.xml oci-lob-write.xml oci-lob-writetemporary.xml oci-lob-writetofile.xml oci-new-collection.xml oci-new-connect.xml oci-new-cursor.xml oci-new-descriptor.xml oci-num-fields.xml oci-num-rows.xml oci-parse.xml oci-password-change.xml oci-pconnect.xml oci-result.xml oci-rollback.xml oci-server-version.xml oci-set-prefetch.xml oci-statement-type.xml ocibindbyname.xml ocicancel.xml ocicloselob.xml ocicollappend.xml ocicollassign.xml ocicollassignelem.xml ocicollgetelem.xml ocicollmax.xml ocicollsize.xml ocicolltrim.xml ocicolumnisnull.xml ocicolumnname.xml ocicolumnprecision.xml ocicolumnscale.xml ocicolumnsize.xml ocicolumntype.xml ocicolumntyperaw.xml ocicommit.xml ocidefinebyname.xml ocierror.xml ociexecute.xml ocifetch.xml ocifetchinto.xml ocifetchstatement.xml ocifreecollection.xml ocifreecursor.xml ocifreedesc.xml ocifreestatement.xml ociinternaldebug.xml! ociloadlob.xml ocilogoff.xml ocilogon.xml ocinewcollection.xml ocinewcursor.xml ocinewdescriptor.xml ocinlogon.xml ocinumcols.xml ociparse.xml ociplogon.xml ociresult.xml ocirollback.xml ocirowcount.xml ocisavelob.xml ocisavelobfile.xml ociserverversion.xml ocisetprefetch.xml ocistatementtype.xml ociwritelobtofile.xml ociwr
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375275@lists.php.net to get a copy of this message

didou Mon Feb 5 03:10:18 2007 UTC Modified files: /phpdoc/en/reference/oci8/functions oci-bind-array-by-name.xml oci-bind-by-name.xml oci-cancel.xml oci-close.xml oci-collection-append.xml oci-collection-assign.xml oci-collection-assignelem.xml oci-collection-free.xml oci-collection-getelem.xml oci-collection-max.xml oci-collection-size.xml oci-collection-trim.xml oci-commit.xml oci-connect.xml oci-define-by-name.xml oci-error.xml oci-execute.xml oci-fetch-all.xml oci-fetch-array.xml oci-fetch-assoc.xml oci-fetch-object.xml oci-fetch-row.xml oci-fetch.xml oci-field-is-null.xml oci-field-name.xml oci-field-precision.xml oci-field-scale.xml oci-field-size.xml oci-field-type-raw.xml oci-field-type.xml oci-free-statement.xml oci-internal-debug.xml oci-lob-append.xml oci-lob-close.xml oci-lob-copy.xml oci-lob-eof.xml oci-lob-erase.xml oci-lob-export.xml oci-lob-flush.xml oci-lob-free.xml oci-lob-getbuffering.xml oci-lob-import.xml oci-lob-is-equal.xml oci-lob-load.xml oci-lob-read.xml oci-lob-rewind.xml oci-lob-save.xml oci-lob-savefile.xml oci-lob-seek.xml oci-lob-setbuffering.xml oci-lob-size.xml oci-lob-tell.xml oci-lob-truncate.xml oci-lob-write.xml oci-lob-writetemporary.xml oci-lob-writetofile.xml oci-new-collection.xml oci-new-connect.xml oci-new-cursor.xml oci-new-descriptor.xml oci-num-fields.xml oci-num-rows.xml oci-parse.xml oci-password-change.xml oci-pconnect.xml oci-result.xml oci-rollback.xml oci-server-version.xml oci-set-prefetch.xml oci-statement-type.xml ocibindbyname.xml ocicancel.xml ocicloselob.xml ocicollappend.xml ocicollassign.xml ocicollassignelem.xml ocicollgetelem.xml ocicollmax.xml ocicollsize.xml ocicolltrim.xml ocicolumnisnull.xml ocicolumnname.xml ocicolumnprecision.xml ocicolumnscale.xml ocicolumnsize.xml ocicolumntype.xml ocicolumntyperaw.xml ocicommit.xml ocidefinebyname.xml ocierror.xml ociexecute.xml ocifetch.xml ocifetchinto.xml ocifetchstatement.xml ocifreecollection.xml ocifreecursor.xml ocifreedesc.xml ocifreestatement.xml ociinternaldebug.xml ociloadlob.xml ocilogoff.xml ocilogon.xml ocinewcollection.xml ocinewcursor.xml ocinewdescriptor.xml ocinlogon.xml ocinumcols.xml ociparse.xml ociplogon.xml ociresult.xml ocirollback.xml ocirowcount.xml ocisavelob.xml ocisavelobfile.xml ociserverversion.xml ocisetprefetch.xml ocistatementtype.xml ociwritelobtofile.xml ociwritetemporarylob.xml Log: ref.oci8: switch to new doc style # reviewers, please :)

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml diff -u phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml:1.4 phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml:1.4 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-bind-array-by-name.xml Mon Feb 5 03:10:17 2007 @@ -1,98 +1,156 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-bind-array-by-name"> <refnamediv> <refname>oci_bind_array_by_name</refname> <refpurpose>Binds PHP array to Oracle PL/SQL array by name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_bind_array_by_name</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">var_array</parameter></methodparam> <methodparam><type>int</type><parameter>max_table_length</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>max_item_length</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> - <note> - <para> - This function is available since OCI8 release 1.2 and PHP release 5.1.2. - </para> - </note> <para> - <function>oci_bind_array_by_name</function> binds the PHP array - <parameter>var_array</parameter> to the Oracle placeholder - <parameter>name</parameter>, which points to Oracle PL/SQL array. - Whether it will be used for input or output will be determined at - run-time. The <parameter>max_table_length</parameter> - parameter sets the maximum length both for incoming and result arrays. - Parameter <parameter>max_item_length</parameter> sets maximum length for - array items. If <parameter>max_item_length</parameter> was not specified - or equals to -1, <function>oci_bind_array_by_name</function> will use - find the longest element in the incoming array and will use it as - maximum length for array items. <parameter>type</parameter> parameter - should be used to set the type of PL/SQL array items. See list of - available types below. + Binds the PHP array <parameter>var_array</parameter> to the Oracle + placeholder <parameter>name</parameter>, which points to Oracle PL/SQL + array. Whether it will be used for input or output will be determined at + run-time. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <itemizedlist> - <listitem> - <para> - <constant>SQLT_NUM</constant> - for arrays of NUMBER. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_INT</constant> - for arrays of INTEGER (Note: INTEGER - it is actually a synonym for NUMBER(38), but - <constant>SQLT_NUM</constant> type won't work in this case even - though they are synonyms). - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_FLT</constant> - for arrays of FLOAT. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_AFC</constant> - for arrays of CHAR. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_CHR</constant> - for arrays of VARCHAR2. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_VCS</constant> - for arrays of VARCHAR. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_AVC</constant> - for arrays of CHARZ. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_STR</constant> - for arrays of STRING. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_LVC</constant> - for arrays of LONG VARCHAR. - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_ODT</constant> - for arrays of DATE. - </para> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + The Oracle placeholder. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>var_array</parameter></term> + <listitem> + <para> + An array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>max_table_length</parameter></term> + <listitem> + <para> + Sets the maximum length both for incoming and result arrays. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>max_item_length</parameter></term> + <listitem> + <para> + Sets maximum length for array items. If not specified or equals to -1, + <function>oci_bind_array_by_name</function> will use find the longest + element in the incoming array and will use it as maximum length for + array items. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + Should be used to set the type of PL/SQL array items. See list of + available types below: + </para> + <para> + <itemizedlist> + <listitem> + <para> + <constant>SQLT_NUM</constant> - for arrays of NUMBER. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_INT</constant> - for arrays of INTEGER (Note: INTEGER + it is actually a synonym for NUMBER(38), but + <constant>SQLT_NUM</constant> type won't work in this case even + though they are synonyms). + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_FLT</constant> - for arrays of FLOAT. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_AFC</constant> - for arrays of CHAR. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_CHR</constant> - for arrays of VARCHAR2. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_VCS</constant> - for arrays of VARCHAR. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_AVC</constant> - for arrays of CHARZ. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_STR</constant> - for arrays of STRING. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_LVC</constant> - for arrays of LONG VARCHAR. + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_ODT</constant> - for arrays of DATE. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_bind_array_by_name</function>example</title> @@ -147,12 +205,22 @@ var_dump($array); - ?> +?> ]]> </programlisting> </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function is available since OCI8 release 1.2. + </para> + </note> + </refsect1> + </refentry>  + <refentry id="function.oci-bind-by-name"> <refnamediv> <refname>oci_bind_by_name</refname> <refpurpose>Binds the PHP variable to the Oracle placeholder</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_bind_by_name</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</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>oci_bind_by_name</function> binds the PHP variable - <parameter>variable</parameter> to the Oracle placeholder - <parameter>ph_name</parameter>. Whether it will be used for + 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 at 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>oci_bind_by_name</function> will use the current length of - <parameter>variable</parameter> to set the maximum length. + storage space will be allocated. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + An OCI statement. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ph_name</parameter></term> + <listitem> + <para> + The placeholder. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>variable</parameter></term> + <listitem> + <para> + The PHP variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxlength</parameter></term> + <listitem> + <para> + Sets the maximum length for the bind. If you set it to -1, this + function will use the current length of <parameter>variable</parameter> + to set the maximum length. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + If you need to bind an abstract datatype (LOB/ROWID/BFILE) you + need to allocate it first using the + <function>oci_new_descriptor</function> function. The + <parameter>length</parameter> is not used for abstract datatypes + and should be set to -1. The <parameter>type</parameter> parameter + tells Oracle which descriptor is used. Possible + values are: + <itemizedlist> + <listitem> + <para> + <constant>SQLT_FILE</constant> - for BFILEs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_CFILE</constant> - for CFILEs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_CLOB</constant> - for CLOBs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_BLOB</constant> - for BLOBs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_RDD</constant> - for ROWIDs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_NTY</constant> - for named datatypes; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_INT</constant> - for integers; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_CHR</constant> - for VARCHARs; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_BIN</constant> - for RAW columns; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_LNG</constant> - for LONG columns; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_LBI</constant> - for LONG RAW columns; + </para> + </listitem> + <listitem> + <para> + <constant>SQLT_RSET</constant> - for cursors, that were created + before with <function>oci_new_cursor</function>. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If you need to bind an abstract datatype (LOB/ROWID/BFILE) you - need to allocate it first using the - <function>oci_new_descriptor</function> function. The - <parameter>length</parameter> is not used for abstract datatypes - and should be set to -1. The <parameter>type</parameter> parameter - tells Oracle which descriptor is used. Possible - values are: - <itemizedlist> - <listitem> - <para> - <constant>SQLT_FILE</constant> - for BFILEs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_CFILE</constant> - for CFILEs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_CLOB</constant> - for CLOBs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_BLOB</constant> - for BLOBs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_RDD</constant> - for ROWIDs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_NTY</constant> - for named datatypes; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_INT</constant> - for integers; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_CHR</constant> - for VARCHARs; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_BIN</constant> - for RAW columns; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_LNG</constant> - for LONG columns; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_LBI</constant> - for LONG RAW columns; - </para> - </listitem> - <listitem> - <para> - <constant>SQLT_RSET</constant> - for cursors, that were created - before with <function>oci_new_cursor</function>. - </para> - </listitem> - </itemizedlist> + &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_bind_by_name</function>example</title> @@ -240,6 +294,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <warning> <para> Do not use <link @@ -251,9 +316,6 @@ intentionally. </para> </warning> - <para> - &return.success; - </para> <note> <para> In PHP versions before 5.0.0 you must use <function>ocibindbyname</function> instead. @@ -263,6 +325,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-cancel"> <refnamediv> <refname>oci_cancel</refname> <refpurpose>Cancels reading from cursor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_cancel</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_cancel</function> invalidates a cursor, freeing all - associated resources and cancels the ability to read from it. + Invalidates a cursor, freeing all associated resources and cancels the + ability to read from it. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + An OCI statement. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - In PHP versions before 5.0.0 you must use <function>ocicancel</function> instead. - This name still can be used, it was left as alias of - <function>oci_cancel</function> for downwards compatability. - This, however, is deprecated and not recommended. + &return.success; </para> </refsect1> + </refentry>  + <refentry id="function.oci-close"> <refnamediv> <refname>oci_close</refname> <refpurpose>Closes Oracle connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_close</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - <function>oci_close</function> closes the Oracle connection - <parameter>connection</parameter>. + Closes the Oracle <parameter>connection</parameter>. </para> - <note> - <para> - 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> - 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. + 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> </refsect1> + </refentry>  + <refentry id="function.oci-collection-append"> <refnamediv> <refname>OCI-Collection->append</refname> @@ -16,11 +16,7 @@ </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; + Appends element to the end of the collection. </para> </refsect1> @@ -32,7 +28,7 @@ <term><parameter>value</parameter></term> <listitem> <para> - The value to be added to the collection. + The value to be added to the collection. Can be a string or a number. </para> </listitem> </varlistentry> @@ -40,6 +36,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-assign.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-assign.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.7 phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.8 --- phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.7 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-assign.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-assign"> <refnamediv> <refname>OCI-Collection->assign</refname> @@ -20,9 +20,6 @@ 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"> @@ -41,6 +38,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml:1.1 phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-assignelem.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-element-assign"> <refnamediv> <refname>OCI-Collection->assignElem</refname> @@ -18,10 +18,6 @@ </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> @@ -33,6 +29,7 @@ <term><parameter>index</parameter></term> <listitem> <para> + The element index. First index is 1. </para> </listitem> </varlistentry> @@ -40,6 +37,7 @@ <term><parameter>value</parameter></term> <listitem> <para> + Can be a string or a number. </para> </listitem> </varlistentry> @@ -47,6 +45,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-free.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-free.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-free.xml:1.3 phpdoc/en/reference/oci8/functions/oci-collection-free.xml:1.4 --- phpdoc/en/reference/oci8/functions/oci-collection-free.xml:1.3 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-free.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-free"> <refnamediv> <refname>OCI-Collection->free</refname> @@ -18,6 +18,10 @@ <para> Frees the resources associated with the collection object. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml:1.1 phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-getelem.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-element-get"> <refnamediv> <refname>OCI-Collection->getElem</refname> @@ -18,12 +18,6 @@ <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"> @@ -34,6 +28,7 @@ <term><parameter>index</parameter></term> <listitem> <para> + The element index. First index is 1. </para> </listitem> </varlistentry> @@ -41,6 +36,15 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + 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="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-max.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-max.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-max.xml:1.4 phpdoc/en/reference/oci8/functions/oci-collection-max.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-collection-max.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-max.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-max"> <refnamediv> <refname>OCI-Collection->max</refname> @@ -17,8 +17,16 @@ </classsynopsis> <para> Returns the maximum number of elements in the collection. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the maximum number as an integer, or &false; on errors. + </para> + <para> 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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-size.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-size.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-size.xml:1.4 phpdoc/en/reference/oci8/functions/oci-collection-size.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-collection-size.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-size.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-size"> <refnamediv> <refname>OCI-Collection->size</refname> @@ -16,6 +16,13 @@ </methodsynopsis> </classsynopsis> <para> + Returns the size of the collection. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns the number of elements in the collection or &false; on error. </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-collection-trim.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-collection-trim.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-trim.xml:1.4 phpdoc/en/reference/oci8/functions/oci-collection-trim.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-collection-trim.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-collection-trim.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-collection-trim"> <refnamediv> <refname>OCI-Collection->trim</refname> @@ -19,9 +19,6 @@ Trims <parameter>num</parameter> of elements from the end of the collection. </para> - <para> - &return.success; - </para> </refsect1> <refsect1 role="parameters"> @@ -32,6 +29,7 @@ <term><parameter>num</parameter></term> <listitem> <para> + The number of elements to be trimmed. </para> </listitem> </varlistentry> @@ -39,6 +37,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-commit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-commit.xml diff -u phpdoc/en/reference/oci8/functions/oci-commit.xml:1.5 phpdoc/en/reference/oci8/functions/oci-commit.xml:1.6 --- phpdoc/en/reference/oci8/functions/oci-commit.xml:1.5 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-commit.xml Mon Feb 5 03:10:17 2007 @@ -1,66 +1,95 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-commit"> <refnamediv> <refname>oci_commit</refname> <refpurpose>Commits outstanding statements</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_commit</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - <function>oci_commit</function> commits all outstanding statements - for the active transaction on the Oracle connection - <parameter>connection</parameter>. + Commits all outstanding statements for the active transaction on the + Oracle <parameter>connection</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_commit</function> example</title> <programlisting role="php"> <![CDATA[ <?php - // Login to Oracle server - $conn = oci_connect('scott', 'tiger'); +// Login to Oracle server +$conn = oci_connect('scott', 'tiger'); - // Parse SQL - $stmt = oci_parse($conn, " - INSERT INTO - employees (name, surname) - VALUES - ('Maxim', 'Maletsky') - "); - - /* Execute statement - OCI_DEFAULT tells oci_execute() - not to commit statement immediately */ - oci_execute($stmt, OCI_DEFAULT); - - /* - .... - Parsing and executing other statements here ... - .... - */ - - // Commit transaction - $committed = oci_commit($conn); - - // Test whether commit was successful. If error occurred, return error message - if (!$committed) { - $error = oci_error($conn); - echo 'Commit failed. Oracle reports: ' . $error['message']; - } +// Parse SQL +$stmt = oci_parse($conn, " + INSERT INTO + employees (name, surname) + VALUES + ('Maxim', 'Maletsky') + "); + +/* Execute statement + OCI_DEFAULT tells oci_execute() + not to commit statement immediately */ +oci_execute($stmt, OCI_DEFAULT); + +/* +.... +Parsing and executing other statements here ... +.... +*/ + +// Commit transaction +$committed = oci_commit($conn); + +// Test whether commit was successful. If error occurred, return error message +if (!$committed) { + $error = oci_error($conn); + echo 'Commit failed. Oracle reports: ' . $error['message']; +} ?> ]]> </programlisting> </example> </para> - <para> - &return.success; - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> Transactions are automatically rolled back when you close @@ -69,19 +98,18 @@ 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. - This name still can be used, it was left as alias of - <function>oci_commit</function> for downwards compatability. - This, however, is deprecated and not recommended. - </para> - </note> - <simpara> - See also <function>oci_rollback</function> and - <function>oci_execute</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_rollback</function></member> + <member><function>oci_execute</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-connect"> <refnamediv> <refname>oci_connect</refname> <refpurpose>Establishes a connection to the Oracle server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>oci_connect</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> @@ -16,53 +17,82 @@ <methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam> </methodsynopsis> <para> - <function>oci_connect</function> returns a 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 <filename>tnsnames.ora</filename> to which - you want to connect. - If the optional third parameter is not specified, PHP uses the - environment variables <constant>ORACLE_SID</constant> (Oracle - instance) or <constant>TWO_TASK</constant> - (<filename>tnsnames.ora</filename>) to determine which database - to connect to. + Rturns a connection identifier needed for most other OCI calls. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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. + <variablelist> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Oracle user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>db</parameter></term> + <listitem> + <para> + This optional parameter can either contain the name of the local + Oracle instance or the name of the entry in + <filename>tnsnames.ora</filename>. + </para> + <para> + If the 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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + &oci.charset; + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>session_mode</parameter></term> + <listitem> + <para> + This 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, this 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 <literal>On</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <simpara> - If you're using PHP with Oracle Instant Client, you can use easy connect - naming method described here: - <ulink url="&url.oracle.oic.connect;">&url.oracle.oic.connect;</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; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection identifier or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_connect</function> example</title> @@ -159,9 +189,33 @@ </programlisting> </example> </para> - <para> - <function>oci_connect</function> returns &false; if an error occured. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <simpara> + If you're using PHP with Oracle Instant Client, you can use easy connect + naming method described here: + <ulink url="&url.oracle.oic.connect;">&url.oracle.oic.connect;</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> <note> <para> In PHP versions before 5.0.0 you must use <function>ocilogon</function> instead. @@ -170,12 +224,19 @@ This, however, is deprecated and not recommended. </para> </note> - <simpara> - See also <function>oci_pconnect</function>, - <function>oci_new_connect</function> and - <function>oci_close</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_pconnect</function></member> + <member><function>oci_new_connect</function></member> + <member><function>oci_close</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-define-by-name"> <refnamediv> <refname>oci_define_by_name</refname> <refpurpose>Uses a PHP variable for the define-step during a SELECT</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_define_by_name</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> @@ -15,20 +16,70 @@ <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> <para> - <function>oci_define_by_name</function> defines PHP variables for fetches - 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 be issued. + Defines PHP variables for fetches of SQL-Columns. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If you need to define an abstract datatype (LOB/ROWID/BFILE) you - must allocate it first using - <function>oci_new_descriptor</function>. See also the - <function>oci_bind_by_name</function> function. + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>column_name</parameter></term> + <listitem> + <para> + The column name. Must be uppercased. + </para> + <para> + Take into consideration that Oracle uses ALL-UPPERCASE column names, + whereby in your select you can also use lowercase. + If you define a variable that doesn't exists in your select statement, + no error will be issued. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>variable</parameter></term> + <listitem> + <para> + The PHP variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + </para> + <para> + If you need to define an abstract datatype (LOB/ROWID/BFILE) you must + allocate it first using <function>oci_new_descriptor</function>. See + also the <function>oci_bind_by_name</function> function. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>oci_define_by_name</function> example</title> <programlisting role="php"> @@ -56,8 +107,13 @@ oci_close($conn); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocidefinebyname</function> instead. @@ -67,6 +123,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-error"> <refnamediv> <refname>oci_error</refname> <refpurpose>Returns the last error found</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>oci_error</methodname> <methodparam choice="opt"><type>resource</type><parameter>source</parameter></methodparam> </methodsynopsis> <para> - For most errors, the parameter is the most appropriate resource - handle. For connection errors with <function>oci_connect</function>, - <function>oci_new_connect</function> or <function>oci_pconnect</function>, - do not pass a parameter. If no error is found, <function>oci_error</function> + Returns the last error found. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + For most errors, the parameter is the most appropriate resource + handle. For connection errors with <function>oci_connect</function>, + <function>oci_new_connect</function> or + <function>oci_pconnect</function> do not pass a parameter. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If no error is found, <function>oci_error</function> returns &false;. <function>oci_error</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 error string. </para> - <note> - <title>As of PHP 4.3</title> - <para> - <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. - </para> - </note> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3</entry> + <entry> + <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. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Displaying the Oracle error message after a connection error</title> @@ -43,7 +89,7 @@ </programlisting> </example> </para> - <para> + <para> <example> <title>Displaying the Oracle error message after a parsing error</title> <programlisting role="php"> @@ -76,6 +122,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocierror</function> instead. @@ -85,6 +135,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-execute"> <refnamediv> <refname>oci_execute</refname> <refpurpose>Executes a statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_execute</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - <function>oci_execute</function> executes a previously parsed - statement (see <function>oci_parse</function>). The optional - <parameter>mode</parameter> allows you to specify the - execution mode (default is <constant>OCI_COMMIT_ON_SUCCESS</constant>). - If you don't want statements to be committed automatically, - you should specify <constant>OCI_DEFAULT</constant> as your - <parameter>mode</parameter>. + Executes a previously parsed <parameter>statement</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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. + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Allows you to specify the execution mode (default is + <constant>OCI_COMMIT_ON_SUCCESS</constant>). + </para> + <para> + If you don't want statements to be committed automatically, 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> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ociexecute</function> instead. @@ -40,6 +73,16 @@ </para> </note> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_parse</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-fetch-all"> <refnamediv> <refname>oci_fetch_all</refname> <refpurpose>Fetches all rows of result data into an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_fetch_all</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> @@ -16,35 +17,83 @@ <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - <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 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 - rows to read, starting at the <parameter>skip</parameter>th row - (default to -1, meaning all the rows). + Fetches all the rows from a result into a user-defined array. </para> - &database.fetch-null; + &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Parameter <parameter>flags</parameter> can be any combination of - the following: - <simplelist> - <member> - <constant>OCI_FETCHSTATEMENT_BY_ROW</constant> - </member> - <member> - <constant>OCI_FETCHSTATEMENT_BY_COLUMN</constant> (default value) - </member> - <member> - <constant>OCI_NUM</constant> - </member> - <member> - <constant>OCI_ASSOC</constant> - </member> - </simplelist> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>output</parameter></term> + <listitem> + &database.fetch-null; + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>skip</parameter></term> + <listitem> + <para> + The number of initial rows to ignore when fetching the result (default + value of 0, to start at the first line). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxrows</parameter></term> + <listitem> + <para> + The number of rows to read, starting at the <parameter>skip</parameter>th + row (default to -1, meaning all the rows). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + Parameter <parameter>flags</parameter> can be any combination of + the following: + <simplelist> + <member> + <constant>OCI_FETCHSTATEMENT_BY_ROW</constant> + </member> + <member> + <constant>OCI_FETCHSTATEMENT_BY_COLUMN</constant> (default value) + </member> + <member> + <constant>OCI_NUM</constant> + </member> + <member> + <constant>OCI_ASSOC</constant> + </member> + </simplelist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows fetched or &false; in case of an error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_fetch_all</function> example</title> @@ -88,10 +137,10 @@ </programlisting> </example> </para> - &oci.datatypes; - <para> - <function>oci_fetch_all</function> returns &false; in case of error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocifetchstatement</function> instead. @@ -101,6 +150,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-fetch-array"> <refnamediv> <refname>oci_fetch_array</refname> @@ -7,60 +7,91 @@ numeric array, or both </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>oci_fetch_array</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - Returns an array, which corresponds to the next result row or &false; in - case of error or there are no more rows in the result. + Returns an array, which corresponds to the next result row. </para> + &oci.datatypes; <para> - <function>oci_fetch_array</function> returns an array with both - associative and numeric indices. + It should be mentioned here, that <function>oci_fetch_array</function> + is <emphasis>insignificantly</emphasis> slower, than + <function>oci_fetch_row</function>, but much more handy. </para> - &database.fetch-null; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - An optional second parameter can be any combination of the following - constants: - <simplelist> - <member> - <constant>OCI_BOTH</constant> - return an array with both associative - and numeric indices (the same as <constant>OCI_ASSOC</constant> - + <constant>OCI_NUM</constant>). This is the default behavior. - </member> - <member> - <constant>OCI_ASSOC</constant> - return an associative array - (as <function>oci_fetch_assoc</function> works). - </member> - <member> - <constant>OCI_NUM</constant> - return a numeric array, - (as <function>oci_fetch_row</function> works). - </member> - <member> - <constant>OCI_RETURN_NULLS</constant> - create empty elements - for the &null; fields. - </member> - <member> - <constant>OCI_RETURN_LOBS</constant> - return the value of a LOB - of the descriptor. - </member> - </simplelist> - Default <parameter>mode</parameter> is <constant>OCI_BOTH</constant>. + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + An optional second parameter can be any combination of the following + constants: + <simplelist> + <member> + <constant>OCI_BOTH</constant> - return an array with both associative + and numeric indices (the same as <constant>OCI_ASSOC</constant> + + <constant>OCI_NUM</constant>). This is the default behavior. + </member> + <member> + <constant>OCI_ASSOC</constant> - return an associative array + (as <function>oci_fetch_assoc</function> works). + </member> + <member> + <constant>OCI_NUM</constant> - return a numeric array, + (as <function>oci_fetch_row</function> works). + </member> + <member> + <constant>OCI_RETURN_NULLS</constant> - create empty elements + for the &null; fields. + </member> + <member> + <constant>OCI_RETURN_LOBS</constant> - return the value of a LOB + of the descriptor. + </member> + </simplelist> + Default <parameter>mode</parameter> is <constant>OCI_BOTH</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - It should be mentioned here, that <function>oci_fetch_array</function> - is <emphasis>insignificantly</emphasis> slower, than - <function>oci_fetch_row</function>, but much more handy. + Returns an array with both associative and numeric indices, or &false; if + there are no more rows in the <parameter>statement</parameter>. </para> + &database.fetch-null; <note> <simpara> - 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> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_fetch_array</function> with <constant>OCI_BOTH</constant> example</title> @@ -155,14 +186,20 @@ </programlisting> </example> </para> - &oci.datatypes; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_fetch_assoc</function>, - <function>oci_fetch_object</function>, - <function>oci_fetch_row</function> and - <function>oci_fetch_all</function>. + <simplelist> + <member><function>oci_fetch_assoc</function></member> + <member><function>oci_fetch_object</function></member> + <member><function>oci_fetch_row</function></member> + <member><function>oci_fetch_all</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-fetch-assoc"> <refnamediv> <refname>oci_fetch_assoc</refname> <refpurpose>Returns the next row from the result data as an associative array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>oci_fetch_assoc</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_fetch_assoc</function> returns the next row from the result - data as an associative array (identical to - <function>oci_fetch_array</function> call with - <constant>OCI_ASSOC</constant> flag). + Returns the next row from the result data as an associative array. + </para> + <para> + Calling <function>oci_fetch_assoc</function> is identical to calling + <function>oci_fetch_array</function> with <constant>OCI_ASSOC</constant>. </para> - &database.fetch-null; <para> A subsequent call to <function>oci_fetch_assoc</function> will return the next row or &false; if there are no more rows. </para> + &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array, or &false; if there are no more rows in the + <parameter>statement</parameter>. + </para> + &database.fetch-null; <note> <simpara> - 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> - &oci.datatypes; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_fetch_array</function>, - <function>oci_fetch_object</function>, - <function>oci_fetch_row</function> and - <function>oci_fetch_all</function>. + <simplelist> + <member><function>oci_fetch_array</function></member> + <member><function>oci_fetch_object</function></member> + <member><function>oci_fetch_row</function></member> + <member><function>oci_fetch_all</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-fetch-object"> <refnamediv> <refname>oci_fetch_object</refname> <refpurpose>Returns the next row from the result data as an object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>oci_fetch_object</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_fetch_object</function> returns the next row from the result data as - an object, which attributes correspond to fields in statement. + Returns the next row from the result data as an object. </para> - &database.fetch-null; <para> Subsequent calls to <function>oci_fetch_object</function> will return the next row from the result or &false; if there are no more rows. </para> + &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object, which attributes correspond to fields in statement, or + &false; if there are no more rows in the <parameter>statement</parameter>. + </para> + &database.fetch-null; <note> <simpara> - 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 associative indices in + the result object will be uppercased too. </simpara> </note> - &oci.datatypes; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_fetch_array</function>, - <function>oci_fetch_assoc</function>, - <function>oci_fetch_row</function> and - <function>oci_fetch_all</function>. + <simplelist> + <member><function>oci_fetch_array</function></member> + <member><function>oci_fetch_assoc</function></member> + <member><function>oci_fetch_row</function></member> + <member><function>oci_fetch_all</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-fetch-row"> <refnamediv> <refname>oci_fetch_row</refname> <refpurpose>Returns the next row from the result data as a numeric array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>oci_fetch_row</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - Calling <function>oci_fetch_row</function> is identical to - <function>oci_fetch_array</function> with - <constant>OCI_NUM</constant> flag and returns the next row from the result - data as a numeric array. + Returns the next row from the result data as an indexed array. + </para> + <para> + Calling <function>oci_fetch_row</function> is identical to calling + <function>oci_fetch_array</function> with <constant>OCI_NUM</constant>. </para> - &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 are no more rows. </para> &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>oci_fetch_array</function>, - <function>oci_fetch_object</function>, - <function>oci_fetch_assoc</function> and - <function>oci_fetch_all</function>. + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an indexed array with the field information, or &false; if there + are no more rows in the <parameter>statement</parameter>. + </para> + &database.fetch-null; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_fetch_array</function></member> + <member><function>oci_fetch_assoc</function></member> + <member><function>oci_fetch_object</function></member> + <member><function>oci_fetch_all</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-fetch"> <refnamediv> <refname>oci_fetch</refname> <refpurpose>Fetches the next row into result-buffer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_fetch</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_fetch</function> fetches the next row (for SELECT - statements) into the internal result-buffer. + Fetches the next row (for SELECT statements) into the internal + result-buffer. </para> + &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - &oci.datatypes; + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocifetch</function> instead. @@ -28,6 +53,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-field-is-null"> <refnamediv> <refname>oci_field_is_null</refname> <refpurpose>Checks if the field is &null;</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_field_is_null</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - <function>oci_field_is_null</function> returns &true; if field - <parameter>field</parameter> from the <parameter>statement</parameter> is - &null;. Parameter <parameter>field</parameter> could be a field's index - or a field's name (uppercased). + Checks if the given <parameter>field</parameter> from the + <parameter>statement</parameter> is &null;. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be a field's index or a field's name (uppercased). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if <parameter>field</parameter> is &null;, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumnisnull</function> instead. @@ -27,6 +61,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-field-name"> <refnamediv> <refname>oci_field_name</refname> <refpurpose>Returns the name of a field from the statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>oci_field_name</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>int</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - <function>oci_field_name</function> returns the name of the field - corresponding to the field number (1-based). + Returns the name of the <parameter>field</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the name as a string, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_field_name</function> example</title> <programlisting role="php"> <![CDATA[ <?php - $conn = oci_connect("scott", "tiger"); - $stmt = oci_parse($conn, "SELECT * FROM emp"); - oci_execute($stmt); +$conn = oci_connect("scott", "tiger"); +$stmt = oci_parse($conn, "SELECT * FROM emp"); +oci_execute($stmt); + +echo "<table border=\"1\">"; +echo "<tr>"; +echo "<th>Name</th>"; +echo "<th>Type</th>"; +echo "<th>Length</th>"; +echo "</tr>"; + +$ncols = oci_num_fields($stmt); + +for ($i = 1; $i <= $ncols; $i++) { + $column_name = oci_field_name($stmt, $i); + $column_type = oci_field_type($stmt, $i); + $column_size = oci_field_size($stmt, $i); - echo "<table border=\"1\">"; echo "<tr>"; - echo "<th>Name</th>"; - echo "<th>Type</th>"; - echo "<th>Length</th>"; + echo "<td>$column_name</td>"; + echo "<td>$column_type</td>"; + echo "<td>$column_size</td>"; echo "</tr>"; +} - $ncols = oci_num_fields($stmt); - - for ($i = 1; $i <= $ncols; $i++) { - $column_name = oci_field_name($stmt, $i); - $column_type = oci_field_type($stmt, $i); - $column_size = oci_field_size($stmt, $i); - - echo "<tr>"; - echo "<td>$column_name</td>"; - echo "<td>$column_type</td>"; - echo "<td>$column_size</td>"; - echo "</tr>"; - } - - echo "</table>\n"; - oci_free_statement($stmt); - oci_close($conn); +echo "</table>\n"; +oci_free_statement($stmt); +oci_close($conn); ?> ]]> </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumnname</function> instead. @@ -63,12 +102,19 @@ This, however, is deprecated and not recommended. </para> </note> - <simpara> - See also <function>oci_num_fields</function>, - <function>oci_field_type</function>, - and <function>oci_field_size</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_num_fields</function></member> + <member><function>oci_field_type</function></member> + <member><function>oci_field_size</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-field-precision"> <refnamediv> <refname>oci_field_precision</refname> <refpurpose>Tell the precision of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_field_precision</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>int</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - Returns precision of the field with <parameter>field</parameter> index - (1-based). + Returns precision of the <parameter>field</parameter>. </para> <para> For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is NUMBER. Else it's NUMBER(precision, scale). </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the precision as an integer, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumnprecision</function> instead. @@ -29,11 +64,18 @@ This, however, is deprecated and not recommended. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_field_scale</function> and - <function>oci_field_type</function>. + <simplelist> + <member><function>oci_field_scale</function></member> + <member><function>oci_field_type</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-field-scale"> <refnamediv> <refname>oci_field_scale</refname> <refpurpose>Tell the scale of the field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_field_scale</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>int</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - Returns scale of the column with <parameter>field</parameter> index - (1-based) or &false; if there is no such field. + Returns the scale of the column with <parameter>field</parameter> index. </para> <para> For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is NUMBER. Else it's NUMBER(precision, scale). </para> - <note> - <para> - In PHP versions before 5.0.0 you must use <function>ocicolumnscale</function> instead. - This name still can be used, it was left as alias of - <function>oci_field_scale</function> for downwards compatability. - This, however, is deprecated and not recommended. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the scale as an integer, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> <para> - See also <function>oci_field_precision</function> and - <function>oci_field_type</function>. + In PHP versions before 5.0.0 you must use <function>ocicolumnscale</function> instead. + This name still can be used, it was left as alias of + <function>oci_field_scale</function> for downwards compatability. + This, however, is deprecated and not recommended. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_field_precision</function></member> + <member><function>oci_field_type</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-field-size"> <refnamediv> <refname>oci_field_size</refname> <refpurpose>Returns field's size</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_field_size</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - <function>oci_field_size</function> returns the size of a field in - bytes. Value of <parameter>field</parameter> parameter can be the field's - index (1-based) or it's name. + Returns the size of a <parameter>field</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the size of a <parameter>field</parameter> in bytes, or &false; on + errors. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_field_size</function>example</title> <programlisting role="php"> <![CDATA[ <?php - $conn = oci_connect("scott", "tiger"); - $stmt = oci_parse($conn, "SELECT * FROM emp"); - oci_execute($stmt); - - echo "<table border=\"1\">"; +$conn = oci_connect("scott", "tiger"); +$stmt = oci_parse($conn, "SELECT * FROM emp"); +oci_execute($stmt); + +echo "<table border=\"1\">"; +echo "<tr>"; +echo "<th>Name</th>"; +echo "<th>Type</th>"; +echo "<th>Length</th>"; +echo "</tr>"; + +$ncols = oci_num_fields($stmt); + +for ($i = 1; $i <= $ncols; $i++) { + $column_name = oci_field_name($stmt, $i); + $column_type = oci_field_type($stmt, $i); + $column_size = oci_field_size($stmt, $i); echo "<tr>"; - echo "<th>Name</th>"; - echo "<th>Type</th>"; - echo "<th>Length</th>"; + echo "<td>$column_name</td>"; + echo "<td>$column_type</td>"; + echo "<td>$column_size</td>"; echo "</tr>"; +} - $ncols = oci_num_fields($stmt); - - for ($i = 1; $i <= $ncols; $i++) { - $column_name = oci_field_name($stmt, $i); - $column_type = oci_field_type($stmt, $i); - $column_size = oci_field_size($stmt, $i); - echo "<tr>"; - echo "<td>$column_name</td>"; - echo "<td>$column_type</td>"; - echo "<td>$column_size</td>"; - echo "</tr>"; - } - - echo "</table>"; +echo "</table>"; - oci_free_statement($stmt); - oci_close($conn); +oci_free_statement($stmt); +oci_close($conn); ?> ]]> </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumnsize</function> instead. @@ -64,11 +103,18 @@ This, however, is deprecated and not recommended. </para> </note> - <simpara> - See also <function>oci_num_fields</function> and - <function>oci_field_name</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_num_fields</function></member> + <member><function>oci_field_name</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-field-type-raw"> <refnamediv> <refname>oci_field_type_raw</refname> <refpurpose>Tell the raw Oracle data type of the field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_field_type_raw</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>int</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - <function>oci_field_type_raw</function> returns Oracle's raw data type of the - field. + Returns Oracle's raw data type of the <parameter>field</parameter>. </para> + <para> + However, if you want to get field's type, then + <function>oci_field_type</function> will suit you better. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns Oracle's raw data type as a string, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumntyperaw</function> instead. @@ -24,12 +63,8 @@ This, however, is deprecated and not recommended. </para> </note> - <para> - However, if you want to get field's type, then - <function>oci_field_type</function> will suit you better. See - <function>oci_field_type</function> for additional information. - </para> </refsect1> + </refentry>  + <refentry id="function.oci-field-type"> <refnamediv> <refname>oci_field_type</refname> <refpurpose>Returns field's data type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>oci_field_type</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>int</type><parameter>field</parameter></methodparam> </methodsynopsis> - <simpara> - <function>oci_field_type</function> returns a field's data type. - Parameter <parameter>field</parameter> is an index of the field in the - statement (1-based). - </simpara> + <para> + Returns a field's data type. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be the field's index (1-based) or name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the field data type as a string, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> <example> <title><function>oci_field_type</function> example</title> @@ -57,6 +91,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocicolumntype</function> instead. @@ -65,12 +103,19 @@ This, however, is deprecated and not recommended. </para> </note> - <simpara> - See also <function>oci_num_fields</function>, - <function>oci_field_name</function>, - and <function>oci_field_size</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_num_fields</function></member> + <member><function>oci_field_name</function></member> + <member><function>oci_field_size</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.oci-free-statement"> <refnamediv> <refname>oci_free_statement</refname> <refpurpose>Frees all resources associated with statement or cursor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_free_statement</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_free_statement</function> frees resources associated with - Oracle's cursor or statement, which was received from as a result of - <function>oci_parse</function> or obtained from Oracle. + Frees resources associated with Oracle's cursor or statement, which was + received from as a result of <function>oci_parse</function> or obtained + from Oracle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> </refsect1> + </refentry>  + <refentry id="function.oci-internal-debug"> <refnamediv> <refname>oci_internal_debug</refname> <refpurpose>Enables or disables internal debug output</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>oci_internal_debug</methodname> <methodparam><type>int</type><parameter>onoff</parameter></methodparam> </methodsynopsis> <para> - <function>oci_internal_debug</function> enables or disables internal debug - output. Set <parameter>onoff</parameter> to 0 to turn debug - output off or 1 to turn it on. + Enables or disables internal debug output. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>onoff</parameter></term> + <listitem> + <para> + Set this to 0 to turn debug output off or 1 to turn it on. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ociinternaldebug</function> instead. @@ -25,6 +51,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-lob-append"> <refnamediv> <refname>OCI-Lob->append</refname> @@ -19,13 +19,10 @@ 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; + Writing to the large object with this method 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> </refsect1> @@ -37,6 +34,7 @@ <term><parameter>lob_from</parameter></term> <listitem> <para> + The copied LOB. </para> </listitem> </varlistentry> @@ -44,6 +42,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-close.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-close.xml:1.5 phpdoc/en/reference/oci8/functions/oci-lob-close.xml:1.6 --- phpdoc/en/reference/oci8/functions/oci-lob-close.xml:1.5 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-close.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-close"> <refnamediv> <refname>OCI-Lob->close</refname> @@ -16,10 +16,13 @@ </methodsynopsis> </classsynopsis> <para> - <function>OCI-Lob->close</function> closes descriptor of LOB or FILE. This - function should be used only with + Closes descriptor of LOB or FILE. This function should be used only with <xref linkend="function.oci-lob-writetemporary" />. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-copy.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-copy.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-copy.xml:1.6 phpdoc/en/reference/oci8/functions/oci-lob-copy.xml:1.7 --- phpdoc/en/reference/oci8/functions/oci-lob-copy.xml:1.6 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-copy.xml Mon Feb 5 03:10:17 2007 @@ -1,12 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-copy"> <refnamediv> <refname>oci_lob_copy</refname> <refpurpose>Copies large object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_lob_copy</methodname> <methodparam><type>OCI-Lob</type><parameter>lob_to</parameter></methodparam> @@ -15,17 +16,53 @@ </methodsynopsis> <para> 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 LOB-recipient data will be overwritten. + Old LOB-recipient data will be overwritten. </para> <para> 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>lob_to</parameter></term> + <listitem> + <para> + The destination LOB. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lob_from</parameter></term> + <listitem> + <para> + The copied LOB. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + Indicates the length of data to be copied. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> </refsect1> + </refentry>  + <refentry id="function.oci-lob-eof"> <refnamediv> <refname>OCI-Lob->eof</refname> @@ -16,6 +16,13 @@ </methodsynopsis> </classsynopsis> <para> + Tells whether the internal pointer of large object is at the end of LOB. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns &true; if internal pointer of large object is at the end of LOB. Otherwise returns &false;. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-erase.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-erase.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-erase.xml:1.3 phpdoc/en/reference/oci8/functions/oci-lob-erase.xml:1.4 --- phpdoc/en/reference/oci8/functions/oci-lob-erase.xml:1.3 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-erase.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-erase"> <refnamediv> <refname>OCI-Lob->erase</refname> @@ -18,18 +18,13 @@ </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. + specified <parameter>offset</parameter>. If called without parameters, it + erases all LOB data. </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"> @@ -54,6 +49,14 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the actual number of characters/bytes erased or &false; in case of + error. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-export.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-export.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-export.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-export.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-export.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-export.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-export"> <refnamediv> <refname>OCI-Lob->export</refname> @@ -18,14 +18,7 @@ </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; + Exports LOB contents to a file. </para> </refsect1> @@ -37,6 +30,7 @@ <term><parameter>filename</parameter></term> <listitem> <para> + Path to the file. </para> </listitem> </varlistentry> @@ -44,6 +38,7 @@ <term><parameter>start</parameter></term> <listitem> <para> + Indicates from where to start exporting. </para> </listitem> </varlistentry> @@ -51,6 +46,7 @@ <term><parameter>length</parameter></term> <listitem> <para> + Indicates the length of data to be exported. </para> </listitem> </varlistentry> @@ -58,6 +54,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-flush.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-flush.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-flush.xml:1.5 phpdoc/en/reference/oci8/functions/oci-lob-flush.xml:1.6 --- phpdoc/en/reference/oci8/functions/oci-lob-flush.xml:1.5 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-flush.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-flush"> <refnamediv> <refname>OCI-Lob->flush</refname> @@ -17,20 +17,6 @@ </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> @@ -42,6 +28,13 @@ <term><parameter>flag</parameter></term> <listitem> <para> + 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> </listitem> </varlistentry> @@ -49,6 +42,16 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + <para> + Returns &false; if buffering was not enabled or an error occurred. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-free.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-free.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-free.xml:1.1 phpdoc/en/reference/oci8/functions/oci-lob-free.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-lob-free.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-free.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-free"> <refnamediv> <refname>OCI-Lob->free</refname> @@ -19,6 +19,10 @@ Frees resources associated with the descriptor, previously allocated with <function>oci_new_descriptor</function>. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml:1.1 phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-getbuffering.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-getbuffering"> <refnamediv> <refname>OCI-Lob->getBuffering</refname> @@ -16,6 +16,13 @@ </methodsynopsis> </classsynopsis> <para> + Tells whether the buffering for the large object is on or off. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns &false; if buffering for the large object is off and &true; if buffering is used. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-import.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-import.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-import.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-import.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-import.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-import.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-import"> <refnamediv> <refname>OCI-Lob->import</refname> @@ -19,9 +19,6 @@ Writes data from the <parameter>filename</parameter> in to the current position of large object. </para> - <para> - &return.success; - </para> </refsect1> <refsect1 role="parameters"> @@ -32,6 +29,7 @@ <term><parameter>filename</parameter></term> <listitem> <para> + Path to the file. </para> </listitem> </varlistentry> @@ -39,6 +37,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml:1.3 phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml:1.4 --- phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml:1.3 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-is-equal.xml Mon Feb 5 03:10:17 2007 @@ -1,20 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-is-equal"> <refnamediv> <refname>oci_lob_is_equal</refname> <refpurpose>Compares two LOB/FILE locators for equality</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_lob_is_equal</methodname> <methodparam><type>OCI-Lob</type><parameter>lob1</parameter></methodparam> <methodparam><type>OCI-Lob</type><parameter>lob2</parameter></methodparam> </methodsynopsis> <para> - Compares two LOB/FILE locators. Returns &true; if these objects are equal - and &false; otherwise. + Compares two LOB/FILE locators. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>lob1</parameter></term> + <listitem> + <para> + A LOB identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lob2</parameter></term> + <listitem> + <para> + A LOB identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if these objects are equal, &false; otherwise. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-load.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-load.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-load.xml:1.5 phpdoc/en/reference/oci8/functions/oci-lob-load.xml:1.6 --- phpdoc/en/reference/oci8/functions/oci-lob-load.xml:1.5 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-load.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-load"> <refnamediv> <refname>OCI-Lob->load</refname> @@ -20,7 +20,13 @@ 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="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the contents of the object, or &false; on errors. </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-read.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-read.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-read.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-read.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-read.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-read.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-read"> <refnamediv> <refname>OCI-Lob->read</refname> @@ -16,13 +16,13 @@ </methodsynopsis> </classsynopsis> <para> - Reads <parameter>length</parameter> bytes from the current position of LOB's internal pointer. + Reads <parameter>length</parameter> bytes from the current position of + LOB's internal pointer. + </para> + <para> 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. + end of the large object is reached. Internal pointer of the large object + will be shifted on the amount of bytes read. </para> </refsect1> @@ -34,6 +34,7 @@ <term><parameter>length</parameter></term> <listitem> <para> + The length of data to read, in bytes. </para> </listitem> </varlistentry> @@ -41,6 +42,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the contents as a string, or &false; in case of error. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-rewind.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-rewind"> <refnamediv> <refname>OCI-Lob->rewind</refname> @@ -18,6 +18,10 @@ <para> Sets the internal pointer to the beginning of the large object. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-save.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-save.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-save.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-save.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-save.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-save.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-save"> <refnamediv> <refname>OCI-Lob->save</refname> @@ -18,11 +18,6 @@ </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> @@ -34,15 +29,15 @@ <term><parameter>data</parameter></term> <listitem> <para> + The data to be saved. </para> </listitem> </varlistentry> - </variablelist> - <variablelist> <varlistentry> <term><parameter>offset</parameter></term> <listitem> <para> + Can be used to indicate offset from the beginning of the large object. </para> </listitem> </varlistentry> @@ -50,6 +45,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml:1.2 phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml:1.3 --- phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml:1.2 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-savefile.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-savefile"> <refnamediv> <refname>OCI-Lob->saveFile</refname> @@ -9,8 +9,7 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_lob_import</function>. + &info.function.alias; <function>oci_lob_import</function>. </simpara> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-seek.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-seek.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-seek.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-seek.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-seek.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-seek.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-seek"> <refnamediv> <refname>OCI-Lob->seek</refname> @@ -17,28 +17,7 @@ </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; + Sets the internal pointer of the large object. </para> </refsect1> @@ -50,6 +29,8 @@ <term><parameter>offset</parameter></term> <listitem> <para> + Indicates the amount of bytes, on which internal pointer should be + moved from the position, pointed by <parameter>whence</parameter>. </para> </listitem> </varlistentry> @@ -57,6 +38,22 @@ <term><parameter>whence</parameter></term> <listitem> <para> + May be one of: + <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> </listitem> </varlistentry> @@ -64,6 +61,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml:1.1 phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-setbuffering.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-setbuffering"> <refnamediv> <refname>OCI-Lob->setBuffering</refname> @@ -16,11 +16,8 @@ </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. + Sets the buffering for the large object, depending on the value of the + <parameter>on_off</parameter> parameter. </para> <para> Use of this function may provide performance improvements by buffering @@ -29,9 +26,6 @@ be used to flush buffers, when you have finished working with the large object. </para> - <para> - &return.success; - </para> </refsect1> <refsect1 role="parameters"> @@ -42,6 +36,7 @@ <term><parameter>on_off</parameter></term> <listitem> <para> + &true; for on and &false; for off. </para> </listitem> </varlistentry> @@ -49,6 +44,14 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; Repeated calls to this method with the same flag will + return &true;. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-size.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-size.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-size.xml:1.3 phpdoc/en/reference/oci8/functions/oci-lob-size.xml:1.4 --- phpdoc/en/reference/oci8/functions/oci-lob-size.xml:1.3 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-size.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-size"> <refnamediv> <refname>OCI-Lob->size</refname> @@ -16,6 +16,13 @@ </methodsynopsis> </classsynopsis> <para> + Gets the size of the large object. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns length of large object value or &false; in case of error. Empty objects have zero length. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-tell.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-tell.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-tell.xml:1.5 phpdoc/en/reference/oci8/functions/oci-lob-tell.xml:1.6 --- phpdoc/en/reference/oci8/functions/oci-lob-tell.xml:1.5 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-tell.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-tell"> <refnamediv> <refname>OCI-Lob->tell</refname> @@ -16,6 +16,13 @@ </methodsynopsis> </classsynopsis> <para> + Gets the current position of a LOB's internal pointer. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns current position of a LOB's internal pointer or &false; if an error occurred. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml:1.4 phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml:1.5 --- phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml:1.4 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-truncate.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-truncate"> <refnamediv> <refname>OCI-Lob->truncate</refname> @@ -16,13 +16,7 @@ </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; + Truncates the LOB. </para> </refsect1> @@ -34,6 +28,9 @@ <term><parameter>length</parameter></term> <listitem> <para> + If provided, this method will truncate the LOB to + <parameter>length</parameter> bytes. Otherwise, it will completrely + purge the LOB. </para> </listitem> </varlistentry> @@ -41,6 +38,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-write.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-write.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-write.xml:1.3 phpdoc/en/reference/oci8/functions/oci-lob-write.xml:1.4 --- phpdoc/en/reference/oci8/functions/oci-lob-write.xml:1.3 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-write.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-write"> <refnamediv> <refname>OCI-Lob->write</refname> @@ -19,13 +19,6 @@ <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> @@ -37,6 +30,7 @@ <term><parameter>data</parameter></term> <listitem> <para> + The data to write in the LOB. </para> </listitem> </varlistentry> @@ -44,6 +38,9 @@ <term><parameter>length</parameter></term> <listitem> <para> + If this 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> </listitem> </varlistentry> @@ -51,6 +48,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of bytes written or &false; in case of error. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml:1.1 phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml:1.1 Mon Feb 5 00:07:02 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-writetemporary.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-writetemporary"> <refnamediv> <refname>OCI-Lob->writeTemporary</refname> @@ -21,25 +21,8 @@ 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; + You should use <xref linkend="function.oci-lob-close" /> when you are done + with this object. </para> </refsect1> @@ -48,9 +31,27 @@ <para> <variablelist> <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The data to write. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><parameter>lob_type</parameter></term> <listitem> <para> + 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> (default value) is used to create + temporary CLOBs + </member> + </simplelist> </para> </listitem> </varlistentry> @@ -58,6 +59,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml diff -u phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml:1.2 phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml:1.3 --- phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml:1.2 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-lob-writetofile.xml Mon Feb 5 03:10:17 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-lob-writetofile"> <refnamediv> <refname>OCI-Lob->writeToFile</refname> @@ -9,8 +9,7 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_lob_export</function>. + &info.function.alias; <function>oci_lob_export</function>. </simpara> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oci8/functions/oci-new-collection.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/oci8/functions/oci-new-collection.xml diff -u phpdoc/en/reference/oci8/functions/oci-new-collection.xml:1.6 phpdoc/en/reference/oci8/functions/oci-new-collection.xml:1.7 --- phpdoc/en/reference/oci8/functions/oci-new-collection.xml:1.6 Mon Feb 5 03:09:36 2007 +++ phpdoc/en/reference/oci8/functions/oci-new-collection.xml Mon Feb 5 03:10:17 2007 @@ -1,37 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.oci-new-collection"> <refnamediv> <refname>oci_new_collection</refname> <refpurpose>Allocates new collection object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>OCI-Collection</type><methodname>oci_new_collection</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> - <para> - 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 - 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. + Allocates a new collection object. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tdo</parameter></term> + <listitem> + <para> + Should be a valid named type (uppercase). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + Should point to the scheme, where the named type was created. The name + of the current user is the default value. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new <classname>OCICollection</classname> object or &false; on + error. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> - In PHP versions before 5.0.0 you must use <function>ocinewcollection</function> instead. - This name still can be used, it was left as alias of - <function>oci_new_collection</function> for downwards compatability. - This, however, is deprecated and not recommended. + In PHP versions before 5.0.0 you must use + <function>ocinewcollection</function> instead. This name still can be + used, it was left as alias of <function>oci_new_collection</function> for + downwards compatability. This, however, is deprecated and not recommended. </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-new-connect"> <refnamediv> <refname>oci_new_connect</refname> <refpurpose>Establishes a new connection to the Oracle server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>oci_new_connect</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> @@ -16,45 +17,89 @@ <methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam> </methodsynopsis> <para> - <function>oci_new_connect</function> establishes a new connection to - an Oracle server and logs on. Unlike <function>oci_connect</function> and + Establishes a new connection to an Oracle server and logs on. + </para> + <para> + 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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_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. + <variablelist> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Oracle user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>db</parameter></term> + <listitem> + <para> + This optional parameter can either contain the name of the local + Oracle instance or the name of the entry in + <filename>tnsnames.ora</filename>. + </para> + <para> + If the 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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + &oci.charset; + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>session_mode</parameter></term> + <listitem> + <para> + This 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, this 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 <literal>On</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <simpara> - If you're using PHP with Oracle Instant Client, you can use easy connect - naming method described here: - <ulink url="&url.oracle.oic.connect;">&url.oracle.oic.connect;</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; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection identifier or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> The following demonstrates how you can separate connections. <example> @@ -152,9 +197,21 @@ </programlisting> </example> </para> - <para> - <function>oci_new_connect</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <simpara> + If you're using PHP with Oracle Instant Client, you can use easy connect + naming method described here: + <ulink url="&url.oracle.oic.connect;">&url.oracle.oic.connect;</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> <para> In PHP versions before 5.0.0 you must use <function>ocinlogon</function> instead. @@ -163,11 +220,18 @@ This, however, is deprecated and not recommended. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_connect</function> and - <function>oci_pconnect</function>. + <simplelist> + <member><function>oci_connect</function></member> + <member><function>oci_pconnect</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-new-cursor"> <refnamediv> <refname>oci_new_cursor</refname> <refpurpose>Allocates and returns a new cursor (statement handle)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>oci_new_cursor</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - <function>oci_new_cursor</function> allocates a new statement handle on - the specified connection. + Allocates a new statement handle on the specified connection. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new statement handle, or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Using REF CURSOR in an Oracle's stored procedure</title> @@ -85,9 +113,10 @@ </programlisting> </example> </para> - <para> - <function>oci_new_cursor</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocinewcursor</function> instead. @@ -97,6 +126,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-new-descriptor"> <refnamediv> <refname>oci_new_descriptor</refname> <refpurpose>Initializes a new empty LOB or FILE descriptor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>OCI-Lob</type><methodname>oci_new_descriptor</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> <para> - <function>oci_new_descriptor</function> allocates resources to hold - descriptor or LOB locator. Valid values for <parameter>type</parameter> - are: <constant>OCI_D_FILE</constant>, - <constant>OCI_D_LOB</constant> and <constant>OCI_D_ROWID</constant>. + Allocates resources to hold descriptor or LOB locator. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + Valid values for <parameter>type</parameter> are: + <constant>OCI_D_FILE</constant>, <constant>OCI_D_LOB</constant> and + <constant>OCI_D_ROWID</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new LOB or FILE descriptor on success, &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_new_descriptor</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 = oci_connect($user, $password); - $stmt = oci_parse($conn, "select rowid from $table $where"); - $rowid = oci_new_descriptor($conn, OCI_D_ROWID); - oci_define_by_name($stmt, "ROWID", $rowid); - oci_execute($stmt); - while (oci_fetch($stmt)) { - $nrows = oci_num_rows($stmt); - $delete = oci_parse($conn, "delete from $table where ROWID = :rid"); - oci_bind_by_name($delete, ":rid", $rowid, -1, OCI_B_ROWID); - oci_execute($delete); - echo "$nrows\n"; - if (($nrows % $commitsize) == 0) { - oci_commit($conn); - } - } +/* 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 = oci_connect($user, $password); +$stmt = oci_parse($conn, "select rowid from $table $where"); +$rowid = oci_new_descriptor($conn, OCI_D_ROWID); +oci_define_by_name($stmt, "ROWID", $rowid); +oci_execute($stmt); +while (oci_fetch($stmt)) { $nrows = oci_num_rows($stmt); - echo "$nrows deleted...\n"; - oci_free_statement($stmt); - oci_close($conn); + $delete = oci_parse($conn, "delete from $table where ROWID = :rid"); + oci_bind_by_name($delete, ":rid", $rowid, -1, OCI_B_ROWID); + oci_execute($delete); + echo "$nrows\n"; + if (($nrows % $commitsize) == 0) { + oci_commit($conn); + } +} +$nrows = oci_num_rows($stmt); +echo "$nrows deleted...\n"; +oci_free_statement($stmt); +oci_close($conn); ?> ]]> </programlisting> @@ -100,36 +136,37 @@ <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 - * - */ +/* 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 = oci_connect($user, $password); - $stmt = oci_parse($conn, "begin save_data(:key, :data); end;"); - $clob = oci_new_descriptor($conn, OCI_D_LOB); - oci_bind_by_name($stmt, ':key', $key); - oci_bind_by_name($stmt, ':data', $clob, -1, OCI_B_CLOB); - $clob->write($data); - oci_execute($stmt, OCI_DEFAULT); - oci_commit($conn); - $clob->free(); - oci_free_statement($stmt); +$conn = oci_connect($user, $password); +$stmt = oci_parse($conn, "begin save_data(:key, :data); end;"); +$clob = oci_new_descriptor($conn, OCI_D_LOB); +oci_bind_by_name($stmt, ':key', $key); +oci_bind_by_name($stmt, ':data', $clob, -1, OCI_B_CLOB); +$clob->write($data); +oci_execute($stmt, OCI_DEFAULT); +oci_commit($conn); +$clob->free(); +oci_free_statement($stmt); ?> ]]> </programlisting> </example> </para> - <para> - <function>oci_new_descriptor</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocinewdescriptor</function> instead. @@ -139,6 +176,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-num-fields"> <refnamediv> <refname>oci_num_fields</refname> <refpurpose>Returns the number of result columns in a statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_num_fields</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_num_fields</function> returns the number of columns in the - <parameter>statement</parameter>. + Gets the number of columns in the given <parameter>statement</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of columns as an integer, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_num_fields</function> example</title> <programlisting role="php"> <![CDATA[ <?php - echo "<pre>\n"; - $conn = oci_connect("scott", "tiger"); - $stmt = oci_parse($conn, "select * from emp"); - - oci_execute($stmt); - - while (oci_fetch($stmt)) { - echo "\n"; - $ncols = oci_num_fields($stmt); - for ($i = 1; $i <= $ncols; $i++) { - $column_name = oci_field_name($stmt, $i); - $column_value = oci_result($stmt, $i); - echo $column_name . ': ' . $column_value . "\n"; - } - echo "\n"; - } +$conn = oci_connect("scott", "tiger"); +$stmt = oci_parse($conn, "select * from emp"); - oci_free_statement($stmt); - oci_close($conn); +oci_execute($stmt); - echo "</pre>"; +while (oci_fetch($stmt)) { + echo "\n"; + $ncols = oci_num_fields($stmt); + for ($i = 1; $i <= $ncols; $i++) { + $column_name = oci_field_name($stmt, $i); + $column_value = oci_result($stmt, $i); + echo $column_name . ': ' . $column_value . "\n"; + } + echo "\n"; +} + +oci_free_statement($stmt); +oci_close($conn); ?> ]]> </programlisting> </example> </para> - <para> - <function>oci_num_fields</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocinumcols</function> instead. @@ -59,6 +84,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-num-rows"> <refnamediv> <refname>oci_num_rows</refname> <refpurpose>Returns number of rows affected during statement execution</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>oci_num_rows</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_num_rows</function> returns number of rows affected during statement execution. + Gets the number of rows affected during statement execution. </para> - <note> - <para> - This function <emphasis>does not</emphasis> return number of rows selected! - For SELECT statements this function will return the number of rows, that were - fetched to the buffer with <function>oci_fetch*</function> functions. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows affected as an integer, or &false; on errors. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_num_rows</function> example</title> <programlisting role="php"> <![CDATA[ <?php - echo "<pre>"; - $conn = oci_connect("scott", "tiger"); +$conn = oci_connect("scott", "tiger"); + +$stmt = oci_parse($conn, "create table emp2 as select * from emp"); +oci_execute($stmt); +echo oci_num_rows($stmt) . " rows inserted.<br />"; +oci_free_statement($stmt); - $stmt = oci_parse($conn, "create table emp2 as select * from emp"); - oci_execute($stmt); - echo oci_num_rows($stmt) . " rows inserted.<br />"; - oci_free_statement($stmt); - - $stmt = oci_parse($conn, "delete from emp2"); - oci_execute($stmt, OCI_DEFAULT); - echo oci_num_rows($stmt) . " rows deleted.<br />"; - oci_commit($conn); - oci_free_statement($stmt); - - $stmt = oci_parse($conn, "drop table emp2"); - oci_execute($stmt); - oci_free_statement($stmt); +$stmt = oci_parse($conn, "delete from emp2"); +oci_execute($stmt, OCI_DEFAULT); +echo oci_num_rows($stmt) . " rows deleted.<br />"; +oci_commit($conn); +oci_free_statement($stmt); - oci_close($conn); - echo "</pre>"; +$stmt = oci_parse($conn, "drop table emp2"); +oci_execute($stmt); +oci_free_statement($stmt); + +oci_close($conn); ?> ]]> </programlisting> </example> </para> - <para> - <function>oci_num_rows</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function <emphasis>does not</emphasis> return number of rows selected! + For SELECT statements this function will return the number of rows, that were + fetched to the buffer with <function>oci_fetch*</function> functions. + </para> + </note> <note> <para> In PHP versions before 5.0.0 you must use <function>ocirowcount</function> instead. @@ -64,6 +91,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-parse"> <refnamediv> <refname>oci_parse</refname> <refpurpose>Prepares Oracle statement for execution</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>oci_parse</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> <para> - <function>oci_parse</function> prepares the <parameter>query</parameter> - using <parameter>connection</parameter> and returns the statement - identifier, which can be used with - <function>oci_bind_by_name</function>, <function>oci_execute</function> - and other functions. + Prepares the <parameter>query</parameter>using + <parameter>connection</parameter> and returns the statement identifier, + which can be used with <function>oci_bind_by_name</function>, + <function>oci_execute</function> and other functions. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The SQL query. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a statement handler on success, or &false; on error. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> - This function <emphasis>does not</emphasis> validate + This function <emphasis>does not</emphasis> validate <parameter>query</parameter>. The only way to find out if <parameter>query</parameter> is valid SQL or PL/SQL statement - is to execute it. </para> </note> - <para> - <function>oci_parse</function> returns &false; on error. - </para> <note> <para> In PHP versions before 5.0.0 you must use <function>ociparse</function> instead. @@ -39,6 +72,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-password-change"> <refnamediv> <refname>oci_password_change</refname> <refpurpose>Changes password of Oracle's user</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_password_change</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> @@ -23,19 +24,73 @@ </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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Oracle user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>old_password</parameter></term> + <listitem> + <para> + The old password. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_password</parameter></term> + <listitem> + <para> + The new password to be set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbname</parameter></term> + <listitem> + <para> + The database name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <simpara> The second <function>oci_password_change</function> syntax is available since version 1.1. </simpara> </note> - <para> - &return.success; - </para> <note> <para> In PHP versions before 5.0.0 you must use <function>ocipasswordchange</function> instead. @@ -45,6 +100,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-pconnect"> <refnamediv> <refname>oci_pconnect</refname> <refpurpose>Connect to an Oracle database using a persistent connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>oci_pconnect</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> @@ -16,15 +17,90 @@ <methodparam choice="opt"><type>int</type><parameter>session_mode</parameter></methodparam> </methodsynopsis> <para> - <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 + Creates a persistent connection to an Oracle server and logs on. + </para> + <para> + 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Oracle user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password for <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>db</parameter></term> + <listitem> + <para> + This optional parameter can either contain the name of the local + Oracle instance or the name of the entry in + <filename>tnsnames.ora</filename>. + </para> + <para> + If the 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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + &oci.charset; + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>session_mode</parameter></term> + <listitem> + <para> + This 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, this 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 <literal>On</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection identifier or &false; on error. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <simpara> Starting with version 1.1 of the oci8 extension, the lifetime and @@ -35,26 +111,6 @@ <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 @@ -66,11 +122,6 @@ <constant>TNS_ADMIN</constant>. </simpara> </note> - &oci.charset; - <para> - <function>oci_pconnect</function> returns connection identifier or - &false; on error. - </para> <note> <para> In PHP versions before 5.0.0 you must use <function>ociplogon</function> instead. @@ -79,11 +130,18 @@ This, however, is deprecated and not recommended. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_connect</function> and - <function>oci_new_connect</function>. + <simplelist> + <member><function>oci_connect</function></member> + <member><function>oci_new_connect</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-result"> <refnamediv> <refname>oci_result</refname> <refpurpose>Returns field's value from the fetched row</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>oci_result</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>mixed</type><parameter>field</parameter></methodparam> </methodsynopsis> <para> - <function>oci_result</function> returns the data from the field - <parameter>field</parameter> in the current row, fetched by - <function>oci_fetch</function>. <function>oci_result</function> returns - everything as strings except for abstract types (ROWIDs, LOBs and FILEs). - <function>oci_result</function> returns &false; on error. + Returns the data from <parameter>field</parameter> in the current row, + fetched by <function>oci_fetch</function>. </para> + &oci.datatypes; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + Can be either use the column number (1-based) or the column name (in + uppercase). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - You can either use the column number (1-based) or the column name (in - uppercase) for the <function>field</function> parameter. + Returns everything as strings except for abstract types (ROWIDs, LOBs and + FILEs). Returns &false; on error. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ociresult</function> instead. @@ -31,15 +62,21 @@ This, however, is deprecated and not recommended. </para> </note> - &oci.datatypes; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_fetch_array</function>, - <function>oci_fetch_assoc</function>, - <function>oci_fetch_object</function>, - <function>oci_fetch_row</function> and - <function>oci_fetch_all</function>. + <simplelist> + <member><function>oci_fetch_array</function></member> + <member><function>oci_fetch_assoc</function></member> + <member><function>oci_fetch_object</function></member> + <member><function>oci_fetch_row</function></member> + <member><function>oci_fetch_all</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-rollback"> <refnamediv> <refname>oci_rollback</refname> <refpurpose>Rolls back outstanding transaction</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_rollback</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - <function>oci_rollback</function> rolls back all outstanding statements - for Oracle connection <parameter>connection</parameter>. + Rolls back all outstanding statements for the Oracle + <parameter>connection</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + An Oracle connection identifier, returned by + <function>oci_connect</function> or <function>oci_pconnect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> Transactions are automatically rolled back when you close @@ -34,10 +60,17 @@ This, however, is deprecated and not recommended. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>oci_commit</function>. + <simplelist> + <member><function>oci_commit</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.oci-server-version"> <refnamediv> <refname>oci_server_version</refname> <refpurpose>Returns server version</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>oci_server_version</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> Returns a string with version information of the Oracle server, which uses - connection <parameter>connection</parameter> or returns &false; on error. + the provided <parameter>connection</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the version information as a string or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_server_version</function> example</title> @@ -29,6 +56,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ociserverversion</function> instead. @@ -38,6 +69,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.oci-set-prefetch"> <refnamediv> <refname>oci_set_prefetch</refname> <refpurpose>Sets number of rows to be prefetched</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>oci_set_prefetch</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> @@ -14,9 +15,42 @@ </methodsynopsis> <para> Sets the number of rows to be prefetched after successful call to - <function>oci_execute</function>. The default value for - <parameter>rows</parameter> is 1. + <function>oci_execute</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rows</parameter></term> + <listitem> + <para> + The default value for <parameter>rows</parameter> is 1. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocisetprefetch</function> instead. @@ -25,15 +59,20 @@ This, however, is deprecated and not recommended. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - &return.success; + <simplelist> + <member> + <link linkend="ini.oci8.default_prefetch">oci8_.default_prefetch</link> + ini option + </member> + </simplelist> </para> - <simpara> - See also <link - linkend="ini.oci8.default_prefetch">oci8_.default_prefetch</link> - ini option. - </simpara> </refsect1> + </refentry>  + <refentry id="function.oci-statement-type"> <refnamediv> <refname>oci_statement_type</refname> <refpurpose>Returns the type of an OCI statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>oci_statement_type</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> </methodsynopsis> <para> - <function>oci_statement_type</function> returns the query type of - statement <parameter>statement</parameter> as one of the following - values: + Returns the type of the provided OCI <parameter>statement</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>statement</parameter></term> + <listitem> + <para> + A valid OCI statement identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the query type of<parameter>statement</parameter> as one of the + following values: <orderedlist> <listitem><simpara><literal>SELECT</literal></simpara></listitem> <listitem><simpara><literal>UPDATE</literal></simpara></listitem> @@ -29,11 +52,12 @@ 1.2.3)</simpara></listitem> <listitem><simpara><literal>UNKNOWN</literal></simpara></listitem> </orderedlist> + Returns &false; on error. </para> - <para> - Parameter <parameter>statement</parameter> is a valid OCI statement - identifier, returned from <function>oci_parse</function>. - </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>oci_statement_type</function> example</title> @@ -54,9 +78,10 @@ </programlisting> </example> </para> - <para> - <function>oci_statement_type</function> returns &false; on error. - </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> In PHP versions before 5.0.0 you must use <function>ocistatementtype</function> instead. @@ -66,6 +91,7 @@ </para> </note> </refsect1> + </refentry>  + <refentry id="function.ocibindbyname"> <refnamediv> <refname>ocibindbyname</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_bind_by_name</function>. + &info.function.alias; <function>oci_bind_by_name</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicancel"> <refnamediv> <refname>ocicancel</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_cancel</function>. + &info.function.alias; <function>oci_cancel</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicloselob"> <refnamediv> <refname>ocicloselob</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-close" />. + &info.function.alias; <xref linkend="function.oci-lob-close" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollappend"> <refnamediv> <refname>ocicollappend</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-append" />. + &info.function.alias; <xref linkend="function.oci-collection-append" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollassign"> <refnamediv> <refname>ocicollassign</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-assign" />. + &info.function.alias; <xref linkend="function.oci-collection-assign" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollassignelem"> <refnamediv> <refname>ocicollassignelem</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-element-assign" />. + &info.function.alias; <xref linkend="function.oci-collection-element-assign" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollgetelem"> <refnamediv> <refname>ocicollgetelem</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-element-get" />. + &info.function.alias; <xref linkend="function.oci-collection-element-get" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollmax"> <refnamediv> <refname>ocicollmax</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-max" />. + &info.function.alias; <xref linkend="function.oci-collection-max" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicollsize"> <refnamediv> <refname>ocicollsize</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-size" />. + &info.function.alias; <xref linkend="function.oci-collection-size" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolltrim"> <refnamediv> <refname>ocicolltrim</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-trim" />. + &info.function.alias; <xref linkend="function.oci-collection-trim" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumnisnull"> <refnamediv> <refname>ocicolumnisnull</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_is_null</function>. + &info.function.alias; <function>oci_field_is_null</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumnname"> <refnamediv> <refname>ocicolumnname</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_name</function>. + &info.function.alias; <function>oci_field_name</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumnprecision"> <refnamediv> <refname>ocicolumnprecision</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_precision</function>. + &info.function.alias; <function>oci_field_precision</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumnscale"> <refnamediv> <refname>ocicolumnscale</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_scale</function>. + &info.function.alias; <function>oci_field_scale</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumnsize"> <refnamediv> <refname>ocicolumnsize</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_size</function>. + &info.function.alias; <function>oci_field_size</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumntype"> <refnamediv> <refname>ocicolumntype</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_type</function>. + &info.function.alias; <function>oci_field_type</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicolumntyperaw"> <refnamediv> <refname>ocicolumntyperaw</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_field_type_raw</function>. + &info.function.alias; <function>oci_field_type_raw</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocicommit"> <refnamediv> <refname>ocicommit</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_commit</function>. + &info.function.alias; <function>oci_commit</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocidefinebyname"> <refnamediv> <refname>ocidefinebyname</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_define_by_name</function>. + &info.function.alias; <function>oci_define_by_name</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocierror"> <refnamediv> <refname>ocierror</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_error</function>. + &info.function.alias; <function>oci_error</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociexecute"> <refnamediv> <refname>ociexecute</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_execute</function>. + &info.function.alias; <function>oci_execute</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocifetch"> <refnamediv> <refname>ocifetch</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_fetch</function>. + &info.function.alias; <function>oci_fetch</function>. </simpara> </refsect1> + </refentry>  - + <refentry id="function.ocifetchinto"> <refnamediv> <refname>ocifetchinto</refname> - <refpurpose>Fetches the next row into an array</refpurpose> + <refpurpose>Fetches the next row into an array (deprecated)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ocifetchinto</methodname> <methodparam><type>resource</type><parameter>statement</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">result</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> - <note> - <para> - This function is deprecated. Recommended alternatives: - <function>oci_fetch_array</function>, <function>oci_fetch_object</function>, - <function>oci_fetch_assoc</function> and - <function>oci_fetch_row</function>. - </para> - </note> <para> - <function>ocifetchinto</function> fetches the next row of SELECT - statement into the <parameter>result</parameter> array. - <function>ocifetchinto</function> overwrites previous content of - <parameter>result</parameter>. By default - <parameter>result</parameter> will contain a zero-based array of all - columns that are not &null;. - </para> - <para> - The <parameter>mode</parameter> parameter allows you to change the - default behaviour. You can specify more the one flag by simply adding - them up (e.g. OCI_ASSOC+OCI_RETURN_NULLS). Valid values are: - <simplelist> - <member> - <constant>OCI_ASSOC</constant> - return an associative array. - </member> - <member> - <constant>OCI_NUM</constant> - return a numeric array starting with - zero (default behaviour). - </member> - <member> - <constant>OCI_RETURN_NULLS</constant> - return the empty values for - column, which values is &null;. - </member> - <member> - <constant>OCI_RETURN_LOBS</constant> - return the value of a LOB - instead of the descriptor. - </member> - </simplelist> - </para> - <para> - <example> - <title><function>ocifetchinto</function> example</title> - <programlisting role="php"> -<![CDATA[ -<?php -$conn = ocilogon("username", "password"); - -$query = "SELECT apples FROM oranges"; - -$statement = OCIParse ($conn, $query); -OCIExecute ($statement); - -while (OCIFetchInto ($statement, $row, OCI_ASSOC)) { - echo $row['apples']; -} -?> -]]> - </programlisting> - </example> - </para> - <para> - See also - <function>oci_fetch_array</function>, - <function>oci_fetch_object</function>, - <function>oci_fetch_assoc</function>, - <function>oci_fetch_row</function>, - <function>oci_fetch</function> and - <function>oci_execute</function>. + This function is deprecated. Recommended alternatives: + <function>oci_fetch_array</function>, <function>oci_fetch_object</function>, + <function>oci_fetch_assoc</function> and + <function>oci_fetch_row</function>. </para> </refsect1> + </refentry>  + <refentry id="function.ocifetchstatement"> <refnamediv> <refname>ocifetchstatement</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_fetch_all</function>. + &info.function.alias; <function>oci_fetch_all</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocifreecollection"> <refnamediv> <refname>ocifreecollection</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-collection-free" />. + &info.function.alias; <xref linkend="function.oci-collection-free" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocifreecursor"> <refnamediv> <refname>ocifreecursor</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_free_statement</function>. + &info.function.alias; <function>oci_free_statement</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocifreedesc"> <refnamediv> <refname>ocifreedesc</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-free" />. + &info.function.alias; <xref linkend="function.oci-lob-free" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocifreestatement"> <refnamediv> <refname>ocifreestatement</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_free_statement</function>. + &info.function.alias; <function>oci_free_statement</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociinternaldebug"> <refnamediv> <refname>ociinternaldebug</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_internal_debug</function>. + &info.function.alias; <function>oci_internal_debug</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociloadlob"> <refnamediv> <refname>ociloadlob</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-load" />. + &info.function.alias; <xref linkend="function.oci-lob-load" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocilogoff"> <refnamediv> <refname>ocilogoff</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_close</function>. + &info.function.alias; <function>oci_close</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocilogon"> <refnamediv> <refname>ocilogon</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_connect</function>. + &info.function.alias; <function>oci_connect</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocinewcollection"> <refnamediv> <refname>ocinewcollection</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_new_collection</function>. + &info.function.alias; <function>oci_new_collection</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocinewcursor"> <refnamediv> <refname>ocinewcursor</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_new_cursor</function>. + &info.function.alias; <function>oci_new_cursor</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocinewdescriptor"> <refnamediv> <refname>ocinewdescriptor</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_new_descriptor</function>. + &info.function.alias; <function>oci_new_descriptor</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocinlogon"> <refnamediv> <refname>ocinlogon</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_new_connect</function>. + &info.function.alias; <function>oci_new_connect</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocinumcols"> <refnamediv> <refname>ocinumcols</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_num_fields</function>. + &info.function.alias; <function>oci_num_fields</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociparse"> <refnamediv> <refname>ociparse</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_parse</function>. + &info.function.alias; <function>oci_parse</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociplogon"> <refnamediv> <refname>ociplogon</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_pconnect</function>. + &info.function.alias; <function>oci_pconnect</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociresult"> <refnamediv> <refname>ociresult</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_result</function>. + &info.function.alias; <function>oci_result</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocirollback"> <refnamediv> <refname>ocirollback</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_rollback</function>. + &info.function.alias; <function>oci_rollback</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocirowcount"> <refnamediv> <refname>ocirowcount</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_num_rows</function>. + &info.function.alias; <function>oci_num_rows</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocisavelob"> <refnamediv> <refname>ocisavelob</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-save" />. + &info.function.alias; <xref linkend="function.oci-lob-save" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocisavelobfile"> <refnamediv> <refname>ocisavelobfile</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-import" />. + &info.function.alias; <xref linkend="function.oci-lob-import" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociserverversion"> <refnamediv> <refname>ociserverversion</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_server_version</function>. + &info.function.alias; <function>oci_server_version</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocisetprefetch"> <refnamediv> <refname>ocisetprefetch</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_set_prefetch</function>. + &info.function.alias; <function>oci_set_prefetch</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ocistatementtype"> <refnamediv> <refname>ocistatementtype</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>oci_statement_type</function>. + &info.function.alias; <function>oci_statement_type</function>. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociwritelobtofile"> <refnamediv> <refname>ociwritelobtofile</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-export" />. + &info.function.alias; <xref linkend="function.oci-lob-export" />. </simpara> </refsect1> + </refentry>  + <refentry id="function.ociwritetemporarylob"> <refnamediv> <refname>ociwritetemporarylob</refname> @@ -9,10 +9,10 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <xref linkend="function.oci-lob-writetemporary" />. + &info.function.alias; <xref linkend="function.oci-lob-writetemporary" />. </simpara> </refsect1> + </refentry> <!-- Keep this comment at the end of the file