various revisions

(more to come)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153140 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kenneth Schwartz 2004-03-08 16:49:36 +00:00
parent ac6b7d2df0
commit 32f0aaeada
29 changed files with 105 additions and 106 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
@ -16,8 +16,8 @@
</para>
<para>
Writing to the large object with <function>lob->append</function> will
fail, if buffering was enabled before. So, you <emphasis>have to</emphasis>
disable buffering before appending. Probably you'll need to flush buffers
fail if buffering was enabled before. You must disable buffering before
appending. You may need to flush buffers
with <function>oci_lob_flush</function> before disabling buffering.
</para>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ocigetbufferinglob">
<refnamediv>
<refname>lob->getBuffering</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->getBuffering</methodname>
<type>bool</type><methodname>lob->getBuffering</methodname>
<void/>
</methodsynopsis>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-read">
<refnamediv>
<refname>lob->read</refname>
@ -11,12 +11,12 @@
<type>string</type><methodname>lob->read</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
<para>
Reads <parameter>length</parameter> bytes from the current position of
LOB's internal pointer. Reading stops when <parameter>length</parameter>
bytes have been read or end of large object is reached.
Internal pointer of large object will be shifted on the amount of bytes
have been read.
read.
</para>
<para>
Returns &false; in case of error.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ocisetbufferinglob">
<refnamediv>
<refname>lob->setBuffering</refname>
@ -12,16 +12,17 @@
<methodparam><type>bool</type><parameter>on_off</parameter></methodparam>
</methodsynopsis>
<para>
<function>lob->setBuffering</function> turns on or off buffering for the
<function>lob->setBuffering</function> sets the buffering for the
large object, depending on the value of the <parameter>on_off</parameter>
parameter. Repeated call to <function>lob->setBuffering</function> with
the same flag will return &true;.
parameter. Repeated calls to <function>lob->setBuffering</function> with
the same flag will return &true;. The values for <parameter>on_off
</parameter> are: &true; for on and &false; for off.
</para>
<para>
Using of this function may provide perfomance improvements by buffering
Use of this function may provide perfomance improvements by buffering
small reads and writes of LOBs by reducing the number of network
round-trips and LOB versions. <function>oci_lob_flush</function> should
be used to flush buffers, when you have finished to work with the large
be used to flush buffers, when you have finished working with the large
object.
</para>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-tell">
<refnamediv>
<refname>lob->tell</refname>
@ -8,12 +8,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->tell</methodname>
<type>int</type><methodname>lob->tell</methodname>
<void />
</methodsynopsis>
<para>
Returns current position of LOB's internal pointer or &false;
if an error occured.
Returns current position of a LOB's internal pointer or &false; if an
error occured.
</para>
<para>
See also <function>oci_lob_size</function> and

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-bind-by-name">
<refnamediv>
<refname>oci_bind_by_name</refname>
@ -91,7 +91,7 @@ $conn = oci_connect("scott", "tiger");
$stmt = oci_parse($conn, "
INSERT INTO
emp (empno, ename)
VALUES
VALUES
(:empno,:ename)
RETURNING
ROWID
@ -125,7 +125,7 @@ oci_bind_by_name($update, ":sal", $sal, 32);
$sal = 10000;
while (list($empno, $ename) = each($data)) {
oci_execute($stmt);
oci_execute($stmt);
oci_execute($update);
}

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-close">
<refnamediv>
<refname>oci_close</refname>
<refname>oci_close</refname>
<refpurpose>Closes Oracle connection</refpurpose>
</refnamediv>
<refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-fetch-object">
<refnamediv>
<refname>oci_fetch_object</refname>
@ -16,13 +16,13 @@
an object, which attributes correspond to fields in statement.
</para>
<para>
Subsequent call to <function>oci_fetch_object</function> will return
Subsequent calls to <function>oci_fetch_object</function> will return the
next row from the result or &false; if there is no more rows.
</para>
<note>
<simpara>
Don't forget, that Oracle returns all field names in uppercase and
attributes' names in the result object will be uppercased too.
attributes' names in the result object will be in uppercase as well.
</simpara>
</note>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-fetch-row">
<refnamediv>
<refname>oci_fetch_row</refname>
@ -12,13 +12,13 @@
<methodparam><type>resource</type><parameter>statement</parameter></methodparam>
</methodsynopsis>
<para>
Call to <function>oci_fetch_row</function> is identical to call to
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.
</para>
<para>
Subsequent call to <function>oci_fetch_row</function> will return
Subsequent calls to <function>oci_fetch_row</function> will return the
next row from the result data or &false; if there is no more rows.
</para>
<para>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-field-name">
<refnamediv>
<refname>oci_field_name</refname>
<refpurpose>Returns the name of a field from the statement</refpurpose>
<refpurpose>Returns the name of a field from the statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -14,7 +14,7 @@
</methodsynopsis>
<para>
<function>oci_field_name</function> returns the name of the field
corresponding to the field number (1-based) that is passed in.
corresponding to the field number (1-based).
</para>
<para>
<example>

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-field-type-raw">
<refnamediv>
<refname>oci_field_type_raw</refname>
<refname>oci_field_type_raw</refname>
<refpurpose>Tell the raw Oracle data type of the field</refpurpose>
</refnamediv>
<refsect1>

View file

@ -1,11 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-internal-debug">
<refnamediv>
<refname>oci_internal_debug</refname>
<refpurpose>
Enables or disables internal debug output
</refpurpose>
<refpurpose>Enables or disables internal debug output</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -13,11 +11,11 @@
<type>void</type><methodname>oci_internal_debug</methodname>
<methodparam><type>int</type><parameter>onoff</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>oci_internal_debug</function> enables internal debug
<para>
<function>oci_internal_debug</function> enables or disables internal debug
output. Set <parameter>onoff</parameter> to 0 to turn debug
output off and 1 to turn it on.
</simpara>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
@ -16,8 +16,8 @@
</para>
<para>
Writing to the large object with <function>lob->append</function> will
fail, if buffering was enabled before. So, you <emphasis>have to</emphasis>
disable buffering before appending. Probably you'll need to flush buffers
fail if buffering was enabled before. You must disable buffering before
appending. You may need to flush buffers
with <function>oci_lob_flush</function> before disabling buffering.
</para>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-read">
<refnamediv>
<refname>lob->read</refname>
@ -11,12 +11,12 @@
<type>string</type><methodname>lob->read</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
<para>
Reads <parameter>length</parameter> bytes from the current position of
LOB's internal pointer. Reading stops when <parameter>length</parameter>
bytes have been read or end of large object is reached.
Internal pointer of large object will be shifted on the amount of bytes
have been read.
read.
</para>
<para>
Returns &false; in case of error.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-tell">
<refnamediv>
<refname>lob->tell</refname>
@ -8,12 +8,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->tell</methodname>
<type>int</type><methodname>lob->tell</methodname>
<void />
</methodsynopsis>
<para>
Returns current position of LOB's internal pointer or &false;
if an error occured.
Returns current position of a LOB's internal pointer or &false; if an
error occured.
</para>
<para>
See also <function>oci_lob_size</function> and

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-new-collection">
<refnamediv>
<refname>oci_new_collection</refname>
@ -18,7 +18,7 @@
should be a valid named type (uppercased). Third, optional parameter
<parameter>schema</parameter> should point to the scheme, where the
named type was created. <function>oci_new_collection</function> uses
name of the current user as default value of <parameter>scheme</parameter>.
name of the current user as default value of <parameter>schema</parameter>.
</para>
<para>
<function>oci_new_collection</function> returns &false; on error.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-new-connect">
<refnamediv>
<refname>oci_new_connect</refname>
@ -15,22 +15,22 @@
</methodsynopsis>
<para>
<function>oci_new_connect</function> creates a new connection to an Oracle
server and logs on. Optional third parameter can either contain the name
server and logs on. 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 third parameter is not specified,
<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>
<function>oci_new_connect</function> forces creation of a new connection.
<function>oci_new_connect</function> forces the creation of a new connection.
This should be used if you need to isolate a set of transactions. By
default, connection are shared and several calls of
default, connections are shared and subsequent calls to
<function>oci_connect</function> will return the same connection
identifier.
</para>
<para>
This exposed demonstrates how you can separate connections.
The following demonstrates how you can separate connections.
<example>
<title><function>oci_new_connect</function> example</title>
<programlisting role="php">

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-new-cursor">
<refnamediv>
<refname>oci_new_cursor</refname>
@ -86,7 +86,7 @@ oci_close($conn);
</example>
</para>
<para>
<function>oci_new_cursor</function> returns &false; on error;
<function>oci_new_cursor</function> returns &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-new-descriptor">
<refnamediv>
<refname>oci_new_descriptor</refname>
@ -120,7 +120,7 @@ Upload file: <input type="file" name="lob_upload" /><br />
$clob->write($data);
oci_execute($stmt, OCI_DEFAULT);
oci_commit($conn);
$clob->free();
$clob->free();
oci_free_statement($stmt);
?>
]]>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-num-rows">
<refnamediv>
<refname>oci_num_rows</refname>
<refpurpose>Returns number of rows affected during statement execution</refpurpose>
<refpurpose>Returns number of rows affected during statement execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,18 +12,18 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_num_rows</function> returns number of rows affected during statement execution.
<function>oci_num_rows</function> returns 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>
<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>
<para>
<example>
<title><function>oci_num_rows</function> example</title>
<title><function>oci_num_rows</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-password-change">
<refnamediv>
<refname>oci_password_change</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>oci_password_change</methodname>
<type>boolean</type><methodname>oci_password_change</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>old_password</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-pconnect">
<refnamediv>
<refname>oci_pconnect</refname>
@ -17,9 +17,9 @@
</methodsynopsis>
<para>
<function>oci_pconnect</function> creates a new persistent connection to
an Oracle server and logs on. Optional third parameter can either contain
an Oracle server and logs on. 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 third parameter is not specified,
<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.

