<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xml:id="sqlite3result.fetcharray" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>SQLite3Result::fetchArray</refname>

<refpurpose>

Fetches a result row as an associative or numerically indexed array or both

</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="SQLite3Result">

<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SQLite3Result::fetchArray</methodname>

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>SQLITE3_BOTH</constant></initializer></methodparam>

</methodsynopsis>

<para>

Fetches a result row as an associative or numerically indexed array or both.

By default, fetches as both.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>mode</parameter></term>

<listitem>

<para>

Controls how the next row will be returned to the caller. This value

must be one of either <constant>SQLITE3_ASSOC</constant>,

<constant>SQLITE3_NUM</constant>, or <constant>SQLITE3_BOTH</constant>.

<itemizedlist>

<listitem>

<para>

<constant>SQLITE3_ASSOC</constant>: returns an array indexed by column

name as returned in the corresponding result set

</para>

</listitem>

<listitem>

<para>

<constant>SQLITE3_NUM</constant>: returns an array indexed by column

number as returned in the corresponding result set, starting at

column 0

</para>

</listitem>

<listitem>

<para>

<constant>SQLITE3_BOTH</constant>: returns an array indexed by both

column name and number as returned in the corresponding result set,

starting at column 0

</para>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns a result row as an associatively or numerically indexed array or

both. Alternately will return &false; if there are no more rows.

</para>

<para>

The types of the values of the returned array are mapped from SQLite3 types

as follows: integers are mapped to <type>int</type> if they fit into the

range <constant>PHP_INT_MIN</constant>..<constant>PHP_INT_MAX</constant>, and

to <type>string</type> otherwise. Floats are mapped to <type>float</type>,

<literal>NULL</literal> values are mapped to <type>null</type>, and strings

and blobs are mapped to <type>string</type>.

</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

-->