mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
3.1 KiB
XML
113 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.dbx-fetch-row" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>dbx_fetch_row</refname>
|
|
<refpurpose>Fetches rows from a query-result that had the
|
|
<constant>DBX_RESULT_UNBUFFERED</constant> flag set</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>dbx_fetch_row</methodname>
|
|
<methodparam><type>object</type><parameter>result_identifier</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>dbx_fetch_row</function> fetches rows from a result identifier
|
|
that had the <constant>DBX_RESULT_UNBUFFERED</constant> flag set.
|
|
</para>
|
|
<para>
|
|
When the <constant>DBX_RESULT_UNBUFFERED</constant> is not set in the
|
|
query, <function>dbx_fetch_row</function> will fail as all rows have
|
|
already been fetched into the results <property>data</property> property.
|
|
</para>
|
|
<para>
|
|
As a side effect, the <property>rows</property> property of the query-result
|
|
object is incremented for each successful call to
|
|
<function>dbx_fetch_row</function>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>result_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A result set returned by <function>dbx_query</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an object on success that contains the same information as any row
|
|
would have in the <function>dbx_query</function> result
|
|
<property>data</property> property, including columns accessible by index
|
|
or fieldname when the flags for <function>dbx_query</function> were set
|
|
that way.
|
|
</para>
|
|
<para>
|
|
Upon failure, returns <literal>0</literal> (e.g. when no more rows are
|
|
available).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>How to handle the returned value</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$result = dbx_query($link, 'SELECT id, parentid, description FROM table', DBX_RESULT_UNBUFFERED);
|
|
|
|
echo "<table>\n";
|
|
while ($row = dbx_fetch_row($result)) {
|
|
echo "<tr>\n";
|
|
foreach ($row as $field) {
|
|
echo "<td>$field</td>";
|
|
}
|
|
echo "</tr>\n";
|
|
}
|
|
echo "</table>\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>dbx_query</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|