1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="mysqli-result.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli_result::__construct</refname>
<refpurpose>Constructs a <classname>mysqli_result</classname> object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="mysqli_result">
<modifier>public</modifier> <methodname>mysqli_result::__construct</methodname>
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_mode</parameter><initializer><constant>MYSQLI_STORE_RESULT</constant></initializer></methodparam>
</constructorsynopsis>
<para>
This method constructs a new <classname>mysqli_result</classname> object.
</para>
<para>
It can be used to create the <classname>mysqli_result</classname> object
after calling the <function>mysqli_real_query</function> or
<function>mysqli_multi_query</function> function. Constructing the object
manually is equivalent to calling the <function>mysqli_store_result</function>
or <function>mysqli_use_result</function> function.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&mysqli.link.description;
<varlistentry>
<term><parameter>result_mode</parameter></term>
<listitem>
<para>
The result mode can be one of 2 constants indicating how the result will
be returned from the MySQL server.
</para>
<para>
<constant>MYSQLI_STORE_RESULT</constant> (default) - creates a
<classname>mysqli_result</classname> object with buffered result set.
</para>
<para>
<constant>MYSQLI_USE_RESULT</constant> - creates a
<classname>mysqli_result</classname> object with unbuffered result set.
As long as there are pending records waiting to be fetched, the
connection line will be busy and all subsequent calls will return error
<literal>Commands out of sync</literal>. To avoid the error all records
must be fetched from the server or the result set must be discarded by
calling <function>mysqli_free_result</function>. The connection must
remain open for the rows to be fetched.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&mysqli.conditionalexception;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Creation of a <classname>mysqli_result</classname> object</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* Select queries return a result set */
$mysqli->real_query("SELECT Name FROM City LIMIT 10");
$result = new mysqli_result($mysqli);
printf("Select returned %d rows.\n", $result->num_rows);
]]>
</programlisting>
&examples.outputs.similar;
<screen>
<![CDATA[
Select returned 10 rows.
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_multi_query</function></member>
<member><function>mysqli_real_query</function></member>
<member><function>mysqli_store_result</function></member>
<member><function>mysqli_use_result</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
-->
|