?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / AwlDatabase / AwlDatabase.html
blobf7bbc16b7f658376f04ce485402f445654a24d3b
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 <script src="../../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../../media/images/plus.png";
13 imgMinus.src = "../../media/images/minus.png";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> AwlDatabase</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
99 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
100
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">Typically there will only be a single instance of the database level class in an application.</p>
105 <p class="notes">
106 Located in <a class="field" href="_AwlDatabase.php.html">/AwlDatabase.php</a> (line <span class="field">58</span>)
107 </p>
108
109
110 <pre><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a>
111 |
112 --AwlDatabase</pre>
113
114 </div>
115 </div>
116
117
118
119 <a name="sec-var-summary"></a>
120 <div class="info-box">
121 <div class="info-box-title">Variable Summary</span></div>
122 <div class="nav-bar">
123 <a href="#sec-description">Description</a> |
124 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
125 |
126 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
127
128 </div>
129 <div class="info-box-body">
130 <div class="var-summary">
131 <div class="var-title">
132 <img src="../../media/images/Variable.png" alt=" " />
133 <span class="var-type">mixed</span>
134 <a href="#$translate_all" title="details" class="var-name">$translate_all</a>
135 </div>
136 <div class="var-title">
137 <img src="../../media/images/Variable.png" alt=" " />
138 <span class="var-type">mixed</span>
139 <a href="#$txnstate" title="details" class="var-name">$txnstate</a>
140 </div>
141 </div>
142 </div>
143 </div>
144
145 <a name="sec-method-summary"></a>
146 <div class="info-box">
147 <div class="info-box-title">Method Summary</span></div>
148 <div class="nav-bar">
149 <a href="#sec-description">Description</a> |
150 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
151
152 |
153 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
154 </div>
155 <div class="info-box-body">
156 <div class="method-summary">
157
158 <div class="method-definition">
159 <img src="../../media/images/Method.png" alt=" "/>
160 <span class="method-result">void</span>
161 <a href="#Begin" title="details" class="method-name">Begin</a>
162 ()
163 </div>
164
165 <div class="method-definition">
166 <img src="../../media/images/Method.png" alt=" "/>
167 <span class="method-result">void</span>
168 <a href="#Commit" title="details" class="method-name">Commit</a>
169 ()
170 </div>
171
172 <div class="method-definition">
173 <img src="../../media/images/Method.png" alt=" "/>
174 <span class="method-result">void</span>
175 <a href="#ErrorInfo" title="details" class="method-name">ErrorInfo</a>
176 ()
177 </div>
178
179 <div class="method-definition">
180 <img src="../../media/images/Method.png" alt=" "/>
181 <span class="method-result">void</span>
182 <a href="#prepare" title="details" class="method-name">prepare</a>
183 (<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>)
184 </div>
185
186 <div class="method-definition">
187 <img src="../../media/images/Method.png" alt=" "/>
188 <span class="method-result">void</span>
189 <a href="#PrepareTranslated" title="details" class="method-name">PrepareTranslated</a>
190 (<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>])
191 </div>
192
193 <div class="method-definition">
194 <img src="../../media/images/Method.png" alt=" "/>
195 <span class="method-result">void</span>
196 <a href="#query" title="details" class="method-name">query</a>
197 (<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>)
198 </div>
199
200 <div class="method-definition">
201 <img src="../../media/images/Method.png" alt=" "/>
202 <span class="method-result">void</span>
203 <a href="#Rollback" title="details" class="method-name">Rollback</a>
204 ()
205 </div>
206
207 <div class="method-definition">
208 <img src="../../media/images/Method.png" alt=" "/>
209 <span class="method-result">void</span>
210 <a href="#TransactionState" title="details" class="method-name">TransactionState</a>
211 ()
212 </div>
213
214 <div class="method-definition">
215 <img src="../../media/images/Method.png" alt=" "/>
216 <span class="method-result">void</span>
217 <a href="#TranslateAll" title="details" class="method-name">TranslateAll</a>
218 (<span class="var-type"></span>&nbsp;<span class="var-name">$onoff_boolean</span>)
219 </div>
220 </div>
221 </div>
222 </div>
223
224 <a name="sec-vars"></a>
225 <div class="info-box">
226 <div class="info-box-title">Variables</div>
227 <div class="nav-bar">
228 <a href="#sec-description">Description</a> |
229 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
230
231
232 |
233 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
234
235 </div>
236 <div class="info-box-body">
237
238 <a name="var$translate_all" id="$translate_all"><!-- --></A>
239 <div class="evenrow">
240
241 <div class="var-header">
242 <img src="../../media/images/Variable.png" />
243 <span class="var-title">
244 <span class="var-type">mixed</span>
245 <span class="var-name">$translate_all</span>
246 = <span class="var-default"> false</span> (line <span class="line-number">71</span>)
247 </span>
248 </div>
249
250 <!-- ========== Info from phpDoc block ========= -->
251 <p class="short-description">Holds whether we are translating all statements.</p>
252 <ul class="tags">
253 <li><span class="field">access:</span> protected</li>
254 </ul>
255
256
257
258
259
260 </div>
261 <a name="var$txnstate" id="$txnstate"><!-- --></A>
262 <div class="oddrow">
263
264 <div class="var-header">
265 <img src="../../media/images/Variable.png" />
266 <span class="var-title">
267 <span class="var-type">mixed</span>
268 <span class="var-name">$txnstate</span>
269 = <span class="var-default"> 0</span> (line <span class="line-number">66</span>)
270 </span>
271 </div>
272
273 <!-- ========== Info from phpDoc block ========= -->
274 <p class="short-description">Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit</p>
275 <ul class="tags">
276 <li><span class="field">access:</span> protected</li>
277 </ul>
278
279
280
281
282
283 </div>
284 <h4>Inherited Variables</h4>
285 <A NAME='inherited_vars'><!-- --></A>
286 <p>Inherited from <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
287 <blockquote>
288 <img src="../../media/images/Variable.png" />
289 <span class="var-title">
290 <span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$db">AwlDBDialect::$db</a></span><br>
291 </span>
292 <img src="../../media/images/Variable.png" />
293 <span class="var-title">
294 <span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$dialect">AwlDBDialect::$dialect</a></span><br>
295 </span>
296 </blockquote>
297
298 </div>
299 </div>
300
301 <a name="sec-methods"></a>
302 <div class="info-box">
303 <div class="info-box-title">Methods</div>
304 <div class="nav-bar">
305 <a href="#sec-description">Description</a> |
306 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
307 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
308
309 </div>
310 <div class="info-box-body">
311 <A NAME='method_detail'></A>
312 <a name="methodBegin" id="Begin"><!-- --></a>
313 <div class="evenrow">
314
315 <div class="method-header">
316 <img src="../../media/images/Method.png" />
317 <span class="method-title">Begin</span> (line <span class="line-number">101</span>)
318 </div>
319
320 <!-- ========== Info from phpDoc block ========= -->
321 <p class="short-description">Begin a transaction.</p>
322
323 <div class="method-signature">
324 <span class="method-result">void</span>
325 <span class="method-name">
326 Begin
327 </span>
328 ()
329 </div>
330
331
332
333 </div>
334 <a name="methodCommit" id="Commit"><!-- --></a>
335 <div class="oddrow">
336
337 <div class="method-header">
338 <img src="../../media/images/Method.png" />
339 <span class="method-title">Commit</span> (line <span class="line-number">116</span>)
340 </div>
341
342 <!-- ========== Info from phpDoc block ========= -->
343 <p class="short-description">Complete a transaction.</p>
344
345 <div class="method-signature">
346 <span class="method-result">void</span>
347 <span class="method-name">
348 Commit
349 </span>
350 ()
351 </div>
352
353
354
355 </div>
356 <a name="methodErrorInfo" id="ErrorInfo"><!-- --></a>
357 <div class="evenrow">
358
359 <div class="method-header">
360 <img src="../../media/images/Method.png" />
361 <span class="method-title">ErrorInfo</span> (line <span class="line-number">172</span>)
362 </div>
363
364 <!-- ========== Info from phpDoc block ========= -->
365
366 <div class="method-signature">
367 <span class="method-result">void</span>
368 <span class="method-name">
369 ErrorInfo
370 </span>
371 ()
372 </div>
373
374
375
376 </div>
377 <a name="methodprepare" id="prepare"><!-- --></a>
378 <div class="oddrow">
379
380 <div class="method-header">
381 <img src="../../media/images/Method.png" />
382 <span class="method-title">prepare</span> (line <span class="line-number">80</span>)
383 </div>
384
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
387
388 <div class="method-signature">
389 <span class="method-result">void</span>
390 <span class="method-name">
391 prepare
392 </span>
393 (<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>)
394 </div>
395
396 <ul class="parameters">
397 <li>
398 <span class="var-type">string</span>
399 <span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
400 <li>
401 <span class="var-type">array</span>
402 <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>
403 <li>
404 <span class="var-type"></span>
405 <span class="var-name">$statement</span> </li>
406 </ul>
407
408
409 </div>
410 <a name="methodPrepareTranslated" id="PrepareTranslated"><!-- --></a>
411 <div class="evenrow">
412
413 <div class="method-header">
414 <img src="../../media/images/Method.png" />
415 <span class="method-title">PrepareTranslated</span> (line <span class="line-number">153</span>)
416 </div>
417
418 <!-- ========== Info from phpDoc block ========= -->
419 <p class="short-description">Operates identically to AwlDatabase::Prepare, except that $this-&gt;Translate() will be called on the query before any processing.</p>
420
421 <div class="method-signature">
422 <span class="method-result">void</span>
423 <span class="method-name">
424 PrepareTranslated
425 </span>
426 (<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>])
427 </div>
428
429 <ul class="parameters">
430 <li>
431 <span class="var-type"></span>
432 <span class="var-name">$statement</span> </li>
433 <li>
434 <span class="var-type"></span>
435 <span class="var-name">$driver_options</span> </li>
436 </ul>
437
438
439 </div>
440 <a name="methodquery" id="query"><!-- --></a>
441 <div class="oddrow">
442
443 <div class="method-header">
444 <img src="../../media/images/Method.png" />
445 <span class="method-title">query</span> (line <span class="line-number">93</span>)
446 </div>
447
448 <!-- ========== Info from phpDoc block ========= -->
449 <p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
450
451 <div class="method-signature">
452 <span class="method-result">void</span>
453 <span class="method-name">
454 query
455 </span>
456 (<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>)
457 </div>
458
459 <ul class="parameters">
460 <li>
461 <span class="var-type">string</span>
462 <span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
463 <li>
464 <span class="var-type">mixed</span>
465 <span class="var-name">1</span><span class="var-description">: ... Subsequent arguments are positionally replaced into the $sql_query_string</span> </li>
466 <li>
467 <span class="var-type"></span>
468 <span class="var-name">$statement</span> </li>
469 </ul>
470
471
472 </div>
473 <a name="methodRollback" id="Rollback"><!-- --></a>
474 <div class="evenrow">
475
476 <div class="method-header">
477 <img src="../../media/images/Method.png" />
478 <span class="method-title">Rollback</span> (line <span class="line-number">128</span>)
479 </div>
480
481 <!-- ========== Info from phpDoc block ========= -->
482 <p class="short-description">Cancel a transaction in progress.</p>
483
484 <div class="method-signature">
485 <span class="method-result">void</span>
486 <span class="method-name">
487 Rollback
488 </span>
489 ()
490 </div>
491
492
493
494 </div>
495 <a name="methodTransactionState" id="TransactionState"><!-- --></a>
496 <div class="oddrow">
497
498 <div class="method-header">
499 <img src="../../media/images/Method.png" />
500 <span class="method-title">TransactionState</span> (line <span class="line-number">144</span>)
501 </div>
502
503 <!-- ========== Info from phpDoc block ========= -->
504 <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>
505
506 <div class="method-signature">
507 <span class="method-result">void</span>
508 <span class="method-name">
509 TransactionState
510 </span>
511 ()
512 </div>
513
514
515
516 </div>
517 <a name="methodTranslateAll" id="TranslateAll"><!-- --></a>
518 <div class="evenrow">
519
520 <div class="method-header">
521 <img src="../../media/images/Method.png" />
522 <span class="method-title">TranslateAll</span> (line <span class="line-number">163</span>)
523 </div>
524
525 <!-- ========== Info from phpDoc block ========= -->
526 <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>
527
528 <div class="method-signature">
529 <span class="method-result">void</span>
530 <span class="method-name">
531 TranslateAll
532 </span>
533 (<span class="var-type"></span>&nbsp;<span class="var-name">$onoff_boolean</span>)
534 </div>
535
536 <ul class="parameters">
537 <li>
538 <span class="var-type"></span>
539 <span class="var-name">$onoff_boolean</span> </li>
540 </ul>
541
542
543 </div>
544 <h4>Inherited Methods</h4>
545 <a name='inherited_methods'><!-- --></a>
546 <!-- =========== Summary =========== -->
547 <p>Inherited From <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
548 <blockquote>
549 <img src="../../media/images/Constructor.png" alt=" "/>
550 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#method__construct">AwlDBDialect::__construct()</a></span><br>
551 <img src="../../media/images/Method.png" alt=" "/>
552 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetFields">AwlDBDialect::GetFields()</a></span><br>
553 <img src="../../media/images/Method.png" alt=" "/>
554 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetVersion">AwlDBDialect::GetVersion()</a></span><br>
555 <img src="../../media/images/Method.png" alt=" "/>
556 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodQuote">AwlDBDialect::Quote()</a></span><br>
557 <img src="../../media/images/Method.png" alt=" "/>
558 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceNamedParameters">AwlDBDialect::ReplaceNamedParameters()</a></span><br>
559 <img src="../../media/images/Method.png" alt=" "/>
560 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceParameters">AwlDBDialect::ReplaceParameters()</a></span><br>
561 <img src="../../media/images/Method.png" alt=" "/>
562 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodSetSearchPath">AwlDBDialect::SetSearchPath()</a></span><br>
563 <img src="../../media/images/Method.png" alt=" "/>
564 <span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodTranslateSQL">AwlDBDialect::TranslateSQL()</a></span><br>
565 </blockquote>
566
567 </div>
568 </div>
569
570
571 <p class="notes" id="credit">
572 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
573 </p>
574 </div></body>
575 </html>
Andrew's Web Libraries