?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.9.9
[davical.git] / docs / api / awl / AwlDatabase / AwlDatabase.html
blob376ce115ab89d5641d796ba6d74f1322491fdc2e
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">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class AwlDatabase</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
13 alt=" Class"
14 title=" Class"
15 style="vertical-align: middle"> AwlDatabase</h2>
16
17 <a name="sec-description"></a>
18 <div class="info-box">
19 <div class="info-box-title">Description</div>
20 <div class="nav-bar">
21 <span class="disabled">Description</span> |
22 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
23 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
24
25 </div>
26 <div class="info-box-body">
27 <!-- ========== Info from phpDoc block ========= -->
28 <p class="short-description">Typically there will only be a single instance of the database level class in an application.</p>
29 <p class="notes">
30 Located in <a class="field" href="_inc---AwlDatabase.php.html">/inc/AwlDatabase.php</a> (line <span class="field">58</span>)
31 </p>
32
33
34 <pre><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a>
35 |
36 --AwlDatabase</pre>
37
38 </div>
39 </div>
40
41
42
43 <a name="sec-var-summary"></a>
44 <div class="info-box">
45 <div class="info-box-title">Variable Summary</span></div>
46 <div class="nav-bar">
47 <a href="#sec-description">Description</a> |
48 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
49 |
50 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
51
52 </div>
53 <div class="info-box-body">
54 <div class="var-summary">
55 <div class="var-title">
56 <img src="../../media/images/Variable.png" alt=" " />
57 <span class="var-type">mixed</span>
58 <a href="#$translate_all" title="details" class="var-name">$translate_all</a>
59 </div>
60 <div class="var-title">
61 <img src="../../media/images/Variable.png" alt=" " />
62 <span class="var-type">mixed</span>
63 <a href="#$txnstate" title="details" class="var-name">$txnstate</a>
64 </div>
65 </div>
66 </div>
67 </div>
68
69 <a name="sec-method-summary"></a>
70 <div class="info-box">
71 <div class="info-box-title">Method Summary</span></div>
72 <div class="nav-bar">
73 <a href="#sec-description">Description</a> |
74 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
75
76 |
77 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
78 </div>
79 <div class="info-box-body">
80 <div class="method-summary">
81 <div class="method-definition">
82 <img src="../../media/images/Method.png" alt=" "/>
83 <span class="method-result">void</span>
84 <a href="#Begin" title="details" class="method-name">Begin</a>
85 ()
86 </div>
87 <div class="method-definition">
88 <img src="../../media/images/Method.png" alt=" "/>
89 <span class="method-result">void</span>
90 <a href="#Commit" title="details" class="method-name">Commit</a>
91 ()
92 </div>
93 <div class="method-definition">
94 <img src="../../media/images/Method.png" alt=" "/>
95 <span class="method-result">void</span>
96 <a href="#ErrorInfo" title="details" class="method-name">ErrorInfo</a>
97 ()
98 </div>
99 <div class="method-definition">
100 <img src="../../media/images/Method.png" alt=" "/>
101 <span class="method-result">void</span>
102 <a href="#prepare" title="details" class="method-name">prepare</a>
103 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$driver_options</span> = <span class="var-default">array()</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$sql_query_string</span>)
104 </div>
105 <div class="method-definition">
106 <img src="../../media/images/Method.png" alt=" "/>
107 <span class="method-result">void</span>
108 <a href="#PrepareTranslated" title="details" class="method-name">PrepareTranslated</a>
109 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$driver_options</span> = <span class="var-default">array()</span>])
110 </div>
111 <div class="method-definition">
112 <img src="../../media/images/Method.png" alt=" "/>
113 <span class="method-result">void</span>
114 <a href="#query" title="details" class="method-name">query</a>
115 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sql_query_string</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
116 </div>
117 <div class="method-definition">
118 <img src="../../media/images/Method.png" alt=" "/>
119 <span class="method-result">void</span>
120 <a href="#Rollback" title="details" class="method-name">Rollback</a>
121 ()
122 </div>
123 <div class="method-definition">
124 <img src="../../media/images/Method.png" alt=" "/>
125 <span class="method-result">void</span>
126 <a href="#TransactionState" title="details" class="method-name">TransactionState</a>
127 ()
128 </div>
129 <div class="method-definition">
130 <img src="../../media/images/Method.png" alt=" "/>
131 <span class="method-result">void</span>
132 <a href="#TranslateAll" title="details" class="method-name">TranslateAll</a>
133 (<span class="var-type"></span>&nbsp;<span class="var-name">$onoff_boolean</span>)
134 </div>
135 </div>
136 </div>
137 </div>
138
139 <a name="sec-vars"></a>
140 <div class="info-box">
141 <div class="info-box-title">Variables</div>
142 <div class="nav-bar">
143 <a href="#sec-description">Description</a> |
144 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
145
146
147 |
148 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
149
150 </div>
151 <div class="info-box-body">
152
153 <a name="var$translate_all" id="$translate_all"><!-- --></A>
154 <div class="evenrow">
155
156 <div class="var-header">
157 <img src="../../media/images/Variable.png" />
158 <span class="var-title">
159 <span class="var-type">mixed</span>
160 <span class="var-name">$translate_all</span>
161 = <span class="var-default"> false</span> (line <span class="line-number">71</span>)
162 </span>
163 </div>
164
165 <!-- ========== Info from phpDoc block ========= -->
166 <p class="short-description">Holds whether we are translating all statements.</p>
167 <ul class="tags">
168 <li><span class="field">access:</span> protected</li>
169 </ul>
170
171
172
173
174
175 </div>
176 <a name="var$txnstate" id="$txnstate"><!-- --></A>
177 <div class="oddrow">
178
179 <div class="var-header">
180 <img src="../../media/images/Variable.png" />
181 <span class="var-title">
182 <span class="var-type">mixed</span>
183 <span class="var-name">$txnstate</span>
184 = <span class="var-default"> 0</span> (line <span class="line-number">66</span>)
185 </span>
186 </div>
187
188 <!-- ========== Info from phpDoc block ========= -->
189 <p class="short-description">Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit</p>
190 <ul class="tags">
191 <li><span class="field">access:</span> protected</li>
192 </ul>
193
194
195
196
197
198 </div>
199 <h4>Inherited Variables</h4>
200 <A NAME='inherited_vars'><!-- --></A>
201 <p>Inherited from <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
202 <blockquote>
203 <img src="../../media/images/Variable.png" />
204 <span class="var-title">
205 <span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$db">AwlDBDialect::$db</a></span><br />
206 </span>
207 <img src="../../media/images/Variable.png" />
208 <span class="var-title">
209 <span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$dialect">AwlDBDialect::$dialect</a></span><br />
210 </span>
211 </blockquote>
212
213 </div>
214 </div>
215
216 <a name="sec-methods"></a>
217 <div class="info-box">
218 <div class="info-box-title">Methods</div>
219 <div class="nav-bar">
220 <a href="#sec-description">Description</a> |
221 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
222 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
223
224 </div>
225 <div class="info-box-body">
226 <A NAME='method_detail'></A>
227 <a name="methodBegin" id="Begin"><!-- --></a>
228 <div class="evenrow">
229
230 <div class="method-header">
231 <img src="../../media/images/Method.png" />
232 <span class="method-title">Begin</span> (line <span class="line-number">101</span>)
233 </div>
234
235 <!-- ========== Info from phpDoc block ========= -->
236 <p class="short-description">Begin a transaction.</p>
237
238 <div class="method-signature">
239 <span class="method-result">void</span>
240 <span class="method-name">
241 Begin
242 </span>
243 ()
244 </div>
245
246
247
248 </div>
249 <a name="methodCommit" id="Commit"><!-- --></a>
250 <div class="oddrow">
251
252 <div class="method-header">
253 <img src="../../media/images/Method.png" />
254 <span class="method-title">Commit</span> (line <span class="line-number">116</span>)
255 </div>
256
257 <!-- ========== Info from phpDoc block ========= -->
258 <p class="short-description">Complete a transaction.</p>
259
260 <div class="method-signature">
261 <span class="method-result">void</span>
262 <span class="method-name">
263 Commit
264 </span>
265 ()
266 </div>
267
268
269
270 </div>
271 <a name="methodErrorInfo" id="ErrorInfo"><!-- --></a>
272 <div class="evenrow">
273
274 <div class="method-header">
275 <img src="../../media/images/Method.png" />
276 <span class="method-title">ErrorInfo</span> (line <span class="line-number">172</span>)
277 </div>
278
279 <!-- ========== Info from phpDoc block ========= -->
280
281 <div class="method-signature">
282 <span class="method-result">void</span>
283 <span class="method-name">
284 ErrorInfo
285 </span>
286 ()
287 </div>
288
289
290
291 </div>
292 <a name="methodprepare" id="prepare"><!-- --></a>
293 <div class="oddrow">
294
295 <div class="method-header">
296 <img src="../../media/images/Method.png" />
297 <span class="method-title">prepare</span> (line <span class="line-number">80</span>)
298 </div>
299
300 <!-- ========== Info from phpDoc block ========= -->
301 <p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
302
303 <div class="method-signature">
304 <span class="method-result">void</span>
305 <span class="method-name">
306 prepare
307 </span>
308 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$driver_options</span> = <span class="var-default">array()</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$sql_query_string</span>)
309 </div>
310
311 <ul class="parameters">
312 <li>
313 <span class="var-type">string</span>
314 <span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
315 <li>
316 <span class="var-type">array</span>
317 <span class="var-name">$driver_options</span><span class="var-description">: PDO driver options to the prepare statement, commonly to do with cursors</span> </li>
318 <li>
319 <span class="var-type"></span>
320 <span class="var-name">$statement</span> </li>
321 </ul>
322
323
324 </div>
325 <a name="methodPrepareTranslated" id="PrepareTranslated"><!-- --></a>
326 <div class="evenrow">
327
328 <div class="method-header">
329 <img src="../../media/images/Method.png" />
330 <span class="method-title">PrepareTranslated</span> (line <span class="line-number">153</span>)
331 </div>
332
333 <!-- ========== Info from phpDoc block ========= -->
334 <p class="short-description">Operates identically to AwlDatabase::Prepare, except that $this-&gt;Translate() will be called on the query before any processing.</p>
335
336 <div class="method-signature">
337 <span class="method-result">void</span>
338 <span class="method-name">
339 PrepareTranslated
340 </span>
341 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$driver_options</span> = <span class="var-default">array()</span>])
342 </div>
343
344 <ul class="parameters">
345 <li>
346 <span class="var-type"></span>
347 <span class="var-name">$statement</span> </li>
348 <li>
349 <span class="var-type"></span>
350 <span class="var-name">$driver_options</span> </li>
351 </ul>
352
353
354 </div>
355 <a name="methodquery" id="query"><!-- --></a>
356 <div class="oddrow">
357
358 <div class="method-header">
359 <img src="../../media/images/Method.png" />
360 <span class="method-title">query</span> (line <span class="line-number">93</span>)
361 </div>
362
363 <!-- ========== Info from phpDoc block ========= -->
364 <p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
365
366 <div class="method-signature">
367 <span class="method-result">void</span>
368 <span class="method-name">
369 query
370 </span>
371 (<span class="var-type"></span>&nbsp;<span class="var-name">$statement</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sql_query_string</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
372 </div>
373
374 <ul class="parameters">
375 <li>
376 <span class="var-type">string</span>
377 <span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
378 <li>
379 <span class="var-type">mixed</span>
380 <span class="var-name">1</span><span class="var-description">: ... Subsequent arguments are positionally replaced into the $sql_query_string</span> </li>
381 <li>
382 <span class="var-type"></span>
383 <span class="var-name">$statement</span> </li>
384 </ul>
385
386
387 </div>
388 <a name="methodRollback" id="Rollback"><!-- --></a>
389 <div class="evenrow">
390
391 <div class="method-header">
392 <img src="../../media/images/Method.png" />
393 <span class="method-title">Rollback</span> (line <span class="line-number">128</span>)
394 </div>
395
396 <!-- ========== Info from phpDoc block ========= -->
397 <p class="short-description">Cancel a transaction in progress.</p>
398
399 <div class="method-signature">
400 <span class="method-result">void</span>
401 <span class="method-name">
402 Rollback
403 </span>
404 ()
405 </div>
406
407
408
409 </div>
410 <a name="methodTransactionState" id="TransactionState"><!-- --></a>
411 <div class="oddrow">
412
413 <div class="method-header">
414 <img src="../../media/images/Method.png" />
415 <span class="method-title">TransactionState</span> (line <span class="line-number">144</span>)
416 </div>
417
418 <!-- ========== Info from phpDoc block ========= -->
419 <p class="short-description">Returns the current state of a transaction, indicating if we have begun a transaction, whether the transaction has failed, or if we are not in a transaction.</p>
420
421 <div class="method-signature">
422 <span class="method-result">void</span>
423 <span class="method-name">
424 TransactionState
425 </span>
426 ()
427 </div>
428
429
430
431 </div>
432 <a name="methodTranslateAll" id="TranslateAll"><!-- --></a>
433 <div class="evenrow">
434
435 <div class="method-header">
436 <img src="../../media/images/Method.png" />
437 <span class="method-title">TranslateAll</span> (line <span class="line-number">163</span>)
438 </div>
439
440 <!-- ========== Info from phpDoc block ========= -->
441 <p class="short-description">Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.</p>
442
443 <div class="method-signature">
444 <span class="method-result">void</span>
445 <span class="method-name">
446 TranslateAll
447 </span>
448 (<span class="var-type"></span>&nbsp;<span class="var-name">$onoff_boolean</span>)
449 </div>
450
451 <ul class="parameters">
452 <li>
453 <span class="var-type"></span>
454 <span class="var-name">$onoff_boolean</span> </li>
455 </ul>
456
457
458 </div>
459 <h4>Inherited Methods</h4>
460 <a name='inherited_methods'><!-- --></a>
461 <!-- =========== Summary =========== -->
462 <p>Inherited From <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
463 <blockquote>
464 <img src="../../media/images/Constructor.png" alt=" "/>
465 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#method__construct">AwlDBDialect::__construct()</a></span><br />
466 <img src="../../media/images/Method.png" alt=" "/>
467 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetFields">AwlDBDialect::GetFields()</a></span><br />
468 <img src="../../media/images/Method.png" alt=" "/>
469 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetVersion">AwlDBDialect::GetVersion()</a></span><br />
470 <img src="../../media/images/Method.png" alt=" "/>
471 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodQuote">AwlDBDialect::Quote()</a></span><br />
472 <img src="../../media/images/Method.png" alt=" "/>
473 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceNamedParameters">AwlDBDialect::ReplaceNamedParameters()</a></span><br />
474 <img src="../../media/images/Method.png" alt=" "/>
475 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceParameters">AwlDBDialect::ReplaceParameters()</a></span><br />
476 <img src="../../media/images/Method.png" alt=" "/>
477 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodSetSearchPath">AwlDBDialect::SetSearchPath()</a></span><br />
478 <img src="../../media/images/Method.png" alt=" "/>
479 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodTranslateSQL">AwlDBDialect::TranslateSQL()</a></span><br />
480 </blockquote>
481
482 </div>
483 </div>
484
485
486 <p class="notes" id="credit">
487 Documentation generated on Sat, 17 Apr 2010 12:32:22 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
488 </p>
489 </div></body>
490 </html>
DAViCal CalDAV & CardDAV Server