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 <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"> AwlDatabase
</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-var-summary">Vars
</a> (
<a href=
"#sec-vars">details
</a>)
23 |
<a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
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>
30 Located in
<a class=
"field" href=
"_inc---AwlDatabase.php.html">/inc/AwlDatabase.php
</a> (line
<span class=
"field">58</span>)
34 <pre><a href=
"../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect
</a>
43 <a name=
"sec-var-summary"></a>
44 <div class=
"info-box">
45 <div class=
"info-box-title">Variable Summary
</span></div>
47 <a href=
"#sec-description">Description
</a> |
48 <span class=
"disabled">Vars
</span> (
<a href=
"#sec-vars">details
</a>)
50 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
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>
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>
69 <a name=
"sec-method-summary"></a>
70 <div class=
"info-box">
71 <div class=
"info-box-title">Method Summary
</span></div>
73 <a href=
"#sec-description">Description
</a> |
74 <a href=
"#sec-var-summary">Vars
</a> (
<a href=
"#sec-vars">details
</a>)
77 <span class=
"disabled">Methods
</span> (
<a href=
"#sec-methods">details
</a>)
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>
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>
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>
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> <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>)
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> <span class=
"var-name">$statement
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$driver_options
</span> =
<span class=
"var-default">array()
</span>])
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> <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>)
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>
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>
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> <span class=
"var-name">$onoff_boolean
</span>)
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>)
148 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
151 <div class=
"info-box-body">
153 <a name=
"var$translate_all" id=
"$translate_all"><!-- --></A>
154 <div class=
"evenrow">
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>)
165 <!-- ========== Info from phpDoc block ========= -->
166 <p class=
"short-description">Holds whether we are translating all statements.
</p>
168 <li><span class=
"field">access:
</span> protected
</li>
176 <a name=
"var$txnstate" id=
"$txnstate"><!-- --></A>
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>)
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>
191 <li><span class=
"field">access:
</span> protected
</li>
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>
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 />
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 />
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>)
225 <div class=
"info-box-body">
226 <A NAME='method_detail'
></A>
227 <a name=
"methodBegin" id=
"Begin"><!-- --></a>
228 <div class=
"evenrow">
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>)
235 <!-- ========== Info from phpDoc block ========= -->
236 <p class=
"short-description">Begin a transaction.
</p>
238 <div class=
"method-signature">
239 <span class=
"method-result">void
</span>
240 <span class=
"method-name">
249 <a name=
"methodCommit" id=
"Commit"><!-- --></a>
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>)
257 <!-- ========== Info from phpDoc block ========= -->
258 <p class=
"short-description">Complete a transaction.
</p>
260 <div class=
"method-signature">
261 <span class=
"method-result">void
</span>
262 <span class=
"method-name">
271 <a name=
"methodErrorInfo" id=
"ErrorInfo"><!-- --></a>
272 <div class=
"evenrow">
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>)
279 <!-- ========== Info from phpDoc block ========= -->
281 <div class=
"method-signature">
282 <span class=
"method-result">void
</span>
283 <span class=
"method-name">
292 <a name=
"methodprepare" id=
"prepare"><!-- --></a>
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>)
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>
303 <div class=
"method-signature">
304 <span class=
"method-result">void
</span>
305 <span class=
"method-name">
308 (
<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>)
311 <ul class=
"parameters">
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>
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>
319 <span class=
"var-type"></span>
320 <span class=
"var-name">$statement
</span> </li>
325 <a name=
"methodPrepareTranslated" id=
"PrepareTranslated"><!-- --></a>
326 <div class=
"evenrow">
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>)
333 <!-- ========== Info from phpDoc block ========= -->
334 <p class=
"short-description">Operates identically to AwlDatabase::Prepare, except that $this-
>Translate() will be called on the query before any processing.
</p>
336 <div class=
"method-signature">
337 <span class=
"method-result">void
</span>
338 <span class=
"method-name">
341 (
<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>])
344 <ul class=
"parameters">
346 <span class=
"var-type"></span>
347 <span class=
"var-name">$statement
</span> </li>
349 <span class=
"var-type"></span>
350 <span class=
"var-name">$driver_options
</span> </li>
355 <a name=
"methodquery" id=
"query"><!-- --></a>
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>)
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>
366 <div class=
"method-signature">
367 <span class=
"method-result">void
</span>
368 <span class=
"method-name">
371 (
<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>)
374 <ul class=
"parameters">
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>
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>
382 <span class=
"var-type"></span>
383 <span class=
"var-name">$statement
</span> </li>
388 <a name=
"methodRollback" id=
"Rollback"><!-- --></a>
389 <div class=
"evenrow">
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>)
396 <!-- ========== Info from phpDoc block ========= -->
397 <p class=
"short-description">Cancel a transaction in progress.
</p>
399 <div class=
"method-signature">
400 <span class=
"method-result">void
</span>
401 <span class=
"method-name">
410 <a name=
"methodTransactionState" id=
"TransactionState"><!-- --></a>
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>)
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>
421 <div class=
"method-signature">
422 <span class=
"method-result">void
</span>
423 <span class=
"method-name">
432 <a name=
"methodTranslateAll" id=
"TranslateAll"><!-- --></a>
433 <div class=
"evenrow">
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>)
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>
443 <div class=
"method-signature">
444 <span class=
"method-result">void
</span>
445 <span class=
"method-name">
448 (
<span class=
"var-type"></span> <span class=
"var-name">$onoff_boolean
</span>)
451 <ul class=
"parameters">
453 <span class=
"var-type"></span>
454 <span class=
"var-name">$onoff_boolean
</span> </li>
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>
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 />
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>