mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-01-27 00:33:34 +00:00
805 lines
31 KiB
HTML
805 lines
31 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 AwlQuery</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"> AwlQuery</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">The AwlQuery Class.</p>
|
|
<p class="description"><p>This class builds and executes SQL Queries and traverses the set of results returned from the query.</p><p><strong>Example usage</strong> <div class="src-code"><ol><li><div class="src-line"> <span class="src-var">$sql </span>= <span class="src-str">"SELECT * FROM mytable WHERE mytype = ?"</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"> <span class="src-var">$qry </span>= <span class="src-key">new </span><span class="src-id"><a href="../../awl/AWLDB/AwlQuery.html">AwlQuery</a></span><span class="src-sym">( </span><span class="src-var">$sql</span><span class="src-sym">, </span><span class="src-var">$myunsanitisedtype </span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"> <span class="src-key">if </span><span class="src-sym">( </span><span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span><span class="src-str">"typeselect"</span><span class="src-sym">, </span>__line__<span class="src-sym">, </span>__file__ <span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"> && <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodrows">rows</a> > <span class="src-num">0 </span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"> <span class="src-key">while</span><span class="src-sym">( </span><span class="src-var">$row </span>= <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodFetch">Fetch</a><span class="src-sym">(</span><span class="src-sym">) ) </span><span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"> <span class="src-id">do_something_with</span><span class="src-sym">(</span><span class="src-var">$row</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"> <span class="src-sym">}</span></div></li>
|
|
</ol></div></p></p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_inc---AwlQuery.php.html">/inc/AwlQuery.php</a> (line <span class="field">138</span>)
|
|
</p>
|
|
|
|
|
|
<pre></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">array</span>
|
|
<a href="#$bound_parameters" title="details" class="var-name">$bound_parameters</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">resource</span>
|
|
<a href="#$connection" title="details" class="var-name">$connection</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">string</span>
|
|
<a href="#$error_info" title="details" class="var-name">$error_info</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">string</span>
|
|
<a href="#$execution_time" title="details" class="var-name">$execution_time</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">string</span>
|
|
<a href="#$location" title="details" class="var-name">$location</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">string</span>
|
|
<a href="#$querystring" title="details" class="var-name">$querystring</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">double</span>
|
|
<a href="#$query_time_warning" title="details" class="var-name">$query_time_warning</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">resource</span>
|
|
<a href="#$result" title="details" class="var-name">$result</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">int</span>
|
|
<a href="#$rownum" title="details" class="var-name">$rownum</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">int</span>
|
|
<a href="#$rows" title="details" class="var-name">$rows</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">string</span>
|
|
<a href="#$sth" title="details" class="var-name">$sth</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/Constructor.png" alt=" "/>
|
|
<span class="method-result">The</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
(<span class="var-type">string</span> <span class="var-name">0</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="#Bind" title="details" class="method-name">Bind</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">resource</span>
|
|
<a href="#Exec" title="details" class="method-name">Exec</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$location</span> = <span class="var-default">''</span>], [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">mixed</span>
|
|
<a href="#Fetch" title="details" class="method-name">Fetch</a>
|
|
([<span class="var-type">boolean</span> <span class="var-name">$as_array</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#Parameters" title="details" class="method-name">Parameters</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>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#QueryString" title="details" class="method-name">QueryString</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#quote" title="details" class="method-name">quote</a>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#rows" title="details" class="method-name">rows</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#SetConnection" title="details" class="method-name">SetConnection</a>
|
|
(<span class="var-type">resource</span> <span class="var-name">$new_connection</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#_log_query" title="details" class="method-name">_log_query</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$locn</span>, <span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$string</span>, [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">""</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$bound_parameters" id="$bound_parameters"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$bound_parameters</span>
|
|
(line <span class="line-number">159</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">The current array of bound parameters</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$connection" id="$connection"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">resource</span>
|
|
<span class="var-name">$connection</span>
|
|
(line <span class="line-number">147</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Our database connection, normally copied from a global one</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$error_info" id="$error_info"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$error_info</span>
|
|
(line <span class="line-number">189</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">The Database error information, if the query fails.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$execution_time" id="$execution_time"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$execution_time</span>
|
|
(line <span class="line-number">196</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Stores the query execution time - used to deal with long queries.</p>
|
|
<p class="description"><p>should be read-only</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$location" id="$location"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$location</span>
|
|
(line <span class="line-number">208</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Where we called this query from so we can find it in our code! Debugging may also be selectively enabled for a $location.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$querystring" id="$querystring"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$querystring</span>
|
|
(line <span class="line-number">153</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">The original query string</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$query_time_warning" id="$query_time_warning"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">double</span>
|
|
<span class="var-name">$query_time_warning</span>
|
|
= <span class="var-default"> 0.3</span> (line <span class="line-number">217</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">How long the query should take before a warning is issued.</p>
|
|
<p class="description"><p>This is writable, but a method to set it might be a better interface. The default is 0.3 seconds.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$result" id="$result"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">resource</span>
|
|
<span class="var-name">$result</span>
|
|
(line <span class="line-number">171</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Result of the last execution</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$rownum" id="$rownum"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$rownum</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">177</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">number of current row - use accessor to get/set</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$rows" id="$rows"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$rows</span>
|
|
(line <span class="line-number">183</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">number of rows from pg_numrows - use accessor to get value</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$sth" id="$sth"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$sth</span>
|
|
(line <span class="line-number">165</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">The PDO statement handle, or null if we don't have one yet.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</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="method__construct" id="__construct"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Constructor.png" />
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">227</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> AwlQuery object</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">The</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">0</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">0</span><span class="var-description">: The query string in PDO syntax with replacable '?' characters or bindable parameters.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodBind" id="Bind"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Bind</span> (line <span class="line-number">307</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Bind some parameters</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Bind
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodExec" id="Exec"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Exec</span> (line <span class="line-number">377</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Execute the query, logging any debugging.</p>
|
|
<p class="description"><p><strong>Example</strong> So that you can nicely enable/disable the queries for a particular class, you could use some of PHPs magic constants in your call. <div class="src-code"><ol><li><div class="src-line"> <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span>__CLASS__<span class="src-sym">, </span>__LINE__<span class="src-sym">, </span>__FILE__<span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
</ol></div></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The actual result of the query (FWIW)</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">resource</span>
|
|
<span class="method-name">
|
|
Exec
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$location</span> = <span class="var-default">''</span>], [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$location</span><span class="var-description">: The name of the location for enabling debugging or just to help our children find the source of a problem.</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$line</span><span class="var-description">: The line number where Exec was called</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$file</span><span class="var-description">: The file where Exec was called</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodFetch" id="Fetch"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Fetch</span> (line <span class="line-number">440</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Fetch the next row from the query results</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> query row</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">mixed</span>
|
|
<span class="method-name">
|
|
Fetch
|
|
</span>
|
|
([<span class="var-type">boolean</span> <span class="var-name">$as_array</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodParameters" id="Parameters"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Parameters</span> (line <span class="line-number">347</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Return the parameters we are planning to substitute into the query string</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Parameters
|
|
</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">323</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Tell the database to prepare the query that we will execute</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Prepare
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodQueryString" id="QueryString"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">QueryString</span> (line <span class="line-number">339</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Return the query string we are planning to execute</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
QueryString
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodquote" id="quote"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">quote</span> (line <span class="line-number">295</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Quote the given string so it can be safely used within string delimiters in a query. To be avoided, in general.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
quote
|
|
</span>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$str</span><span class="var-description">: Data to be converted to a string suitable for including as a value in SQL.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodrows" id="rows"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">rows</span> (line <span class="line-number">355</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Return the count of rows retrieved/affected</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
rows
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodSetConnection" id="SetConnection"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">SetConnection</span> (line <span class="line-number">255</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Use a different database connection for this query</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetConnection
|
|
</span>
|
|
(<span class="var-type">resource</span> <span class="var-name">$new_connection</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">resource</span>
|
|
<span class="var-name">$new_connection</span><span class="var-description">: The database connection to use.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method_log_query" id="_log_query"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">_log_query</span> (line <span class="line-number">273</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log query, optionally with file and line location of the caller.</p>
|
|
<p class="description"><p>This function should not really be used outside of AwlQuery. For a more useful generic logging interface consider calling dbg_error_log(...);</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_log_query
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$locn</span>, <span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$string</span>, [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$locn</span><span class="var-description">: A string identifying the calling location.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$tag</span><span class="var-description">: A tag string, e.g. identifying the type of event.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$string</span><span class="var-description">: The information to be logged.</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$line</span><span class="var-description">: The line number where the logged event occurred.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$file</span><span class="var-description">: The file name where the logged event occurred.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Thu, 24 Dec 2009 22:09:47 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|