proto fixes

simple revisions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153212 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kenneth Schwartz 2004-03-09 09:28:20 +00:00
parent 32f0aaeada
commit 0d7cbc3f51
30 changed files with 91 additions and 87 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-assign">
<refnamediv>
<refname>collection->assign</refname>
@ -14,7 +14,7 @@
<para>
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.
<function>oci_new_collection</function> prior to using them.
</para>
<para>
&return.success;

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-collection-element-assign">
<refnamediv>
<refname>collection->assignElem</refname>
@ -13,7 +13,7 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Assigns a value to the element with index <parameter>index</parameter>
Assigns a value to the element with index <parameter>index</parameter>.
Parameter <parameter>value</parameter> can be a string or a number.
</para>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->append</methodname>
<type>bool</type><methodname>lob->append</methodname>
<methodparam><type>object</type><parameter>lob_from</parameter></methodparam>
</methodsynopsis>
<para>
@ -16,9 +16,9 @@
</para>
<para>
Writing to the large object with <function>lob->append</function> will
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.
fail if buffering was previously enabled. You must disable buffering
before appending. You may need to flush buffers with
<function>oci_lob_flush</function> before disabling buffering.
</para>
<para>
&return.success;

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-close">
<refnamediv>
<refname>lob->close</refname>
@ -12,15 +12,15 @@
<void />
</methodsynopsis>
<para>
<function>lob->close</function> closes descriptor of LOB or
FILE. This function should be used only with
<function>lob->close</function> closes descriptor of LOB or FILE. This
function should be used only with
<function>lob->writeTemporary</function>.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_write_temporary</function>
See also <function>oci_lob_write_temporary</function>.
</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-eof">
<refnamediv>
<refname>lob->eof</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->eof</methodname>
<type>bool</type><methodname>lob->eof</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-flush">
<refnamediv>
<refname>lob->flush</refname>
@ -17,13 +17,13 @@
<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. That's why it's recommended to use
new buffer resources. Tt is recommended to use
<constant>OCI_LOB_BUFFER_FREE</constant> flag only when you are not going
to work with the LOB anymore.
</para>
<para>
<function>lob->flush</function> returns &false; if buffering was not
enabled or an error occured.
enabled or an error occurred.
</para>
<para>
&return.success;

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-load">
<refnamediv>
<refname>lob->load</refname>
@ -12,12 +12,11 @@
<void />
</methodsynopsis>
<para>
Returns large object's contents. Remember, that really
<emphasis>large</emphasis> objects can or cannot fit in a variable, which
size is limited with <link linkend="ini.memory-limit">memory_limit</link>.
So, in most cases it's recommended to use
<function>oci_lob_read</function> instead. In case of error
<function>lob->load</function> returns &false;.
Returns large object's contents. As script execution is terminated
when the <link linkend="ini.memory-limit">memory_limit</link> is reached,
ensure that the LOB does not exceed this limit. In most cases it's
recommended to use <function>oci_lob_read</function> instead. In case of
error <function>lob->load</function> returns &false;.
</para>
</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-rewind">
<refnamediv>
<refname>lob->rewind</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->rewind</methodname>
<type>bool</type><methodname>lob->rewind</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-seek">
<refnamediv>
<refname>lob->seek</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->seek</methodname>
<type>bool</type><methodname>lob->seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>

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-truncate">
<refnamediv>
<refname>lob->truncate</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->truncate</methodname>
<type>bool</type><methodname>lob->truncate</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</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-write-temporary">
<refnamediv>
<refname>lob->writeTemporary</refname>
@ -28,7 +28,7 @@
</simplelist>
</para>
<para>
<function>lob->writeTemporary</function> creates CLOB by default.
<function>lob->writeTemporary</function> creates a CLOB by default.
</para>
<para>
You should use <function>oci_lob_close</function> when the work with the

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-collection-assign">
<refnamediv>
<refname>collection->assign</refname>
@ -14,7 +14,7 @@
<para>
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.
<function>oci_new_collection</function> prior to using them.
</para>
<para>
&return.success;

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-collection-element-assign">
<refnamediv>
<refname>collection->assignElem</refname>
@ -13,7 +13,7 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Assigns a value to the element with index <parameter>index</parameter>
Assigns a value to the element with index <parameter>index</parameter>.
Parameter <parameter>value</parameter> can be a string or a number.
</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-field-precision">
<refnamediv>
<refname>oci_field_precision</refname>
@ -17,8 +17,8 @@
(1-based).
</para>
<para>
For FLOAT columns precision is nonzero and scale is -127.
If precision is 0, then columnt is NUMBER. Else it's
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>
<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-field-scale">
<refnamediv>
<refname>oci_field_scale</refname>
@ -17,8 +17,8 @@
(1-based) or &false; if there is no such field.
</para>
<para>
For FLOAT columns precision is nonzero and scale is -127.
If precision is 0, then columnt is NUMBER. Else it's
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>
<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-field-size">
<refnamediv>
<refname>oci_field_size</refname>
@ -13,7 +13,7 @@
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>oci_field_size</function> returns the size of the column in
<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.
</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-field-type">
<refnamediv>
<refname>oci_field_type</refname>
@ -13,7 +13,7 @@
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>oci_field_type</function> returns field's data type.
<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>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-internal-debug">
<refnamediv>
<refname>oci_internal_debug</refname>
@ -14,7 +14,7 @@
<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.
output off or 1 to turn it on.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->append</methodname>
<type>bool</type><methodname>lob->append</methodname>
<methodparam><type>object</type><parameter>lob_from</parameter></methodparam>
</methodsynopsis>
<para>
@ -16,9 +16,9 @@
</para>
<para>
Writing to the large object with <function>lob->append</function> will
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.
fail if buffering was previously enabled. You must disable buffering
before appending. You may need to flush buffers with
<function>oci_lob_flush</function> before disabling buffering.
</para>
<para>
&return.success;

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-close">
<refnamediv>
<refname>lob->close</refname>
@ -12,15 +12,15 @@
<void />
</methodsynopsis>
<para>
<function>lob->close</function> closes descriptor of LOB or
FILE. This function should be used only with
<function>lob->close</function> closes descriptor of LOB or FILE. This
function should be used only with
<function>lob->writeTemporary</function>.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_write_temporary</function>
See also <function>oci_lob_write_temporary</function>.
</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-copy">
<refnamediv>
<refname>oci_lob_copy</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>oci_lob_copy</methodname>
<type>bool</type><methodname>oci_lob_copy</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</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-eof">
<refnamediv>
<refname>lob->eof</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->eof</methodname>
<type>bool</type><methodname>lob->eof</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-flush">
<refnamediv>
<refname>lob->flush</refname>
@ -17,13 +17,13 @@
<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. That's why it's recommended to use
new buffer resources. Tt is recommended to use
<constant>OCI_LOB_BUFFER_FREE</constant> flag only when you are not going
to work with the LOB anymore.
</para>
<para>
<function>lob->flush</function> returns &false; if buffering was not
enabled or an error occured.
enabled or an error occurred.
</para>
<para>
&return.success;

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-load">
<refnamediv>
<refname>lob->load</refname>
@ -12,12 +12,11 @@
<void />
</methodsynopsis>
<para>
Returns large object's contents. Remember, that really
<emphasis>large</emphasis> objects can or cannot fit in a variable, which
size is limited with <link linkend="ini.memory-limit">memory_limit</link>.
So, in most cases it's recommended to use
<function>oci_lob_read</function> instead. In case of error
<function>lob->load</function> returns &false;.
Returns large object's contents. As script execution is terminated
when the <link linkend="ini.memory-limit">memory_limit</link> is reached,
ensure that the LOB does not exceed this limit. In most cases it's
recommended to use <function>oci_lob_read</function> instead. In case of
error <function>lob->load</function> returns &false;.
</para>
</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-rewind">
<refnamediv>
<refname>lob->rewind</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->rewind</methodname>
<type>bool</type><methodname>lob->rewind</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-seek">
<refnamediv>
<refname>lob->seek</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->seek</methodname>
<type>bool</type><methodname>lob->seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>

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-truncate">
<refnamediv>
<refname>lob->truncate</refname>
@ -8,7 +8,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>lob->truncate</methodname>
<type>bool</type><methodname>lob->truncate</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</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-write-temporary">
<refnamediv>
<refname>lob->writeTemporary</refname>
@ -28,7 +28,7 @@
</simplelist>
</para>
<para>
<function>lob->writeTemporary</function> creates CLOB by default.
<function>lob->writeTemporary</function> creates a CLOB by default.
</para>
<para>
You should use <function>oci_lob_close</function> when the work with the

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<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>bool</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>
@ -18,7 +18,7 @@
Changes password for user with <parameter>username</parameter>.
Parameters <parameter>old_password</parameter> and
<parameter>new_password</parameter> should indicate old and new passwords
accordingly.
respectively.
</para>
<para>
&return.success;

View file

@ -1,11 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-pconnect">
<refnamediv>
<refname>oci_pconnect</refname>
<refpurpose>
Connect to an Oracle database using a persistent connection
</refpurpose>
<refpurpose>Connect to an Oracle database using a persistent connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -28,6 +26,14 @@
<function>oci_pconnect</function> returns connection identifier or
&false; on error.
</para>
<note>
<para>
Note, that these kind of links only work if you are using
a module version of PHP. See the
<link linkend="features.persistent-connections">Persistent
Database Connections</link> section for more information.
</para>
</note>
<para>
See also <function>oci_connect</function> and
<function>oci_new_connect</function>.