php-doc-en/reference/sqlite/functions/sqlite-fetch-single.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.sqlite-fetch-single" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_fetch_single</refname>
  <refname>SQLiteResult->fetchSingle</refname>
  <refname>SQLiteUnbuffered->fetchSingle</refname>
  <refpurpose>Fetches the first column of a result set as a string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sqlite_fetch_single</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>decode_binary</parameter><initializer>true</initializer></methodparam>
  </methodsynopsis>
  <para>Object oriented style (method):</para>
  <classsynopsis>
   <ooclass><classname>SQLiteResult</classname></ooclass>
   <methodsynopsis>
    <type>string</type><methodname>fetchSingle</methodname>
    <methodparam choice="opt"><type>bool</type><parameter>decode_binary</parameter><initializer>true</initializer></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <classsynopsis>
   <ooclass><classname>SQLiteUnbuffered</classname></ooclass>
   <methodsynopsis>
    <type>string</type><methodname>fetchSingle</methodname>
    <methodparam choice="opt"><type>bool</type><parameter>decode_binary</parameter><initializer>true</initializer></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   <function>sqlite_fetch_single</function> is identical to
   <function>sqlite_fetch_array</function> except that it returns the value
   of the first column of the rowset.
  </para>
  <para>
   This is the most optimal way to retrieve data when you are only
   interested in the values from a single column of data.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       The SQLite result resource.  This parameter is not required when using
       the object-oriented method.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>decode_binary</parameter></term>
     <listitem>
      &sqlite.decode-bin;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the first column value, as a string.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>sqlite_fetch_single</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
if ($dbhandle = sqlite_open('mysqlitedb', 0666, $sqliteerror)) {

    $sql = "SELECT id FROM sometable WHERE id = 42";
    $res = sqlite_query($dbhandle, $sql);

    if (sqlite_num_rows($res) > 0) {
        echo sqlite_fetch_single($res); // 42
    }
    
    sqlite_close($dbhandle);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlite_fetch_array</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
 sgml-parent-document:nil
 sgml-default-dtd-file:"../../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
 -->