svn: /phpdoc/en/trunk/reference/cubrid/functions/ cubrid-fetch-object.xml cubrid-prepare.xml cubrid-unbuffered-query.xml
| From: | Esen Sagynov | Date: | Tue, 04 Jan 2011 02:18:05 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/cubrid/functions/ cubrid-fetch-object.xml cubrid-prepare.xml cubrid-unbuffered-query.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7601@lists.php.net to get a copy of this message | ||
cubrid Tue, 04 Jan 2011 02:18:05 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=307053
Log:
update doc for cubrid_fetch_object and cubrid_unbuffered_query; fix a spell mistake in doc for
cubrid_prepare
Changed paths:
U phpdoc/en/trunk/reference/cubrid/functions/cubrid-fetch-object.xml
U phpdoc/en/trunk/reference/cubrid/functions/cubrid-prepare.xml
U phpdoc/en/trunk/reference/cubrid/functions/cubrid-unbuffered-query.xml
Modified: phpdoc/en/trunk/reference/cubrid/functions/cubrid-fetch-object.xml
===================================================================
--- phpdoc/en/trunk/reference/cubrid/functions/cubrid-fetch-object.xml 2011-01-04 01:53:04 UTC (rev
307052)
+++ phpdoc/en/trunk/reference/cubrid/functions/cubrid-fetch-object.xml 2011-01-04 02:18:05 UTC (rev
307053)
@@ -12,6 +12,8 @@
<methodsynopsis>
<type>object</type><methodname>cubrid_fetch_object</methodname>
<methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
+ <methodparam
choice="opt"><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>
This function returns an object with the column names of the result set as properties. The
values of these properties are extracted from the current row of the result.
@@ -22,9 +24,27 @@
&reftitle.parameters;
<para>
<variablelist>
+ <varlistentry>
+ <term><parameter>req_identifier</parameter></term>
+ <listitem><para>This is the request identifier.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>class_name</parameter></term>
+ <listitem>
+ <para>
+ The name of the class to instantiate, set the properties of and return.
+ If not specified, a <classname>stdClass</classname> object is returned.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><parameter>req_identifier</parameter></term>
- <listitem><para>This is the request identifier.</para></listitem>
+ <term><parameter>params</parameter></term>
+ <listitem>
+ <para>
+ An optional <type>array</type> of parameters to pass to the constructor
+ for <parameter>class_name</parameter> objects.
+ </para>
+ </listitem>
</varlistentry>
</variablelist>
</para>
Modified: phpdoc/en/trunk/reference/cubrid/functions/cubrid-prepare.xml
===================================================================
--- phpdoc/en/trunk/reference/cubrid/functions/cubrid-prepare.xml 2011-01-04 01:53:04 UTC (rev
307052)
+++ phpdoc/en/trunk/reference/cubrid/functions/cubrid-prepare.xml 2011-01-04 02:18:05 UTC (rev
307053)
@@ -19,7 +19,7 @@
The <function>cubrid_prepare</function> function is a sort of API which
represents SQL statements compiled previously to a given connection handle. This pre-compiled SQL
statement will be included in the <function>cubrid_prepare</function>.
</para>
<para>
- Accccordingly, you can use this statement effectively to execute several times repeatedly or
to process long data. Only a single statement can be used and a parameter may put a question mark
(?) to appropriate area in the SQL statement. Add a parameter when you bind a value in the VALUES
cluse of INSERT statement or in the WHERE clause. Note that it is allowed to bind a value to a
MARK(?) by the <function>cubrid_bind</function> only.
+ Accccordingly, you can use this statement effectively to execute several times repeatedly or
to process long data. Only a single statement can be used and a parameter may put a question mark
(?) to appropriate area in the SQL statement. Add a parameter when you bind a value in the VALUES
clause of INSERT statement or in the WHERE clause. Note that it is allowed to bind a value to a
MARK(?) by the <function>cubrid_bind</function> only.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/cubrid/functions/cubrid-unbuffered-query.xml
===================================================================
--- phpdoc/en/trunk/reference/cubrid/functions/cubrid-unbuffered-query.xml 2011-01-04 01:53:04 UTC
(rev 307052)
+++ phpdoc/en/trunk/reference/cubrid/functions/cubrid-unbuffered-query.xml 2011-01-04 02:18:05 UTC
(rev 307053)
@@ -17,9 +17,6 @@
<para>
This function performs a query without fetching the results into memory.
</para>
- <para>
- Known issue: it currently uses the normal version - the one that fetches the results.
- </para>
</refsect1>
<refsect1 role="parameters">
@@ -51,6 +48,18 @@
</para>
</refsect1>
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ The benefits of <function>cubrid_unbuffered_query</function> come
+ at a cost: you cannot use <function>cubrid_num_rows</function> and
+ <function>cubrid_data_seek</function> on a result set returned from
+ <function>cubrid_unbuffered_query</function>.
+ </para>
+ </note>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<example>