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