mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-01-27 00:33:34 +00:00
425 lines
16 KiB
HTML
425 lines
16 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class AwlDatabase</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
|
|
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
|
alt=" Class"
|
|
title=" Class"
|
|
style="vertical-align: middle"> AwlDatabase</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Typically there will only be a single instance of the database level class in an application.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_inc---AwlDatabase.php.html">/inc/AwlDatabase.php</a> (line <span class="field">55</span>)
|
|
</p>
|
|
|
|
|
|
<pre><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a>
|
|
|
|
|
--AwlDatabase</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variable Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="var-summary">
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">mixed</span>
|
|
<a href="#$txnstate" title="details" class="var-name">$txnstate</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#Begin" title="details" class="method-name">Begin</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#Commit" title="details" class="method-name">Commit</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#prepare" title="details" class="method-name">prepare</a>
|
|
(<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>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#PrepareTranslated" title="details" class="method-name">PrepareTranslated</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#query" title="details" class="method-name">query</a>
|
|
(<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>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#Rollback" title="details" class="method-name">Rollback</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#TransactionState" title="details" class="method-name">TransactionState</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#TranslateAll" title="details" class="method-name">TranslateAll</a>
|
|
(<span class="var-type"></span> <span class="var-name">$onoff_boolean</span>)
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
<a name="var$txnstate" id="$txnstate"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$txnstate</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">63</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<h4>Inherited Variables</h4>
|
|
<A NAME='inherited_vars'><!-- --></A>
|
|
<p>Inherited from <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
|
|
<blockquote>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$db">AwlDBDialect::$db</a></span><br />
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$dialect">AwlDBDialect::$dialect</a></span><br />
|
|
</span>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="methodBegin" id="Begin"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Begin</span> (line <span class="line-number">90</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Begin a transaction.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Begin
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodCommit" id="Commit"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Commit</span> (line <span class="line-number">104</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Complete a transaction.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Commit
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodprepare" id="prepare"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">prepare</span> (line <span class="line-number">72</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
prepare
|
|
</span>
|
|
(<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>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<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>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$statement</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodPrepareTranslated" id="PrepareTranslated"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">PrepareTranslated</span> (line <span class="line-number">139</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
PrepareTranslated
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodquery" id="query"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">query</span> (line <span class="line-number">82</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
query
|
|
</span>
|
|
(<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>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">1</span><span class="var-description">: ... Subsequent arguments are positionally replaced into the $sql_query_string</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$statement</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRollback" id="Rollback"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Rollback</span> (line <span class="line-number">115</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Cancel a transaction in progress.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Rollback
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodTransactionState" id="TransactionState"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">TransactionState</span> (line <span class="line-number">130</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<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>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
TransactionState
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodTranslateAll" id="TranslateAll"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">TranslateAll</span> (line <span class="line-number">147</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<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>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
TranslateAll
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$onoff_boolean</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$onoff_boolean</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
|
|
<blockquote>
|
|
<img src="../../media/images/Constructor.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#method__construct">AwlDBDialect::__construct()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetFields">AwlDBDialect::GetFields()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetVersion">AwlDBDialect::GetVersion()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodQuote">AwlDBDialect::Quote()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceParameters">AwlDBDialect::ReplaceParameters()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodSetSearchPath">AwlDBDialect::SetSearchPath()</a></span><br />
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodTranslateSQL">AwlDBDialect::TranslateSQL()</a></span><br />
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Thu, 24 Dec 2009 22:09:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|