1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
5
<!-- template designed by Marco Von Ballmoos -->
6
<title>Docs For Class PdoQuery</title>
7
<link rel="stylesheet" href="../../media/stylesheet.css" />
8
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
11
<div class="page-body">
12
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
15
style="vertical-align: middle"> PdoQuery</h2>
17
<a name="sec-description"></a>
18
<div class="info-box">
19
<div class="info-box-title">Description</div>
21
<span class="disabled">Description</span> |
22
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25
<div class="info-box-body">
26
<!-- ========== Info from phpDoc block ========= -->
27
<p class="short-description">A variable of this class is normally constructed through a call to PdoDatabase::Query or PdoDatabase::Prepare, associating it on construction with the database which is to be queried.</p>
29
Located in <a class="field" href="_inc---PdoQuery.php.html">/inc/PdoQuery.php</a> (line <span class="field">395</span>)
41
<a name="sec-method-summary"></a>
42
<div class="info-box">
43
<div class="info-box-title">Method Summary</span></div>
45
<a href="#sec-description">Description</a> |
46
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
48
<div class="info-box-body">
49
<div class="method-summary">
50
<div class="method-definition">
51
<img src="../../media/images/Constructor.png" alt=" "/>
52
<span class="method-result">PdoQuery</span>
53
<a href="#__construct" title="details" class="method-name">__construct</a>
54
(<span class="var-type"></span> <span class="var-name">$db</span>)
56
<div class="method-definition">
57
<img src="../../media/images/Method.png" alt=" "/>
58
<span class="method-result">void</span>
59
<a href="#Exec" title="details" class="method-name">Exec</a>
62
<div class="method-definition">
63
<img src="../../media/images/Method.png" alt=" "/>
64
<span class="method-result">void</span>
65
<a href="#Fetch" title="details" class="method-name">Fetch</a>
68
<div class="method-definition">
69
<img src="../../media/images/Method.png" alt=" "/>
70
<span class="method-result">void</span>
71
<a href="#FetchAll" title="details" class="method-name">FetchAll</a>
74
<div class="method-definition">
75
<img src="../../media/images/Method.png" alt=" "/>
76
<span class="method-result">void</span>
77
<a href="#FetchArray" title="details" class="method-name">FetchArray</a>
80
<div class="method-definition">
81
<img src="../../media/images/Method.png" alt=" "/>
82
<span class="method-result">void</span>
83
<a href="#MaxDuration" title="details" class="method-name">MaxDuration</a>
84
(<span class="var-type">double</span> <span class="var-name">$seconds</span>)
86
<div class="method-definition">
87
<img src="../../media/images/Method.png" alt=" "/>
88
<span class="method-result">void</span>
89
<a href="#Query" title="details" class="method-name">Query</a>
92
<div class="method-definition">
93
<img src="../../media/images/Method.png" alt=" "/>
94
<span class="method-result">void</span>
95
<a href="#Rows" title="details" class="method-name">Rows</a>
103
<a name="sec-methods"></a>
104
<div class="info-box">
105
<div class="info-box-title">Methods</div>
106
<div class="nav-bar">
107
<a href="#sec-description">Description</a> |
108
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
111
<div class="info-box-body">
112
<A NAME='method_detail'></A>
113
<a name="method__construct" id="__construct"><!-- --></a>
116
<div class="method-header">
117
<img src="../../media/images/Constructor.png" />
118
<span class="method-title">Constructor __construct</span> (line <span class="line-number">406</span>)
121
<!-- ========== Info from phpDoc block ========= -->
122
<p class="short-description">Where $db is a PdoDatabase object. This constructs the PdoQuery. If there are further parameters they will be in turn, the sql, and any positional parameters to replace into that, and will be passed to $this->Query() before returning.</p>
124
<div class="method-signature">
125
<span class="method-result">PdoQuery</span>
126
<span class="method-name">
129
(<span class="var-type"></span> <span class="var-name">$db</span>)
132
<ul class="parameters">
134
<span class="var-type"></span>
135
<span class="var-name">$db</span> </li>
140
<a name="methodExec" id="Exec"><!-- --></a>
141
<div class="evenrow">
143
<div class="method-header">
144
<img src="../../media/images/Method.png" />
145
<span class="method-title">Exec</span> (line <span class="line-number">433</span>)
148
<!-- ========== Info from phpDoc block ========= -->
149
<p class="short-description">If there are (some) positional parameters in the prepared query, now is the last chance to supply them...</p>
150
<p class="description"><p>before the query is executed. Returns true on success and false on error.</p></p>
152
<div class="method-signature">
153
<span class="method-result">void</span>
154
<span class="method-name">
163
<a name="methodFetch" id="Fetch"><!-- --></a>
166
<div class="method-header">
167
<img src="../../media/images/Method.png" />
168
<span class="method-title">Fetch</span> (line <span class="line-number">447</span>)
171
<!-- ========== Info from phpDoc block ========= -->
172
<p class="short-description">Will fetch the next row from the query into an object with elements named for the fields in the result.</p>
174
<div class="method-signature">
175
<span class="method-result">void</span>
176
<span class="method-name">
185
<a name="methodFetchAll" id="FetchAll"><!-- --></a>
186
<div class="evenrow">
188
<div class="method-header">
189
<img src="../../media/images/Method.png" />
190
<span class="method-title">FetchAll</span> (line <span class="line-number">464</span>)
193
<!-- ========== Info from phpDoc block ========= -->
194
<p class="short-description">Will fetch all result rows from the query into an array of objects with elements named for the fields in the result.</p>
196
<div class="method-signature">
197
<span class="method-result">void</span>
198
<span class="method-name">
207
<a name="methodFetchArray" id="FetchArray"><!-- --></a>
210
<div class="method-header">
211
<img src="../../media/images/Method.png" />
212
<span class="method-title">FetchArray</span> (line <span class="line-number">456</span>)
215
<!-- ========== Info from phpDoc block ========= -->
216
<p class="short-description">Will fetch the next row from the query into an array with numbered elements and with elements named for the fields in the result.</p>
218
<div class="method-signature">
219
<span class="method-result">void</span>
220
<span class="method-name">
229
<a name="methodMaxDuration" id="MaxDuration"><!-- --></a>
230
<div class="evenrow">
232
<div class="method-header">
233
<img src="../../media/images/Method.png" />
234
<span class="method-title">MaxDuration</span> (line <span class="line-number">481</span>)
237
<!-- ========== Info from phpDoc block ========= -->
238
<p class="short-description">Used to set the maximum duration for this query before it will be logged as a slow query.</p>
240
<div class="method-signature">
241
<span class="method-result">void</span>
242
<span class="method-name">
245
(<span class="var-type">double</span> <span class="var-name">$seconds</span>)
248
<ul class="parameters">
250
<span class="var-type">double</span>
251
<span class="var-name">$seconds</span><span class="var-description">: The maximum duration for this statement before logging it as 'slow'</span> </li>
256
<a name="methodQuery" id="Query"><!-- --></a>
259
<div class="method-header">
260
<img src="../../media/images/Method.png" />
261
<span class="method-title">Query</span> (line <span class="line-number">419</span>)
264
<!-- ========== Info from phpDoc block ========= -->
265
<p class="short-description">If the sql is supplied then PDO::prepare will be called with that SQL to prepare the query, and if there are positional parameters then they will be replaced into the sql_string (with appropriate escaping) before the call to PDO::prepare. Query preparation time is counted towards total query execution time.</p>
267
<div class="method-signature">
268
<span class="method-result">void</span>
269
<span class="method-name">
278
<a name="methodRows" id="Rows"><!-- --></a>
279
<div class="evenrow">
281
<div class="method-header">
282
<img src="../../media/images/Method.png" />
283
<span class="method-title">Rows</span> (line <span class="line-number">472</span>)
286
<!-- ========== Info from phpDoc block ========= -->
287
<p class="short-description">An accessor for the number of rows affected when the query was executed.</p>
289
<div class="method-signature">
290
<span class="method-result">void</span>
291
<span class="method-name">
305
<p class="notes" id="credit">
306
Documentation generated on Fri, 10 Apr 2009 23:45:54 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
b'\\ No newline at end of file'
added
removed
docs/api/awl/PdoQuery/PdoQuery.html
