php-doc-en/reference/mysqli/mysqli_result.xml
2022-04-05 13:48:02 +02:00

145 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mysqli-result" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The mysqli_result class</title>
<titleabbrev>mysqli_result</titleabbrev>
<partintro>
<!-- {{{ ClassName intro -->
<section xml:id="mysqli-result.intro">
&reftitle.intro;
<para>
Represents the result set obtained from a query against the database.
</para>
</section>
<!-- }}} -->
<section xml:id="mysqli-result.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>mysqli_result</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>mysqli_result</classname>
</ooclass>
<oointerface>
<interfacename>IteratorAggregate</interfacename>
</oointerface>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="mysqli-result.current-field">current_field</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="mysqli-result.field-count">field_count</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>array</type><type>null</type></type>
<varname linkend="mysqli-result.lengths">lengths</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>int</type><type>string</type></type>
<varname linkend="mysqli-result.num-rows">num_rows</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname linkend="mysqli-result.props.type">type</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-result')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<section xml:id="mysqli-result.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="mysqli-result.props.type">
<term>
<varname>type</varname>
</term>
<listitem>
<para>
Stores whether the result is buffered or unbuffered as an &integer;
(<constant>MYSQLI_STORE_RESULT</constant> or
<constant>MYSQLI_USE_RESULT</constant>, respectively).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<classname>mysqli_result</classname> implements
<interfacename>IteratorAggregate</interfacename> now.
Previously, <interfacename>Traversable</interfacename> was implemented instead.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</partintro>
&reference.mysqli.entities.mysqli-result;
</phpdoc:classref>
<!-- 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
-->