mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-04-03 09:48:55 +00:00
b1fc217c5f
* Changed article * More accurate description * More accurate return value * Improved example * See also * Add a note Closes GH-891.
144 lines
3.9 KiB
XML
144 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mysqli-result.num-rows" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>mysqli_result::$num_rows</refname>
|
|
<refname>mysqli_num_rows</refname>
|
|
<refpurpose>Gets the number of rows in the result set</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.oop;</para>
|
|
<fieldsynopsis><type class="union"><type>int</type><type>string</type></type><varname linkend="mysqli-result.num-rows">mysqli_result->num_rows</varname></fieldsynopsis>
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis>
|
|
<type class="union"><type>int</type><type>string</type></type><methodname>mysqli_num_rows</methodname>
|
|
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the number of rows in the result set.
|
|
</para>
|
|
<para>
|
|
The behaviour of <function>mysqli_num_rows</function> depends on whether
|
|
buffered or unbuffered result sets are being used.
|
|
This function returns <literal>0</literal> for unbuffered result sets unless
|
|
all rows have been fetched from the server.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&mysqli.result.description;
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An <type>int</type> representing the number of fetched rows.
|
|
Returns <literal>0</literal> in unbuffered mode unless all rows have been
|
|
fetched from the server.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If the number of rows is greater than <constant>PHP_INT_MAX</constant>, the number
|
|
will be returned as a string.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>&style.oop;</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
|
|
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
|
|
|
|
$result = $mysqli->query("SELECT Code, Name FROM Country ORDER BY Name");
|
|
|
|
/* Get the number of rows in the result set */
|
|
$row_cnt = $result->num_rows;
|
|
|
|
printf("Result set has %d rows.\n", $row_cnt);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>&style.procedural;</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
|
|
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
|
|
|
|
$result = mysqli_query($link, "SELECT Code, Name FROM Country ORDER BY Name");
|
|
|
|
/* Get the number of rows in the result set */
|
|
$row_cnt = mysqli_num_rows($result);
|
|
|
|
printf("Result set has %d rows.\n", $row_cnt);
|
|
]]>
|
|
</programlisting>
|
|
&examples.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Result set has 239 rows.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mysqli_affected_rows</function></member>
|
|
<member><function>mysqli_store_result</function></member>
|
|
<member><function>mysqli_use_result</function></member>
|
|
<member><function>mysqli_query</function></member>
|
|
<member><function>mysqli_stmt_num_rows</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
In contrast to the <function>mysqli_stmt_num_rows</function> function,
|
|
this function doesn't have object-oriented method variant.
|
|
In the object-oriented style, use the getter property.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|