php-doc-en/reference/mysqli/mysqli_result/fetch-column.xml

149 lines
4.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="mysqli-result.fetch-column" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_column</refname>
<refname>mysqli_fetch_column</refname>
<refpurpose>Fetch a single column from the next row of a result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>null</type><type>int</type><type>float</type><type>string</type><type>false</type></type><methodname>mysqli_result::fetch_column</methodname>
<methodparam choice="opt"><type>int</type><parameter>column</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type class="union"><type>null</type><type>int</type><type>float</type><type>string</type><type>false</type></type><methodname>mysqli_fetch_column</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>column</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Fetches one row of data from the result set and returns the 0-indexed column.
Each subsequent call to this function will return the value from next row
within the result set, or &false; if there are no more rows.
</para>
&database.fetch-null;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&mysqli.result.description;
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
0-indexed number of the column you wish to retrieve from the row. If
no value is supplied, the first column will be returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>mysqli_fetch_column</function> returns a single column
from the next row of a result set or &false; if there are no more rows.
</para>
<warning>
<para>
There is no way to return another column from the same row if you
use this function to retrieve data.
</para>
</warning>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>mysqli_result::fetch_column</methodname> example</title>
<para>&style.oop;</para>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
$query = "SELECT CountryCode, Name FROM City ORDER BY ID DESC LIMIT 5";
$result = $mysqli->query($query);
/* fetch a single value from the second column */
while ($Name = $result->fetch_column(1)) {
printf("%s\n", $Name);
}
]]>
</programlisting>
<para>&style.procedural;</para>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = mysqli_connect("localhost", "my_user", "my_password", "world");
$query = "SELECT CountryCode, Name FROM City ORDER BY ID DESC LIMIT 5";
$result = mysqli_query($mysqli, $query);
/* fetch a single value from the second column */
while ($Name = mysqli_fetch_column($result, 1)) {
printf("%s\n", $Name);
}
]]>
</programlisting>
&examples.outputs.similar;
<screen>
<![CDATA[
Rafah
Nablus
Jabaliya
Hebron
Khan Yunis
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_fetch_all</function></member>
<member><function>mysqli_fetch_array</function></member>
<member><function>mysqli_fetch_assoc</function></member>
<member><function>mysqli_fetch_object</function></member>
<member><function>mysqli_fetch_row</function></member>
<member><function>mysqli_data_seek</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
-->