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