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 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";
15 function showNode(Node){
16 switch(navigator.family){
18 // Nav
4.x code fork...
19 var oTable = document.layers[
"span" + Node];
20 var oImg = document.layers[
"img" + Node];
23 // IE
4/
5 code fork...
24 var oTable = document.all[
"span" + Node];
25 var oImg = document.all[
"img" + Node];
28 // Standards Compliant code fork...
29 var oTable = document.getElementById(
"span" + Node);
30 var oImg = document.getElementById(
"img" + Node);
33 oImg.src = imgMinus.src;
34 oTable.style.display =
"block";
37 function hideNode(Node){
38 switch(navigator.family){
40 // Nav
4.x code fork...
41 var oTable = document.layers[
"span" + Node];
42 var oImg = document.layers[
"img" + Node];
45 // IE
4/
5 code fork...
46 var oTable = document.all[
"span" + Node];
47 var oImg = document.all[
"img" + Node];
50 // Standards Compliant code fork...
51 var oTable = document.getElementById(
"span" + Node);
52 var oImg = document.getElementById(
"img" + Node);
55 oImg.src = imgPlus.src;
56 oTable.style.display =
"none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
62 // Nav
4.x code fork...
63 var oTable = document.layers[
"span" + Node];
66 // IE
4/
5 code fork...
67 var oTable = document.all[
"span" + Node];
70 // Standards Compliant code fork...
71 var oTable = document.getElementById(
"span" + Node);
74 return (oTable && oTable.style.display ==
"block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
87 <div class=
"page-body">
88 <h2 class=
"class-name"><img src=
"../../media/images/Class_logo.png"
91 style=
"vertical-align: middle"> AwlDatabase
</h2>
93 <a name=
"sec-description"></a>
94 <div class=
"info-box">
95 <div class=
"info-box-title">Description
</div>
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>)
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>
106 Located in
<a class=
"field" href=
"_AwlDatabase.php.html">/AwlDatabase.php
</a> (line
<span class=
"field">58</span>)
110 <pre><a href=
"../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect
</a>
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>)
126 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
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>
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>
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>)
153 <span class=
"disabled">Methods
</span> (
<a href=
"#sec-methods">details
</a>)
155 <div class=
"info-box-body">
156 <div class=
"method-summary">
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>
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>
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>
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> <span class=
"var-name">$statement
</span>, [
<span class=
"var-type">array
</span> <span class=
"var-name">$driver_options
</span> =
<span class=
"var-default">array()
</span>],
<span class=
"var-type">string
</span> <span class=
"var-name">$sql_query_string
</span>)
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> <span class=
"var-name">$statement
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$driver_options
</span> =
<span class=
"var-default">array()
</span>])
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> <span class=
"var-name">$statement
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$sql_query_string
</span>,
<span class=
"var-type">mixed
</span> <span class=
"var-name">1</span>)
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>
207 <div class=
"method-definition">
208 <img src=
"../../media/images/Method.png" alt=
" "/>
209 <span class=
"method-result">int
</span>
210 <a href=
"#TransactionState" title=
"details" class=
"method-name">TransactionState
</a>
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> <span class=
"var-name">$onoff_boolean
</span>)
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>)
233 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
236 <div class=
"info-box-body">
238 <a name=
"var$translate_all" id=
"$translate_all"><!-- --></A>
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>)
250 <!-- ========== Info from phpDoc block ========= -->
251 <p class=
"short-description">Holds whether we are translating all statements.
</p>
253 <li><span class=
"field">access:
</span> protected
</li>
261 <a name=
"var$txnstate" id=
"$txnstate"><!-- --></A>
262 <div class=
"evenrow">
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>)
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>
276 <li><span class=
"field">access:
</span> protected
</li>
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>
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>
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>
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>)
310 <div class=
"info-box-body">
311 <A NAME='method_detail'
></A>
312 <a name=
"methodBegin" id=
"Begin"><!-- --></a>
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>)
320 <!-- ========== Info from phpDoc block ========= -->
321 <p class=
"short-description">Begin a transaction.
</p>
323 <div class=
"method-signature">
324 <span class=
"method-result">void
</span>
325 <span class=
"method-name">
334 <a name=
"methodCommit" id=
"Commit"><!-- --></a>
335 <div class=
"evenrow">
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>)
342 <!-- ========== Info from phpDoc block ========= -->
343 <p class=
"short-description">Complete a transaction.
</p>
345 <div class=
"method-signature">
346 <span class=
"method-result">void
</span>
347 <span class=
"method-name">
356 <a name=
"methodErrorInfo" id=
"ErrorInfo"><!-- --></a>
359 <div class=
"method-header">
360 <img src=
"../../media/images/Method.png" />
361 <span class=
"method-title">ErrorInfo
</span> (line
<span class=
"line-number">173</span>)
364 <!-- ========== Info from phpDoc block ========= -->
366 <div class=
"method-signature">
367 <span class=
"method-result">void
</span>
368 <span class=
"method-name">
377 <a name=
"methodprepare" id=
"prepare"><!-- --></a>
378 <div class=
"evenrow">
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>)
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>
388 <div class=
"method-signature">
389 <span class=
"method-result">void
</span>
390 <span class=
"method-name">
393 (
<span class=
"var-type"></span> <span class=
"var-name">$statement
</span>, [
<span class=
"var-type">array
</span> <span class=
"var-name">$driver_options
</span> =
<span class=
"var-default">array()
</span>],
<span class=
"var-type">string
</span> <span class=
"var-name">$sql_query_string
</span>)
396 <ul class=
"parameters">
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>
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>
404 <span class=
"var-type"></span>
405 <span class=
"var-name">$statement
</span> </li>
410 <a name=
"methodPrepareTranslated" id=
"PrepareTranslated"><!-- --></a>
413 <div class=
"method-header">
414 <img src=
"../../media/images/Method.png" />
415 <span class=
"method-title">PrepareTranslated
</span> (line
<span class=
"line-number">154</span>)
418 <!-- ========== Info from phpDoc block ========= -->
419 <p class=
"short-description">Operates identically to AwlDatabase::Prepare, except that $this-
>Translate() will be called on the query before any processing.
</p>
421 <div class=
"method-signature">
422 <span class=
"method-result">void
</span>
423 <span class=
"method-name">
426 (
<span class=
"var-type"></span> <span class=
"var-name">$statement
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$driver_options
</span> =
<span class=
"var-default">array()
</span>])
429 <ul class=
"parameters">
431 <span class=
"var-type"></span>
432 <span class=
"var-name">$statement
</span> </li>
434 <span class=
"var-type"></span>
435 <span class=
"var-name">$driver_options
</span> </li>
440 <a name=
"methodquery" id=
"query"><!-- --></a>
441 <div class=
"evenrow">
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>)
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>
451 <div class=
"method-signature">
452 <span class=
"method-result">void
</span>
453 <span class=
"method-name">
456 (
<span class=
"var-type"></span> <span class=
"var-name">$statement
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$sql_query_string
</span>,
<span class=
"var-type">mixed
</span> <span class=
"var-name">1</span>)
459 <ul class=
"parameters">
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>
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>
467 <span class=
"var-type"></span>
468 <span class=
"var-name">$statement
</span> </li>
473 <a name=
"methodRollback" id=
"Rollback"><!-- --></a>
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>)
481 <!-- ========== Info from phpDoc block ========= -->
482 <p class=
"short-description">Cancel a transaction in progress.
</p>
484 <div class=
"method-signature">
485 <span class=
"method-result">void
</span>
486 <span class=
"method-name">
495 <a name=
"methodTransactionState" id=
"TransactionState"><!-- --></a>
496 <div class=
"evenrow">
498 <div class=
"method-header">
499 <img src=
"../../media/images/Method.png" />
500 <span class=
"method-title">TransactionState
</span> (line
<span class=
"line-number">145</span>)
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>
506 <li><span class=
"field">return:
</span> 0 = not started,
1 = in progress, -
1 = error pending rollback/commit
</li>
509 <div class=
"method-signature">
510 <span class=
"method-result">int
</span>
511 <span class=
"method-name">
520 <a name=
"methodTranslateAll" id=
"TranslateAll"><!-- --></a>
523 <div class=
"method-header">
524 <img src=
"../../media/images/Method.png" />
525 <span class=
"method-title">TranslateAll
</span> (line
<span class=
"line-number">164</span>)
528 <!-- ========== Info from phpDoc block ========= -->
529 <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>
531 <div class=
"method-signature">
532 <span class=
"method-result">void
</span>
533 <span class=
"method-name">
536 (
<span class=
"var-type"></span> <span class=
"var-name">$onoff_boolean
</span>)
539 <ul class=
"parameters">
541 <span class=
"var-type"></span>
542 <span class=
"var-name">$onoff_boolean
</span> </li>
547 <h4>Inherited Methods
</h4>
548 <a name='inherited_methods'
><!-- --></a>
549 <!-- =========== Summary =========== -->
550 <p>Inherited From
<span class=
"classname"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect
</a></span></p>
552 <img src=
"../../media/images/Constructor.png" alt=
" "/>
553 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#method__construct">AwlDBDialect::__construct()
</a></span><br>
554 <img src=
"../../media/images/Method.png" alt=
" "/>
555 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodGetFields">AwlDBDialect::GetFields()
</a></span><br>
556 <img src=
"../../media/images/Method.png" alt=
" "/>
557 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodGetVersion">AwlDBDialect::GetVersion()
</a></span><br>
558 <img src=
"../../media/images/Method.png" alt=
" "/>
559 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodQuote">AwlDBDialect::Quote()
</a></span><br>
560 <img src=
"../../media/images/Method.png" alt=
" "/>
561 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceNamedParameters">AwlDBDialect::ReplaceNamedParameters()
</a></span><br>
562 <img src=
"../../media/images/Method.png" alt=
" "/>
563 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceParameters">AwlDBDialect::ReplaceParameters()
</a></span><br>
564 <img src=
"../../media/images/Method.png" alt=
" "/>
565 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodSetSearchPath">AwlDBDialect::SetSearchPath()
</a></span><br>
566 <img src=
"../../media/images/Method.png" alt=
" "/>
567 <span class=
"method-name"><a href=
"../../awl/AwlDatabase/AwlDBDialect.html#methodTranslateSQL">AwlDBDialect::TranslateSQL()
</a></span><br>
574 <p class=
"notes" id=
"credit">
575 Documentation generated on Mon,
24 Oct
2011 20:
10:
10 +
1300 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.4.3</a>