docs/api/awl/AwlDatabase/AwlQuery.html

   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 AwlQuery</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"> AwlQuery</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">The AwlQuery Class.</p>
 105 <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">&nbsp;<span class="src-var">$sql&nbsp;</span>=&nbsp;<span class="src-str">&quot;SELECT&nbsp;*&nbsp;FROM&nbsp;mytable&nbsp;WHERE&nbsp;mytype&nbsp;=&nbsp;?&quot;</span><span class="src-sym">;</span></div></li>
 106 <li><div class="src-line">&nbsp;<span class="src-var">$qry&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../../awl/AwlDatabase/AwlQuery.html">AwlQuery</a></span><span class="src-sym">(&nbsp;</span><span class="src-var">$sql</span><span class="src-sym">,&nbsp;</span><span class="src-var">$myunsanitisedtype&nbsp;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 107 <li><div class="src-line">&nbsp;<span class="src-key">if&nbsp;</span><span class="src-sym">(&nbsp;</span><span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/AwlDatabase/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span><span class="src-str">&quot;typeselect&quot;</span><span class="src-sym">,&nbsp;</span>__line__<span class="src-sym">,&nbsp;</span>__file__&nbsp;<span class="src-sym">)</span></div></li>
 108 <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;&amp;&nbsp;<span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/AwlDatabase/AwlQuery.html#methodrows">rows</a>&nbsp;&gt;&nbsp;<span class="src-num">0&nbsp;</span><span class="src-sym">)</span></div></li>
 109 <li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
 110 <li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-key">while</span><span class="src-sym">(&nbsp;</span><span class="src-var">$row&nbsp;</span>=&nbsp;<span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/AwlDatabase/AwlQuery.html#methodFetch">Fetch</a><span class="src-sym">(</span><span class="src-sym">)&nbsp;)&nbsp;</span><span class="src-sym">{</span></div></li>
 111 <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>
 112 <li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-sym">}</span></div></li>
 113 <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
 114 </ol></div></p></p>
 115                 <p class="notes">
 116                         Located in <a class="field" href="_AwlQuery.php.html">/AwlQuery.php</a> (line <span class="field">117</span>)
 117                 </p>
 118
 119
 120                 <pre></pre>
 121
 122                         </div>
 123 </div>
 124
 125
 126
 127         <a name="sec-var-summary"></a>
 128         <div class="info-box">
 129                 <div class="info-box-title">Variable Summary</span></div>
 130                 <div class="nav-bar">
 131                         <a href="#sec-description">Description</a> |
 132                                                 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
 133                                                         |
 134                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 135
 136                                                                 </div>
 137                 <div class="info-box-body">
 138                         <div class="var-summary">
 139                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="var-title">
 140                                         <img src="../../media/images/Variable.png" alt=" " />
 141                                         <span class="var-type">array</span>
 142                                         <a href="#$bound_parameters" title="details" class="var-name">$bound_parameters</a>
 143                                 </div>
 144                                                                                                                                 <div class="var-title">
 145                                         <img src="../../media/images/Variable.png" alt=" " />
 146                                         <span class="var-type">string</span>
 147                                         <a href="#$bound_querystring" title="details" class="var-name">$bound_querystring</a>
 148                                 </div>
 149                                                                                                                                 <div class="var-title">
 150                                         <img src="../../media/images/Variable.png" alt=" " />
 151                                         <span class="var-type">resource</span>
 152                                         <a href="#$connection" title="details" class="var-name">$connection</a>
 153                                 </div>
 154                                                                                                                                 <div class="var-title">
 155                                         <img src="../../media/images/Variable.png" alt=" " />
 156                                         <span class="var-type">string</span>
 157                                         <a href="#$error_info" title="details" class="var-name">$error_info</a>
 158                                 </div>
 159                                                                                                                                 <div class="var-title">
 160                                         <img src="../../media/images/Variable.png" alt=" " />
 161                                         <span class="var-type">string</span>
 162                                         <a href="#$execution_time" title="details" class="var-name">$execution_time</a>
 163                                 </div>
 164                                                                                                                                 <div class="var-title">
 165                                         <img src="../../media/images/Variable.png" alt=" " />
 166                                         <span class="var-type">string</span>
 167                                         <a href="#$location" title="details" class="var-name">$location</a>
 168                                 </div>
 169                                                                                                                                 <div class="var-title">
 170                                         <img src="../../media/images/Variable.png" alt=" " />
 171                                         <span class="var-type">string</span>
 172                                         <a href="#$querystring" title="details" class="var-name">$querystring</a>
 173                                 </div>
 174                                                                                                                                 <div class="var-title">
 175                                         <img src="../../media/images/Variable.png" alt=" " />
 176                                         <span class="var-type">double</span>
 177                                         <a href="#$query_time_warning" title="details" class="var-name">$query_time_warning</a>
 178                                 </div>
 179                                                                                                                                 <div class="var-title">
 180                                         <img src="../../media/images/Variable.png" alt=" " />
 181                                         <span class="var-type">resource</span>
 182                                         <a href="#$result" title="details" class="var-name">$result</a>
 183                                 </div>
 184                                                                                                                                 <div class="var-title">
 185                                         <img src="../../media/images/Variable.png" alt=" " />
 186                                         <span class="var-type">int</span>
 187                                         <a href="#$rownum" title="details" class="var-name">$rownum</a>
 188                                 </div>
 189                                                                                                                                 <div class="var-title">
 190                                         <img src="../../media/images/Variable.png" alt=" " />
 191                                         <span class="var-type">int</span>
 192                                         <a href="#$rows" title="details" class="var-name">$rows</a>
 193                                 </div>
 194                                                                                                                                 <div class="var-title">
 195                                         <img src="../../media/images/Variable.png" alt=" " />
 196                                         <span class="var-type">string</span>
 197                                         <a href="#$sth" title="details" class="var-name">$sth</a>
 198                                 </div>
 199                                                                                         </div>
 200                 </div>
 201         </div>
 202
 203         <a name="sec-method-summary"></a>
 204         <div class="info-box">
 205                 <div class="info-box-title">Method Summary</span></div>
 206                 <div class="nav-bar">
 207                         <a href="#sec-description">Description</a> |
 208                                                                                                                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 209
 210                                 |
 211                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 212                 </div>
 213                 <div class="info-box-body">
 214                         <div class="method-summary">
 215
 216                                 <div class="method-definition">
 217                                         <img src="../../media/images/StaticMethod.png" alt=" "/>
 218                                         static                                          <span class="method-result">string</span>
 219                                                                                 <a href="#quote" title="details" class="method-name">quote</a>
 220                                                                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">null</span>])
 221                                                                         </div>
 222
 223                                 <div class="method-definition">
 224                                         <img src="../../media/images/Constructor.png" alt=" "/>
 225                                                                                         <span class="method-result">The</span>
 226                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
 227                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
 228                                                                         </div>
 229
 230                                 <div class="method-definition">
 231                                         <img src="../../media/images/Method.png" alt=" "/>
 232                                                                                         <span class="method-result">void</span>
 233                                                                                 <a href="#Begin" title="details" class="method-name">Begin</a>
 234                                                                                 ()
 235                                                                         </div>
 236
 237                                 <div class="method-definition">
 238                                         <img src="../../media/images/Method.png" alt=" "/>
 239                                                                                         <span class="method-result">void</span>
 240                                                                                 <a href="#Bind" title="details" class="method-name">Bind</a>
 241                                                                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$args</span>)
 242                                                                         </div>
 243
 244                                 <div class="method-definition">
 245                                         <img src="../../media/images/Method.png" alt=" "/>
 246                                                                                         <span class="method-result">void</span>
 247                                                                                 <a href="#Commit" title="details" class="method-name">Commit</a>
 248                                                                                 ()
 249                                                                         </div>
 250
 251                                 <div class="method-definition">
 252                                         <img src="../../media/images/Method.png" alt=" "/>
 253                                                                                         <span class="method-result">boolean</span>
 254                                                                                 <a href="#Exec" title="details" class="method-name">Exec</a>
 255                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$line</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">null</span>])
 256                                                                         </div>
 257
 258                                 <div class="method-definition">
 259                                         <img src="../../media/images/Method.png" alt=" "/>
 260                                                                                         <span class="method-result">void</span>
 261                                                                                 <a href="#Execute" title="details" class="method-name">Execute</a>
 262                                                                                 ()
 263                                                                         </div>
 264
 265                                 <div class="method-definition">
 266                                         <img src="../../media/images/Method.png" alt=" "/>
 267                                                                                         <span class="method-result">mixed</span>
 268                                                                                 <a href="#Fetch" title="details" class="method-name">Fetch</a>
 269                                                                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 270                                                                         </div>
 271
 272                                 <div class="method-definition">
 273                                         <img src="../../media/images/Method.png" alt=" "/>
 274                                                                                         <span class="method-result">void</span>
 275                                                                                 <a href="#GetConnection" title="details" class="method-name">GetConnection</a>
 276                                                                                 ()
 277                                                                         </div>
 278
 279                                 <div class="method-definition">
 280                                         <img src="../../media/images/Method.png" alt=" "/>
 281                                                                                         <span class="method-result">void</span>
 282                                                                                 <a href="#Parameters" title="details" class="method-name">Parameters</a>
 283                                                                                 ()
 284                                                                         </div>
 285
 286                                 <div class="method-definition">
 287                                         <img src="../../media/images/Method.png" alt=" "/>
 288                                                                                         <span class="method-result">void</span>
 289                                                                                 <a href="#Prepare" title="details" class="method-name">Prepare</a>
 290                                                                                 ()
 291                                                                         </div>
 292
 293                                 <div class="method-definition">
 294                                         <img src="../../media/images/Method.png" alt=" "/>
 295                                                                                         <span class="method-result">boolean</span>
 296                                                                                 <a href="#QDo" title="details" class="method-name">QDo</a>
 297                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
 298                                                                         </div>
 299
 300                                 <div class="method-definition">
 301                                         <img src="../../media/images/Method.png" alt=" "/>
 302                                                                                         <span class="method-result">void</span>
 303                                                                                 <a href="#QueryString" title="details" class="method-name">QueryString</a>
 304                                                                                 ()
 305                                                                         </div>
 306
 307                                 <div class="method-definition">
 308                                         <img src="../../media/images/Method.png" alt=" "/>
 309                                                                                         <span class="method-result">void</span>
 310                                                                                 <a href="#Rollback" title="details" class="method-name">Rollback</a>
 311                                                                                 ()
 312                                                                         </div>
 313
 314                                 <div class="method-definition">
 315                                         <img src="../../media/images/Method.png" alt=" "/>
 316                                                                                         <span class="method-result">void</span>
 317                                                                                 <a href="#rownum" title="details" class="method-name">rownum</a>
 318                                                                                 ()
 319                                                                         </div>
 320
 321                                 <div class="method-definition">
 322                                         <img src="../../media/images/Method.png" alt=" "/>
 323                                                                                         <span class="method-result">void</span>
 324                                                                                 <a href="#rows" title="details" class="method-name">rows</a>
 325                                                                                 ()
 326                                                                         </div>
 327
 328                                 <div class="method-definition">
 329                                         <img src="../../media/images/Method.png" alt=" "/>
 330                                                                                         <span class="method-result">void</span>
 331                                                                                 <a href="#SetConnection" title="details" class="method-name">SetConnection</a>
 332                                                                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
 333                                                                         </div>
 334
 335                                 <div class="method-definition">
 336                                         <img src="../../media/images/Method.png" alt=" "/>
 337                                                                                         <span class="method-result">void</span>
 338                                                                                 <a href="#SetSql" title="details" class="method-name">SetSql</a>
 339                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>)
 340                                                                         </div>
 341
 342                                 <div class="method-definition">
 343                                         <img src="../../media/images/Method.png" alt=" "/>
 344                                                                                         <span class="method-result">void</span>
 345                                                                                 <a href="#TransactionState" title="details" class="method-name">TransactionState</a>
 346                                                                                 ()
 347                                                                         </div>
 348
 349                                 <div class="method-definition">
 350                                         <img src="../../media/images/Method.png" alt=" "/>
 351                                                                                         <span class="method-result">void</span>
 352                                                                                 <a href="#_log_query" title="details" class="method-name">_log_query</a>
 353                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$locn</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">&quot;&quot;</span>])
 354                                                                         </div>
 355                                                                                         </div>
 356                 </div>
 357         </div>
 358
 359         <a name="sec-vars"></a>
 360         <div class="info-box">
 361                 <div class="info-box-title">Variables</div>
 362                 <div class="nav-bar">
 363                         <a href="#sec-description">Description</a> |
 364                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 365
 366
 367                                                                                 |
 368                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 369
 370                                         </div>
 371                 <div class="info-box-body">
 372
 373 <a name="var$bound_parameters" id="$bound_parameters"><!-- --></A>
 374 <div class="oddrow">
 375
 376         <div class="var-header">
 377                 <img src="../../media/images/Variable.png" />
 378                 <span class="var-title">
 379                         <span class="var-type">array</span>
 380                         <span class="var-name">$bound_parameters</span>
 381                                                 (line <span class="line-number">144</span>)
 382                 </span>
 383         </div>
 384
 385         <!-- ========== Info from phpDoc block ========= -->
 386 <p class="short-description">The current array of bound parameters</p>
 387         <ul class="tags">
 388                                 <li><span class="field">access:</span> protected</li>
 389                         </ul>
 390
 391
 392
 393
 394
 395 </div>
 396 <a name="var$bound_querystring" id="$bound_querystring"><!-- --></A>
 397 <div class="evenrow">
 398
 399         <div class="var-header">
 400                 <img src="../../media/images/Variable.png" />
 401                 <span class="var-title">
 402                         <span class="var-type">string</span>
 403                         <span class="var-name">$bound_querystring</span>
 404                                                 (line <span class="line-number">138</span>)
 405                 </span>
 406         </div>
 407
 408         <!-- ========== Info from phpDoc block ========= -->
 409 <p class="short-description">The actual query string, after we've replaced parameters in it</p>
 410         <ul class="tags">
 411                                 <li><span class="field">access:</span> protected</li>
 412                         </ul>
 413
 414
 415
 416
 417
 418 </div>
 419 <a name="var$connection" id="$connection"><!-- --></A>
 420 <div class="oddrow">
 421
 422         <div class="var-header">
 423                 <img src="../../media/images/Variable.png" />
 424                 <span class="var-title">
 425                         <span class="var-type">resource</span>
 426                         <span class="var-name">$connection</span>
 427                                                 (line <span class="line-number">126</span>)
 428                 </span>
 429         </div>
 430
 431         <!-- ========== Info from phpDoc block ========= -->
 432 <p class="short-description">Our database connection, normally copied from a global one</p>
 433         <ul class="tags">
 434                                 <li><span class="field">access:</span> protected</li>
 435                         </ul>
 436
 437
 438
 439
 440
 441 </div>
 442 <a name="var$error_info" id="$error_info"><!-- --></A>
 443 <div class="evenrow">
 444
 445         <div class="var-header">
 446                 <img src="../../media/images/Variable.png" />
 447                 <span class="var-title">
 448                         <span class="var-type">string</span>
 449                         <span class="var-name">$error_info</span>
 450                                                 (line <span class="line-number">174</span>)
 451                 </span>
 452         </div>
 453
 454         <!-- ========== Info from phpDoc block ========= -->
 455 <p class="short-description">The Database error information, if the query fails.</p>
 456         <ul class="tags">
 457                                 <li><span class="field">access:</span> protected</li>
 458                         </ul>
 459
 460
 461
 462
 463
 464 </div>
 465 <a name="var$execution_time" id="$execution_time"><!-- --></A>
 466 <div class="oddrow">
 467
 468         <div class="var-header">
 469                 <img src="../../media/images/Variable.png" />
 470                 <span class="var-title">
 471                         <span class="var-type">string</span>
 472                         <span class="var-name">$execution_time</span>
 473                                                 (line <span class="line-number">181</span>)
 474                 </span>
 475         </div>
 476
 477         <!-- ========== Info from phpDoc block ========= -->
 478 <p class="short-description">Stores the query execution time - used to deal with long queries.</p>
 479 <p class="description"><p>should be read-only</p></p>
 480         <ul class="tags">
 481                                 <li><span class="field">access:</span> protected</li>
 482                         </ul>
 483
 484
 485
 486
 487
 488 </div>
 489 <a name="var$location" id="$location"><!-- --></A>
 490 <div class="evenrow">
 491
 492         <div class="var-header">
 493                 <img src="../../media/images/Variable.png" />
 494                 <span class="var-title">
 495                         <span class="var-type">string</span>
 496                         <span class="var-name">$location</span>
 497                                                 (line <span class="line-number">193</span>)
 498                 </span>
 499         </div>
 500
 501         <!-- ========== Info from phpDoc block ========= -->
 502 <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>
 503         <ul class="tags">
 504                                 <li><span class="field">access:</span> public</li>
 505                         </ul>
 506
 507
 508
 509
 510
 511 </div>
 512 <a name="var$querystring" id="$querystring"><!-- --></A>
 513 <div class="oddrow">
 514
 515         <div class="var-header">
 516                 <img src="../../media/images/Variable.png" />
 517                 <span class="var-title">
 518                         <span class="var-type">string</span>
 519                         <span class="var-name">$querystring</span>
 520                                                 (line <span class="line-number">132</span>)
 521                 </span>
 522         </div>
 523
 524         <!-- ========== Info from phpDoc block ========= -->
 525 <p class="short-description">The original query string</p>
 526         <ul class="tags">
 527                                 <li><span class="field">access:</span> protected</li>
 528                         </ul>
 529
 530
 531
 532
 533
 534 </div>
 535 <a name="var$query_time_warning" id="$query_time_warning"><!-- --></A>
 536 <div class="evenrow">
 537
 538         <div class="var-header">
 539                 <img src="../../media/images/Variable.png" />
 540                 <span class="var-title">
 541                         <span class="var-type">double</span>
 542                         <span class="var-name">$query_time_warning</span>
 543                          = <span class="var-default"> 0.3</span>                        (line <span class="line-number">202</span>)
 544                 </span>
 545         </div>
 546
 547         <!-- ========== Info from phpDoc block ========= -->
 548 <p class="short-description">How long the query should take before a warning is issued.</p>
 549 <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>
 550         <ul class="tags">
 551                                 <li><span class="field">access:</span> public</li>
 552                         </ul>
 553
 554
 555
 556
 557
 558 </div>
 559 <a name="var$result" id="$result"><!-- --></A>
 560 <div class="oddrow">
 561
 562         <div class="var-header">
 563                 <img src="../../media/images/Variable.png" />
 564                 <span class="var-title">
 565                         <span class="var-type">resource</span>
 566                         <span class="var-name">$result</span>
 567                                                 (line <span class="line-number">156</span>)
 568                 </span>
 569         </div>
 570
 571         <!-- ========== Info from phpDoc block ========= -->
 572 <p class="short-description">Result of the last execution</p>
 573         <ul class="tags">
 574                                 <li><span class="field">access:</span> protected</li>
 575                         </ul>
 576
 577
 578
 579
 580
 581 </div>
 582 <a name="var$rownum" id="$rownum"><!-- --></A>
 583 <div class="evenrow">
 584
 585         <div class="var-header">
 586                 <img src="../../media/images/Variable.png" />
 587                 <span class="var-title">
 588                         <span class="var-type">int</span>
 589                         <span class="var-name">$rownum</span>
 590                          = <span class="var-default"> null</span>                       (line <span class="line-number">162</span>)
 591                 </span>
 592         </div>
 593
 594         <!-- ========== Info from phpDoc block ========= -->
 595 <p class="short-description">number of current row - use accessor to get/set</p>
 596         <ul class="tags">
 597                                 <li><span class="field">access:</span> protected</li>
 598                         </ul>
 599
 600
 601
 602
 603
 604 </div>
 605 <a name="var$rows" id="$rows"><!-- --></A>
 606 <div class="oddrow">
 607
 608         <div class="var-header">
 609                 <img src="../../media/images/Variable.png" />
 610                 <span class="var-title">
 611                         <span class="var-type">int</span>
 612                         <span class="var-name">$rows</span>
 613                                                 (line <span class="line-number">168</span>)
 614                 </span>
 615         </div>
 616
 617         <!-- ========== Info from phpDoc block ========= -->
 618 <p class="short-description">number of rows from pg_numrows - use accessor to get value</p>
 619         <ul class="tags">
 620                                 <li><span class="field">access:</span> protected</li>
 621                         </ul>
 622
 623
 624
 625
 626
 627 </div>
 628 <a name="var$sth" id="$sth"><!-- --></A>
 629 <div class="evenrow">
 630
 631         <div class="var-header">
 632                 <img src="../../media/images/Variable.png" />
 633                 <span class="var-title">
 634                         <span class="var-type">string</span>
 635                         <span class="var-name">$sth</span>
 636                                                 (line <span class="line-number">150</span>)
 637                 </span>
 638         </div>
 639
 640         <!-- ========== Info from phpDoc block ========= -->
 641 <p class="short-description">The PDO statement handle, or null if we don't have one yet.</p>
 642         <ul class="tags">
 643                                 <li><span class="field">access:</span> protected</li>
 644                         </ul>
 645
 646
 647
 648
 649
 650 </div>
 651
 652                 </div>
 653         </div>
 654
 655         <a name="sec-methods"></a>
 656         <div class="info-box">
 657                 <div class="info-box-title">Methods</div>
 658                 <div class="nav-bar">
 659                         <a href="#sec-description">Description</a> |
 660                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 661                                                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 662
 663                 </div>
 664                 <div class="info-box-body">
 665                         <A NAME='method_detail'></A>
 666 <a name="methodquote" id="quote"><!-- --></a>
 667 <div class="oddrow">
 668
 669         <div class="method-header">
 670                 <img src="../../media/images/StaticMethod.png" />
 671                 <span class="method-title">static quote</span> (line <span class="line-number">311</span>)
 672         </div>
 673
 674         <!-- ========== Info from phpDoc block ========= -->
 675 <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>
 676         <ul class="tags">
 677                                 <li><span class="field">return:</span> NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped</li>
 678                                 <li><span class="field">access:</span> public</li>
 679                         </ul>
 680
 681         <div class="method-signature">
 682                 static <span class="method-result">string</span>
 683                 <span class="method-name">
 684                         quote
 685                 </span>
 686                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">null</span>])
 687                         </div>
 688
 689                         <ul class="parameters">
 690                                         <li>
 691                                 <span class="var-type">mixed</span>
 692                                 <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>
 693                                 </ul>
 694
 695
 696         </div>
 697 <a name="method__construct" id="__construct"><!-- --></a>
 698 <div class="evenrow">
 699
 700         <div class="method-header">
 701                 <img src="../../media/images/Constructor.png" />
 702                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">212</span>)
 703         </div>
 704
 705         <!-- ========== Info from phpDoc block ========= -->
 706 <p class="short-description">Constructor</p>
 707         <ul class="tags">
 708                                 <li><span class="field">return:</span> AwlQuery object</li>
 709                         </ul>
 710
 711         <div class="method-signature">
 712                 <span class="method-result">The</span>
 713                 <span class="method-name">
 714                         __construct
 715                 </span>
 716                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
 717                         </div>
 718
 719                         <ul class="parameters">
 720                                         <li>
 721                                 <span class="var-type">string</span>
 722                                 <span class="var-name">0</span><span class="var-description">: The query string in PDO syntax with replacable '?' characters or bindable parameters.</span>                     </li>
 723                                         <li>
 724                                 <span class="var-type">mixed</span>
 725                                 <span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span>                        </li>
 726                                 </ul>
 727
 728
 729         </div>
 730 <a name="methodBegin" id="Begin"><!-- --></a>
 731 <div class="oddrow">
 732
 733         <div class="method-header">
 734                 <img src="../../media/images/Method.png" />
 735                 <span class="method-title">Begin</span> (line <span class="line-number">466</span>)
 736         </div>
 737
 738         <!-- ========== Info from phpDoc block ========= -->
 739 <p class="short-description">Wrap the parent DB class Begin() so we can $qry-&gt;Begin() sometime before we $qry-&gt;Exec()</p>
 740         <ul class="tags">
 741                                 <li><span class="field">access:</span> public</li>
 742                         </ul>
 743
 744         <div class="method-signature">
 745                 <span class="method-result">void</span>
 746                 <span class="method-name">
 747                         Begin
 748                 </span>
 749                                 ()
 750                         </div>
 751
 752
 753
 754         </div>
 755 <a name="methodBind" id="Bind"><!-- --></a>
 756 <div class="evenrow">
 757
 758         <div class="method-header">
 759                 <img src="../../media/images/Method.png" />
 760                 <span class="method-title">Bind</span> (line <span class="line-number">330</span>)
 761         </div>
 762
 763         <!-- ========== Info from phpDoc block ========= -->
 764 <p class="short-description">Bind some parameters.  This can be called in three ways:</p>
 765 <p class="description"><p>1) As Bind(':key','value), when using named parameters  2) As Bind('value'), when using ? placeholders  3) As Bind(array()), to overwrite the existing bound parameters.  The array may     be ':name' =&gt; 'value' pairs or ordinal values, depending on whether the SQL     is using ':name' or '?' style placeholders.</p></p>
 766
 767         <div class="method-signature">
 768                 <span class="method-result">void</span>
 769                 <span class="method-name">
 770                         Bind
 771                 </span>
 772                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$args</span>)
 773                         </div>
 774
 775                         <ul class="parameters">
 776                                         <li>
 777                                 <span class="var-type">mixed</span>
 778                                 <span class="var-name">$args</span><span class="var-description">: See details above.</span>                    </li>
 779                                 </ul>
 780
 781
 782         </div>
 783 <a name="methodCommit" id="Commit"><!-- --></a>
 784 <div class="oddrow">
 785
 786         <div class="method-header">
 787                 <img src="../../media/images/Method.png" />
 788                 <span class="method-title">Commit</span> (line <span class="line-number">479</span>)
 789         </div>
 790
 791         <!-- ========== Info from phpDoc block ========= -->
 792 <p class="short-description">Wrap the parent DB class Commit() so we can $qry-&gt;Commit() sometime after we $qry-&gt;Exec()</p>
 793         <ul class="tags">
 794                                 <li><span class="field">access:</span> public</li>
 795                         </ul>
 796
 797         <div class="method-signature">
 798                 <span class="method-result">void</span>
 799                 <span class="method-name">
 800                         Commit
 801                 </span>
 802                                 ()
 803                         </div>
 804
 805
 806
 807         </div>
 808 <a name="methodExec" id="Exec"><!-- --></a>
 809 <div class="evenrow">
 810
 811         <div class="method-header">
 812                 <img src="../../media/images/Method.png" />
 813                 <span class="method-title">Exec</span> (line <span class="line-number">555</span>)
 814         </div>
 815
 816         <!-- ========== Info from phpDoc block ========= -->
 817 <p class="short-description">Execute the query, logging any debugging.</p>
 818 <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">&nbsp;<span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/AwlDatabase/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span>__CLASS__<span class="src-sym">,&nbsp;</span>__LINE__<span class="src-sym">,&nbsp;</span>__FILE__<span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 819 </ol></div></p></p>
 820         <ul class="tags">
 821                                 <li><span class="field">return:</span> Success (true) or Failure (false)</li>
 822                         </ul>
 823
 824         <div class="method-signature">
 825                 <span class="method-result">boolean</span>
 826                 <span class="method-name">
 827                         Exec
 828                 </span>
 829                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$line</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">null</span>])
 830                         </div>
 831
 832                         <ul class="parameters">
 833                                         <li>
 834                                 <span class="var-type">string</span>
 835                                 <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>
 836                                         <li>
 837                                 <span class="var-type">int</span>
 838                                 <span class="var-name">$line</span><span class="var-description">: The line number where Exec was called</span>                 </li>
 839                                         <li>
 840                                 <span class="var-type">string</span>
 841                                 <span class="var-name">$file</span><span class="var-description">: The file where Exec was called</span>                        </li>
 842                                 </ul>
 843
 844
 845         </div>
 846 <a name="methodExecute" id="Execute"><!-- --></a>
 847 <div class="oddrow">
 848
 849         <div class="method-header">
 850                 <img src="../../media/images/Method.png" />
 851                 <span class="method-title">Execute</span> (line <span class="line-number">374</span>)
 852         </div>
 853
 854         <!-- ========== Info from phpDoc block ========= -->
 855 <p class="short-description">Tell the database to execute the query</p>
 856
 857         <div class="method-signature">
 858                 <span class="method-result">void</span>
 859                 <span class="method-name">
 860                         Execute
 861                 </span>
 862                                 ()
 863                         </div>
 864
 865
 866
 867         </div>
 868 <a name="methodFetch" id="Fetch"><!-- --></a>
 869 <div class="evenrow">
 870
 871         <div class="method-header">
 872                 <img src="../../media/images/Method.png" />
 873                 <span class="method-title">Fetch</span> (line <span class="line-number">621</span>)
 874         </div>
 875
 876         <!-- ========== Info from phpDoc block ========= -->
 877 <p class="short-description">Fetch the next row from the query results</p>
 878         <ul class="tags">
 879                                 <li><span class="field">return:</span> query row</li>
 880                         </ul>
 881
 882         <div class="method-signature">
 883                 <span class="method-result">mixed</span>
 884                 <span class="method-name">
 885                         Fetch
 886                 </span>
 887                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 888                         </div>
 889
 890                         <ul class="parameters">
 891                                         <li>
 892                                 <span class="var-type">boolean</span>
 893                                 <span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array</span>                     </li>
 894                                 </ul>
 895
 896
 897         </div>
 898 <a name="methodGetConnection" id="GetConnection"><!-- --></a>
 899 <div class="oddrow">
 900
 901         <div class="method-header">
 902                 <img src="../../media/images/Method.png" />
 903                 <span class="method-title">GetConnection</span> (line <span class="line-number">272</span>)
 904         </div>
 905
 906         <!-- ========== Info from phpDoc block ========= -->
 907 <p class="short-description">Get the current database connection for this query</p>
 908
 909         <div class="method-signature">
 910                 <span class="method-result">void</span>
 911                 <span class="method-name">
 912                         GetConnection
 913                 </span>
 914                                 ()
 915                         </div>
 916
 917
 918
 919         </div>
 920 <a name="methodParameters" id="Parameters"><!-- --></a>
 921 <div class="evenrow">
 922
 923         <div class="method-header">
 924                 <img src="../../media/images/Method.png" />
 925                 <span class="method-title">Parameters</span> (line <span class="line-number">428</span>)
 926         </div>
 927
 928         <!-- ========== Info from phpDoc block ========= -->
 929 <p class="short-description">Return the parameters we are planning to substitute into the query string</p>
 930
 931         <div class="method-signature">
 932                 <span class="method-result">void</span>
 933                 <span class="method-name">
 934                         Parameters
 935                 </span>
 936                                 ()
 937                         </div>
 938
 939
 940
 941         </div>
 942 <a name="methodPrepare" id="Prepare"><!-- --></a>
 943 <div class="oddrow">
 944
 945         <div class="method-header">
 946                 <img src="../../media/images/Method.png" />
 947                 <span class="method-title">Prepare</span> (line <span class="line-number">351</span>)
 948         </div>
 949
 950         <!-- ========== Info from phpDoc block ========= -->
 951 <p class="short-description">Tell the database to prepare the query that we will execute</p>
 952
 953         <div class="method-signature">
 954                 <span class="method-result">void</span>
 955                 <span class="method-name">
 956                         Prepare
 957                 </span>
 958                                 ()
 959                         </div>
 960
 961
 962
 963         </div>
 964 <a name="methodQDo" id="QDo"><!-- --></a>
 965 <div class="evenrow">
 966
 967         <div class="method-header">
 968                 <img src="../../media/images/Method.png" />
 969                 <span class="method-title">QDo</span> (line <span class="line-number">522</span>)
 970         </div>
 971
 972         <!-- ========== Info from phpDoc block ========= -->
 973 <p class="short-description">Simple QDo() class which will re-use this query for whatever was passed in, and execute it  returning the result of the Exec() call.  We can't call it Do() since that's a reserved word...</p>
 974         <ul class="tags">
 975                                 <li><span class="field">return:</span> Success (true) or Failure (false)</li>
 976                                 <li><span class="field">access:</span> public</li>
 977                         </ul>
 978
 979         <div class="method-signature">
 980                 <span class="method-result">boolean</span>
 981                 <span class="method-name">
 982                         QDo
 983                 </span>
 984                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">1</span>)
 985                         </div>
 986
 987                         <ul class="parameters">
 988                                         <li>
 989                                 <span class="var-type">string</span>
 990                                 <span class="var-name">0</span><span class="var-description">: The query string in PDO syntax with replacable '?' characters or bindable parameters.</span>                     </li>
 991                                         <li>
 992                                 <span class="var-type">mixed</span>
 993                                 <span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span>                        </li>
 994                                 </ul>
 995
 996
 997         </div>
 998 <a name="methodQueryString" id="QueryString"><!-- --></a>
 999 <div class="oddrow">
