<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Executes a query and returns a single result</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="sqlite3.query.html">SQLite3::query</a></div> <div class="next" style="text-align: right; float: right;"><a href="sqlite3.version.html">SQLite3::version</a></div> <div class="up"><a href="class.sqlite3.html">SQLite3</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="sqlite3.querysingle" class="refentry"> <div class="refnamediv"> <h1 class="refname">SQLite3::querySingle</h1> <p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">SQLite3::querySingle</span> — <span class="dc-title">Executes a query and returns a single result</span></p> </div> <div class="refsect1 description" id="refsect1-sqlite3.querysingle-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>SQLite3::querySingle</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$entire_row</code><span class="initializer"> = false</span></span> ] )</div> <p class="para rdfs-comment"> Executes a query and returns a single result. </p> </div> <div class="refsect1 parameters" id="refsect1-sqlite3.querysingle-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">query</code></em></span> <dd> <p class="para"> The SQL query to execute. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">entire_row</code></em></span> <dd> <p class="para"> By default, <span class="function"><strong>querySingle()</strong></span> returns the value of the first column returned by the query. If <em><code class="parameter">entire_row</code></em> is <strong><code>TRUE</code></strong>, then it returns an array of the entire first row. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-sqlite3.querysingle-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the value of the first column of results or an array of the entire first row (if <em><code class="parameter">entire_row</code></em> is <strong><code>TRUE</code></strong>). </p> <p class="para"> If the query is valid but no results are returned, then <strong><code>NULL</code></strong> will be returned if <em><code class="parameter">entire_row</code></em> is <strong><code>FALSE</code></strong>, otherwise an empty array is returned. </p> <p class="para"> Invalid or failing queries will return <strong><code>FALSE</code></strong>. </p> </div> <div class="refsect1 examples" id="refsect1-sqlite3.querysingle-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2164"> <p><strong>Example #1 <span class="function"><strong>SQLite3::querySingle()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$db </span><span style="color: #007700">= new </span><span style="color: #0000BB">SQLite3</span><span style="color: #007700">(</span><span style="color: #DD0000">'mysqlitedb.db'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">querySingle</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT username FROM user WHERE userid=1'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">querySingle</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT username, email FROM user WHERE userid=1'</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(5) "Scott" Array ( [username] => Scott [email] => scott@example.com ) </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="sqlite3.query.html">SQLite3::query</a></div> <div class="next" style="text-align: right; float: right;"><a href="sqlite3.version.html">SQLite3::version</a></div> <div class="up"><a href="class.sqlite3.html">SQLite3</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>