cvs: phpdoc /en/reference/oci8/functions oci-bind-by-name.xml oci-cancel.xml oci-close.xml oci-collection-assign.xml oci-commit.xml oci-connect.xml
oci-define-by-name.xml
| From: | Kenneth Schwartz | Date: | Mon, 08 Mar 2004 16:07:37 +0000 |
| Subject: | cvs: phpdoc /en/reference/oci8/functions oci-bind-by-name.xml oci-cancel.xml oci-close.xml oci-collection-assign.xml oci-commit.xml oci-connect.xml oci-define-by-name.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969359412@lists.php.net to get a copy of this message | ||
irchtml Mon Mar 8 11:07:37 2004 EDT
Modified files:
/phpdoc/en/reference/oci8/functions oci-bind-by-name.xml
oci-cancel.xml oci-close.xml
oci-collection-assign.xml
oci-commit.xml oci-connect.xml
oci-define-by-name.xml
Log:
a few initial revisions
http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml diff -u phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.1 phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-bind-by-name"> <refnamediv> <refname>oci_bind_by_name</refname> @@ -21,7 +21,7 @@ <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 - input or output will be determined run-time and the necessary + 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 @@ -30,11 +30,11 @@ </para> <para> If you need to bind an abstract datatype (LOB/ROWID/BFILE) you - need to allocate it first using + 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> variable - tells Oracle, what kind of descriptor you want to use. Possible + and should be set to -1. The <parameter>type</parameter> parameter + tells Oracle which descriptor is used. Possible values are: <itemizedlist> <listitem> @@ -171,7 +171,7 @@ </example> </para> <para> - Remember, that this function strips trailing whitespaces. See the following + Remember, that this function strips trailing whitespace. See the following example: </para> <para> @@ -219,13 +219,13 @@ </para> <warning> <para> - It is a bad idea to use <link + Do not use <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> or <function>addslashes</function> and <function>oci_bind_by_name</function> simultaneously as no quoting is needed and any magically applied quotes will be written into your database as <function>oci_bind_by_name</function> - is not able to distinguish magically added quotings from those added by - intention. + is not able to distinguish magically added quotings from those added + intentionally. </para> </warning> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-cancel.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-cancel.xml diff -u phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.1 phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-cancel.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-cancel"> <refnamediv> <refname>oci_cancel</refname> @@ -12,9 +12,8 @@ <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> <para> - If you do not want read more data from a cursor, then call - <function>oci_cancel</function> to free resources and - to cancel reading from it. + <function>oci_cancel</function> invalidates a cursor, freeing all + associated resources and cancels the ability to read from it. </para> <para> &return.success; http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-close.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-close.xml diff -u phpdoc/en/reference/oci8/functions/oci-close.xml:1.1 phpdoc/en/reference/oci8/functions/oci-close.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-close.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-close.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-close"> <refnamediv> <refname>oci_close</refname> @@ -17,8 +17,11 @@ </para> <note> <para> - At this moment <function>oci_close</function> does nothing and - it's usage is not required. + As non-persistent links are closed automatically at the end of script + execution, calling this function is not required. Because of this and + the method the extension uses to handle connection resources, + <function>oci_close</function> currently provides no actual + functionality. </para> </note> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-collection-assign.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-collection-assign.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.1 phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-collection-assign.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-collection-assign"> <refnamediv> <refname>collection->assign</refname> @@ -12,8 +12,8 @@ <methodparam><type>object</type><parameter>from</parameter></methodparam> </methodsynopsis> <para> - Assigns a value to the collection from another, already created - collection. Both collections should be created with + Assigns a value to the collection from another, previously created + collection. Both collections must be created with <function>oci_new_collection</function> before you can use them. </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-commit.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-commit.xml diff -u phpdoc/en/reference/oci8/functions/oci-commit.xml:1.1 phpdoc/en/reference/oci8/functions/oci-commit.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-commit.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-commit.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-commit"> <refnamediv> <refname>oci_commit</refname> @@ -13,7 +13,7 @@ </methodsynopsis> <para> <function>oci_commit</function> commits all outstanding statements - for the active transaction on Oracle connection + for the active transaction on the Oracle connection <parameter>connection</parameter>. </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-connect.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-connect.xml diff -u phpdoc/en/reference/oci8/functions/oci-connect.xml:1.1 phpdoc/en/reference/oci8/functions/oci-connect.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-connect.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-connect.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-connect"> <refnamediv> <refname>oci_connect</refname> @@ -14,7 +14,7 @@ <methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam> </methodsynopsis> <para> - <function>oci_connect</function> returns connection identifier + <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 @@ -28,11 +28,11 @@ <note> <simpara> <function>oci_connect</function> <emphasis>does not</emphasis> reestablish - connection, if connection with such parameters was established before. - In this case, <function>oci_connect</function> will return identifier of - previously opened connection. This means, that you cannot use this - function to separate transactions. But if really you want to separate - them, you can use <function>oci_new_connect</function>. + the connection, if a connection with such parameters was established + before. In this case, <function>oci_connect</function> will return + identifier of previously opened connection. This means, that you cannot + use this function to separate transactions. To establish a distinctly new + connection, use <function>oci_new_connect</function>. </simpara> </note> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-define-by-name.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-define-by-name.xml diff -u phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.1 phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-define-by-name.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-define-by-name"> <refnamediv> <refname>oci_define_by_name</refname> @@ -23,11 +23,11 @@ <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 given! + error will issued. </para> <para> If you need to define an abstract datatype (LOB/ROWID/BFILE) you - need to allocate it first using + must allocate it first using <function>oci_new_descriptor</function>. See also the <function>oci_bind_by_name</function> function. </para>
http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml diff -u phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.1 phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-bind-by-name.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-bind-by-name"> <refnamediv> <refname>oci_bind_by_name</refname> @@ -21,7 +21,7 @@ <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 - input or output will be determined run-time and the necessary + 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 @@ -30,11 +30,11 @@ </para> <para> If you need to bind an abstract datatype (LOB/ROWID/BFILE) you - need to allocate it first using + 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> variable - tells Oracle, what kind of descriptor you want to use. Possible + and should be set to -1. The <parameter>type</parameter> parameter + tells Oracle which descriptor is used. Possible values are: <itemizedlist> <listitem> @@ -171,7 +171,7 @@ </example> </para> <para> - Remember, that this function strips trailing whitespaces. See the following + Remember, that this function strips trailing whitespace. See the following example: </para> <para> @@ -219,13 +219,13 @@ </para> <warning> <para> - It is a bad idea to use <link + Do not use <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> or <function>addslashes</function> and <function>oci_bind_by_name</function> simultaneously as no quoting is needed and any magically applied quotes will be written into your database as <function>oci_bind_by_name</function> - is not able to distinguish magically added quotings from those added by - intention. + is not able to distinguish magically added quotings from those added + intentionally. </para> </warning> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-cancel.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-cancel.xml diff -u phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.1 phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-cancel.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-cancel.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-cancel"> <refnamediv> <refname>oci_cancel</refname> @@ -12,9 +12,8 @@ <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> <para> - If you do not want read more data from a cursor, then call - <function>oci_cancel</function> to free resources and - to cancel reading from it. + <function>oci_cancel</function> invalidates a cursor, freeing all + associated resources and cancels the ability to read from it. </para> <para> &return.success; http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-close.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-close.xml diff -u phpdoc/en/reference/oci8/functions/oci-close.xml:1.1 phpdoc/en/reference/oci8/functions/oci-close.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-close.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-close.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-close"> <refnamediv> <refname>oci_close</refname> @@ -17,8 +17,11 @@ </para> <note> <para> - At this moment <function>oci_close</function> does nothing and - it's usage is not required. + As non-persistent links are closed automatically at the end of script + execution, calling this function is not required. Because of this and + the method the extension uses to handle connection resources, + <function>oci_close</function> currently provides no actual + functionality. </para> </note> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-collection-assign.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-collection-assign.xml diff -u phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.1 phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-collection-assign.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-collection-assign.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-collection-assign"> <refnamediv> <refname>collection->assign</refname> @@ -12,8 +12,8 @@ <methodparam><type>object</type><parameter>from</parameter></methodparam> </methodsynopsis> <para> - Assigns a value to the collection from another, already created - collection. Both collections should be created with + Assigns a value to the collection from another, previously created + collection. Both collections must be created with <function>oci_new_collection</function> before you can use them. </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-commit.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-commit.xml diff -u phpdoc/en/reference/oci8/functions/oci-commit.xml:1.1 phpdoc/en/reference/oci8/functions/oci-commit.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-commit.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-commit.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-commit"> <refnamediv> <refname>oci_commit</refname> @@ -13,7 +13,7 @@ </methodsynopsis> <para> <function>oci_commit</function> commits all outstanding statements - for the active transaction on Oracle connection + for the active transaction on the Oracle connection <parameter>connection</parameter>. </para> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-connect.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-connect.xml diff -u phpdoc/en/reference/oci8/functions/oci-connect.xml:1.1 phpdoc/en/reference/oci8/functions/oci-connect.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-connect.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-connect.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-connect"> <refnamediv> <refname>oci_connect</refname> @@ -14,7 +14,7 @@ <methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam> </methodsynopsis> <para> - <function>oci_connect</function> returns connection identifier + <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 @@ -28,11 +28,11 @@ <note> <simpara> <function>oci_connect</function> <emphasis>does not</emphasis> reestablish - connection, if connection with such parameters was established before. - In this case, <function>oci_connect</function> will return identifier of - previously opened connection. This means, that you cannot use this - function to separate transactions. But if really you want to separate - them, you can use <function>oci_new_connect</function>. + the connection, if a connection with such parameters was established + before. In this case, <function>oci_connect</function> will return + identifier of previously opened connection. This means, that you cannot + use this function to separate transactions. To establish a distinctly new + connection, use <function>oci_new_connect</function>. </simpara> </note> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/oci8/functions/oci-define-by-name.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/oci8/functions/oci-define-by-name.xml diff -u phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.1 phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.2 --- phpdoc/en/reference/oci8/functions/oci-define-by-name.xml:1.1 Mon Mar 8 09:12:17 2004 +++ phpdoc/en/reference/oci8/functions/oci-define-by-name.xml Mon Mar 8 11:07:36 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.oci-define-by-name"> <refnamediv> <refname>oci_define_by_name</refname> @@ -23,11 +23,11 @@ <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 given! + error will issued. </para> <para> If you need to define an abstract datatype (LOB/ROWID/BFILE) you - need to allocate it first using + must allocate it first using <function>oci_new_descriptor</function>. See also the <function>oci_bind_by_name</function> function. </para>