1000
1001         <div class="method-header">
1002                 <img src="../../media/images/Method.png" />
1003                 <span class="method-title">QueryString</span> (line <span class="line-number">420</span>)
1004         </div>
1005
1006         <!-- ========== Info from phpDoc block ========= -->
1007 <p class="short-description">Return the query string we are planning to execute</p>
1008
1009         <div class="method-signature">
1010                 <span class="method-result">void</span>
1011                 <span class="method-name">
1012                         QueryString
1013                 </span>
1014                                 ()
1015                         </div>
1016
1017
1018
1019         </div>
1020 <a name="methodRollback" id="Rollback"><!-- --></a>
1021 <div class="evenrow">
1022
1023         <div class="method-header">
1024                 <img src="../../media/images/Method.png" />
1025                 <span class="method-title">Rollback</span> (line <span class="line-number">490</span>)
1026         </div>
1027
1028         <!-- ========== Info from phpDoc block ========= -->
1029 <p class="short-description">Wrap the parent DB class Rollback() so we can $qry-&gt;Rollback() sometime after we $qry-&gt;Exec()</p>
1030         <ul class="tags">
1031                                 <li><span class="field">access:</span> public</li>
1032                         </ul>
1033
1034         <div class="method-signature">
1035                 <span class="method-result">void</span>
1036                 <span class="method-name">
1037                         Rollback
1038                 </span>
1039                                 ()
1040                         </div>
1041
1042
1043
1044         </div>
1045 <a name="methodrownum" id="rownum"><!-- --></a>
1046 <div class="oddrow">
1047
1048         <div class="method-header">
1049                 <img src="../../media/images/Method.png" />
1050                 <span class="method-title">rownum</span> (line <span class="line-number">444</span>)
1051         </div>
1052
1053         <!-- ========== Info from phpDoc block ========= -->
1054 <p class="short-description">Return the current rownum in the retrieved set</p>
1055
1056         <div class="method-signature">
1057                 <span class="method-result">void</span>
1058                 <span class="method-name">
1059                         rownum
1060                 </span>
1061                                 ()
1062                         </div>
1063
1064
1065
1066         </div>
1067 <a name="methodrows" id="rows"><!-- --></a>
1068 <div class="evenrow">
1069
1070         <div class="method-header">
1071                 <img src="../../media/images/Method.png" />
1072                 <span class="method-title">rows</span> (line <span class="line-number">436</span>)
1073         </div>
1074
1075         <!-- ========== Info from phpDoc block ========= -->
1076 <p class="short-description">Return the count of rows retrieved/affected</p>
1077
1078         <div class="method-signature">
1079                 <span class="method-result">void</span>
1080                 <span class="method-name">
1081                         rows
1082                 </span>
1083                                 ()
1084                         </div>
1085
1086
1087
1088         </div>
1089 <a name="methodSetConnection" id="SetConnection"><!-- --></a>
1090 <div class="oddrow">
1091
1092         <div class="method-header">
1093                 <img src="../../media/images/Method.png" />
1094                 <span class="method-title">SetConnection</span> (line <span class="line-number">241</span>)
1095         </div>
1096
1097         <!-- ========== Info from phpDoc block ========= -->
1098 <p class="short-description">Use a different database connection for this query</p>
1099
1100         <div class="method-signature">
1101                 <span class="method-result">void</span>
1102                 <span class="method-name">
1103                         SetConnection
1104                 </span>
1105                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
1106                         </div>
1107
1108                         <ul class="parameters">
1109                                         <li>
1110                                 <span class="var-type">resource</span>
1111                                 <span class="var-name">$new_connection</span><span class="var-description">: The database connection to use.</span>                     </li>
1112                                         <li>
1113                                 <span class="var-type"></span>
1114                                 <span class="var-name">$options</span>                  </li>
1115                                 </ul>
1116
1117
1118         </div>
1119 <a name="methodSetSql" id="SetSql"><!-- --></a>
1120 <div class="evenrow">
1121
1122         <div class="method-header">
1123                 <img src="../../media/images/Method.png" />
1124                 <span class="method-title">SetSql</span> (line <span class="line-number">502</span>)
1125         </div>
1126
1127         <!-- ========== Info from phpDoc block ========= -->
1128 <p class="short-description">Simple SetSql() class which will reset the object with the querystring from the first argument.</p>
1129         <ul class="tags">
1130                                 <li><span class="field">access:</span> public</li>
1131                         </ul>
1132
1133         <div class="method-signature">
1134                 <span class="method-result">void</span>
1135                 <span class="method-name">
1136                         SetSql
1137                 </span>
1138                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>)
1139                         </div>
1140
1141                         <ul class="parameters">
1142                                         <li>
1143                                 <span class="var-type">string</span>
1144                                 <span class="var-name">$sql</span><span class="var-description">: The query string in PDO syntax with replacable '?' characters or bindable parameters.</span>                  </li>
1145                                 </ul>
1146
1147
1148         </div>
1149 <a name="methodTransactionState" id="TransactionState"><!-- --></a>
1150 <div class="oddrow">
1151
1152         <div class="method-header">
1153                 <img src="../../media/images/Method.png" />
1154                 <span class="method-title">TransactionState</span> (line <span class="line-number">453</span>)
1155         </div>
1156
1157         <!-- ========== Info from phpDoc block ========= -->
1158 <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>
1159
1160         <div class="method-signature">
1161                 <span class="method-result">void</span>
1162                 <span class="method-name">
1163                         TransactionState
1164                 </span>
1165                                 ()
1166                         </div>
1167
1168
1169
1170         </div>
1171 <a name="method_log_query" id="_log_query"><!-- --></a>
1172 <div class="evenrow">
1173
1174         <div class="method-header">
1175                 <img src="../../media/images/Method.png" />
1176                 <span class="method-title">_log_query</span> (line <span class="line-number">289</span>)
1177         </div>
1178
1179         <!-- ========== Info from phpDoc block ========= -->
1180 <p class="short-description">Log query, optionally with file and line location of the caller.</p>
1181 <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>
1182
1183         <div class="method-signature">
1184                 <span class="method-result">void</span>
1185                 <span class="method-name">
1186                         _log_query
1187                 </span>
1188                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$locn</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">&quot;&quot;</span>])
1189                         </div>
1190
1191                         <ul class="parameters">
1192                                         <li>
1193                                 <span class="var-type">string</span>
1194                                 <span class="var-name">$locn</span><span class="var-description">: A string identifying the calling location.</span>                    </li>
1195                                         <li>
1196                                 <span class="var-type">string</span>
1197                                 <span class="var-name">$tag</span><span class="var-description">: A tag string, e.g. identifying the type of event.</span>                      </li>
1198                                         <li>
1199                                 <span class="var-type">string</span>
1200                                 <span class="var-name">$string</span><span class="var-description">: The information to be logged.</span>                       </li>
1201                                         <li>
1202                                 <span class="var-type">int</span>
1203                                 <span class="var-name">$line</span><span class="var-description">: The line number where the logged event occurred.</span>                      </li>
1204                                         <li>
1205                                 <span class="var-type">string</span>
1206                                 <span class="var-name">$file</span><span class="var-description">: The file name where the logged event occurred.</span>                        </li>
1207                                 </ul>
1208
1209
1210         </div>
1211
1212                 </div>
1213         </div>
1214
1215
1216         <p class="notes" id="credit">
1217                 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>
1218         </p>
1219         </div></body>
1220 </html>