/
querysingle.xml
117 lines (108 loc) · 2.98 KB
/
querysingle.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sqlite3.querysingle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3::querySingle</refname>
<refpurpose>Executes a query and returns a single result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>SQLite3::querySingle</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>entire_row</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Executes a query and returns a single result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The SQL query to execute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entire_row</parameter></term>
<listitem>
<para>
By default, <function>querySingle</function> returns the value of the
first column returned by the query. If
<parameter>entire_row</parameter> is &true;, then it returns an array
of the entire first row.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the first column of results or an array of the entire
first row (if <parameter>entire_row</parameter> is &true;).
</para>
<para>
If the query is valid but no results are returned, then &null; will be
returned if <parameter>entire_row</parameter> is &false;, otherwise an
empty array is returned.
</para>
<para>
Invalid or failing queries will return &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SQLite3::querySingle</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3('mysqlitedb.db');
var_dump($db->querySingle('SELECT username FROM user WHERE userid=1'));
print_r($db->querySingle('SELECT username, email FROM user WHERE userid=1', true));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(5) "Scott"
Array
(
[username] => Scott
[email] => scott@example.com
)
]]>
</screen>
</example>
</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
-->