View file

@ -1,19 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-server-version">
<refnamediv>
<refname>oci_server_version</refname>
<refpurpose>Returns server version</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>oci_server_version</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns string with version information of Oracle server, which uses
connection <parameter>connection</parameter> or &false; on error.
Returns a string with version information of the Oracle server, which uses
connection <parameter>connection</parameter> or returns &false; on error.
</para>
<para>
<example>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-set-prefetch">
<refnamediv>
<refname>oci_set_prefetch</refname>
@ -10,10 +10,10 @@
<methodsynopsis>
<type>bool</type><methodname>oci_set_prefetch</methodname>
<methodparam><type>resource</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>rows</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>rows</parameter></methodparam>
</methodsynopsis>
<para>
Sets the number of rows to be prefetched after successfull call to
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.
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-statement-type">
<refnamediv>
<refname>oci_statement_type</refname>
@ -12,7 +12,8 @@
<methodparam><type>resource</type><parameter>statement</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_statement_type</function> returns one of the following
<function>oci_statement_type</function> returns the query type of
statement <parameter>statement</parameter> as one of the following
values:
<orderedlist>
<listitem><simpara><literal>SELECT</literal></simpara></listitem>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<refentry id="function.ocifetchinto">
<refnamediv>
<refname>ocifetchinto</refname>
@ -15,10 +15,10 @@
</methodsynopsis>
<note>
<para>
This function is deprecated. You're recommended to use
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> instead.
<function>oci_fetch_row</function>.
</para>
</note>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/oci8.xml, last change in rev 1.2 -->
<refentry id="function.ocifetchstatement">
<refnamediv>
@ -17,14 +17,12 @@
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
<function>ocifetchstatement</function> fetches all the rows from a
result into a user-defined array.
<function>ocifetchstatement</function> returns the number of rows
fetched. <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).
<function>ocifetchstatement</function> fetches rows from a result set
into a user-defined array. <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 is -1, meaning all rows).
</para>
<para>
<parameter>flags</parameter> represents the available options for,

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ocigetbufferinglob">
<refnamediv>
<refname>lob->getBuffering</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->getBuffering</methodname>
<type>bool</type><methodname>lob->getBuffering</methodname>
<void/>
</methodsynopsis>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ocisetbufferinglob">
<refnamediv>
<refname>lob->setBuffering</refname>
@ -12,16 +12,17 @@
<methodparam><type>bool</type><parameter>on_off</parameter></methodparam>
</methodsynopsis>
<para>
<function>lob->setBuffering</function> turns on or off buffering for the
<function>lob->setBuffering</function> sets the buffering for the
large object, depending on the value of the <parameter>on_off</parameter>
parameter. Repeated call to <function>lob->setBuffering</function> with
the same flag will return &true;.
parameter. Repeated calls to <function>lob->setBuffering</function> with
the same flag will return &true;. The values for <parameter>on_off
</parameter> are: &true; for on and &false; for off.
</para>
<para>
Using of this function may provide perfomance improvements by buffering
Use of this function may provide perfomance improvements by buffering
small reads and writes of LOBs by reducing the number of network
round-trips and LOB versions. <function>oci_lob_flush</function> should
be used to flush buffers, when you have finished to work with the large
be used to flush buffers, when you have finished working with the large
object.
</para>
<para>