docs/api/awl/PgQuery/PgQuery.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 PgQuery</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"> PgQuery</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 PgQuery Class.</p>
 105 <p class="description"><p>This class builds and executes PostgreSQL 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/PgQuery/PgQuery.html">PgQuery</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/PgQuery/PgQuery.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/PgQuery/PgQuery.html#methodrows">rows</a><span class="src-sym">(</span><span class="src-sym">)&nbsp;</span>&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/PgQuery/PgQuery.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="_PgQuery.php.html">/PgQuery.php</a> (line <span class="field">277</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">string</span>
 142                                         <a href="#$errorstring" title="details" class="var-name">$errorstring</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="#$execution_time" title="details" class="var-name">$execution_time</a>
 148                                 </div>
 149                                                                                                                                 <div class="var-title">
 150                                         <img src="../../media/images/Variable.png" alt=" " />
 151                                         <span class="var-type">double</span>
 152                                         <a href="#$query_time_warning" title="details" class="var-name">$query_time_warning</a>
 153                                 </div>
 154                                                                                                                                 <div class="var-title">
 155                                         <img src="../../media/images/Variable.png" alt=" " />
 156                                         <span class="var-type">int</span>
 157                                         <a href="#$rows" title="details" class="var-name">$rows</a>
 158                                 </div>
 159                                                                                         </div>
 160                 </div>
 161         </div>
 162
 163         <a name="sec-method-summary"></a>
 164         <div class="info-box">
 165                 <div class="info-box-title">Method Summary</span></div>
 166                 <div class="nav-bar">
 167                         <a href="#sec-description">Description</a> |
 168                                                                                                                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 169
 170                                 |
 171                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 172                 </div>
 173                 <div class="info-box-body">
 174                         <div class="method-summary">
 175
 176                                 <div class="method-definition">
 177                                         <img src="../../media/images/Constructor.png" alt=" "/>
 178                                                                                         <span class="method-result">The</span>
 179                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
 180                                                                                         (<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>)
 181                                                                         </div>
 182
 183                                 <div class="method-definition">
 184                                         <img src="../../media/images/Method.png" alt=" "/>
 185                                                                                         <span class="method-result">string</span>
 186                                                                                 <a href="#BuildOptionList" title="details" class="method-name">BuildOptionList</a>
 187                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">'options'</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">false</span>])
 188                                                                         </div>
 189
 190                                 <div class="method-definition">
 191                                         <img src="../../media/images/Method.png" alt=" "/>
 192                                                                                         <span class="method-result">resource</span>
 193                                                                                 <a href="#Exec" title="details" class="method-name">Exec</a>
 194                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">''</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">''</span>])
 195                                                                         </div>
 196
 197                                 <div class="method-definition">
 198                                         <img src="../../media/images/Method.png" alt=" "/>
 199                                                                                         <span class="method-result">mixed</span>
 200                                                                                 <a href="#Fetch" title="details" class="method-name">Fetch</a>
 201                                                                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 202                                                                         </div>
 203
 204                                 <div class="method-definition">
 205                                         <img src="../../media/images/Method.png" alt=" "/>
 206                                                                                         <span class="method-result">mixed</span>
 207                                                                                 <a href="#FetchBackwards" title="details" class="method-name">FetchBackwards</a>
 208                                                                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 209                                                                         </div>
 210
 211                                 <div class="method-definition">
 212                                         <img src="../../media/images/Method.png" alt=" "/>
 213                                                                                         <span class="method-result">array</span>
 214                                                                                 <a href="#Plain" title="details" class="method-name">Plain</a>
 215                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
 216                                                                         </div>
 217
 218                                 <div class="method-definition">
 219                                         <img src="../../media/images/Method.png" alt=" "/>
 220                                                                                         <span class="method-result">string</span>
 221                                                                                 <a href="#quote" title="details" class="method-name">quote</a>
 222                                                                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">null</span>])
 223                                                                         </div>
 224
 225                                 <div class="method-definition">
 226                                         <img src="../../media/images/Method.png" alt=" "/>
 227                                                                                         <span class="method-result">void</span>
 228                                                                                 <a href="#rows" title="details" class="method-name">rows</a>
 229                                                                                 ()
 230                                                                         </div>
 231
 232                                 <div class="method-definition">
 233                                         <img src="../../media/images/Method.png" alt=" "/>
 234                                                                                         <span class="method-result">void</span>
 235                                                                                 <a href="#SetConnection" title="details" class="method-name">SetConnection</a>
 236                                                                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>)
 237                                                                         </div>
 238
 239                                 <div class="method-definition">
 240                                         <img src="../../media/images/Method.png" alt=" "/>
 241                                                                                         <span class="method-result">void</span>
 242                                                                                 <a href="#UnFetch" title="details" class="method-name">UnFetch</a>
 243                                                                                 ()
 244                                                                         </div>
 245
 246                                 <div class="method-definition">
 247                                         <img src="../../media/images/Method.png" alt=" "/>
 248                                                                                         <span class="method-result">void</span>
 249                                                                                 <a href="#_log_error" title="details" class="method-name">_log_error</a>
 250                                                                                         (<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>])
 251                                                                         </div>
 252                                                                                         </div>
 253                 </div>
 254         </div>
 255
 256         <a name="sec-vars"></a>
 257         <div class="info-box">
 258                 <div class="info-box-title">Variables</div>
 259                 <div class="nav-bar">
 260                         <a href="#sec-description">Description</a> |
 261                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 262
 263
 264                                                                                 |
 265                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 266
 267                                         </div>
 268                 <div class="info-box-body">
 269
 270 <a name="var$errorstring" id="$errorstring"><!-- --></A>
 271 <div class="oddrow">
 272
 273         <div class="var-header">
 274                 <img src="../../media/images/Variable.png" />
 275                 <span class="var-title">
 276                         <span class="var-type">string</span>
 277                         <span class="var-name">$errorstring</span>
 278                                                 (line <span class="line-number">341</span>)
 279                 </span>
 280         </div>
 281
 282         <!-- ========== Info from phpDoc block ========= -->
 283 <p class="short-description">The PostgreSQL error message, if the query fails.</p>
 284 <p class="description"><p>Should be read-only, although any successful Exec should clear it</p></p>
 285         <ul class="tags">
 286                                 <li><span class="field">access:</span> public</li>
 287                         </ul>
 288
 289
 290
 291
 292
 293 </div>
 294 <a name="var$execution_time" id="$execution_time"><!-- --></A>
 295 <div class="evenrow">
 296
 297         <div class="var-header">
 298                 <img src="../../media/images/Variable.png" />
 299                 <span class="var-title">
 300                         <span class="var-type">string</span>
 301                         <span class="var-name">$execution_time</span>
 302                                                 (line <span class="line-number">348</span>)
 303                 </span>
 304         </div>
 305
 306         <!-- ========== Info from phpDoc block ========= -->
 307 <p class="short-description">Stores the query execution time - used to deal with long queries.</p>
 308 <p class="description"><p>should be read-only</p></p>
 309         <ul class="tags">
 310                                 <li><span class="field">access:</span> public</li>
 311                         </ul>
 312
 313
 314
 315
 316
 317 </div>
 318 <a name="var$query_time_warning" id="$query_time_warning"><!-- --></A>
 319 <div class="oddrow">
 320
 321         <div class="var-header">
 322                 <img src="../../media/images/Variable.png" />
 323                 <span class="var-title">
 324                         <span class="var-type">double</span>
 325                         <span class="var-name">$query_time_warning</span>
 326                          = <span class="var-default"> 0.3</span>                        (line <span class="line-number">357</span>)
 327                 </span>
 328         </div>
 329
 330         <!-- ========== Info from phpDoc block ========= -->
 331 <p class="short-description">How long the query should take before a warning is issued.</p>
 332 <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>
 333         <ul class="tags">
 334                                 <li><span class="field">access:</span> public</li>
 335                         </ul>
 336
 337
 338
 339
 340
 341 </div>
 342 <a name="var$rows" id="$rows"><!-- --></A>
 343 <div class="evenrow">
 344
 345         <div class="var-header">
 346                 <img src="../../media/images/Variable.png" />
 347                 <span class="var-title">
 348                         <span class="var-type">int</span>
 349                         <span class="var-name">$rows</span>
 350                                                 (line <span class="line-number">334</span>)
 351                 </span>
 352         </div>
 353
 354         <!-- ========== Info from phpDoc block ========= -->
 355 <p class="short-description">number of rows from pg_numrows - for fetching result</p>
 356 <p class="description"><p>should be read-only</p></p>
 357         <ul class="tags">
 358                                 <li><span class="field">access:</span> public</li>
 359                         </ul>
 360
 361
 362
 363
 364
 365 </div>
 366
 367                 </div>
 368         </div>
 369
 370         <a name="sec-methods"></a>
 371         <div class="info-box">
 372                 <div class="info-box-title">Methods</div>
 373                 <div class="nav-bar">
 374                         <a href="#sec-description">Description</a> |
 375                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 376                                                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 377
 378                 </div>
 379                 <div class="info-box-body">
 380                         <A NAME='method_detail'></A>
 381 <a name="method__construct" id="__construct"><!-- --></a>
 382 <div class="oddrow">
 383
 384         <div class="method-header">
 385                 <img src="../../media/images/Constructor.png" />
 386                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">367</span>)
 387         </div>
 388
 389         <!-- ========== Info from phpDoc block ========= -->
 390 <p class="short-description">Constructor</p>
 391         <ul class="tags">
 392                                 <li><span class="field">return:</span> PgQuery object</li>
 393                         </ul>
 394
 395         <div class="method-signature">
 396                 <span class="method-result">The</span>
 397                 <span class="method-name">
 398                         __construct
 399                 </span>
 400                                         (<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>)
 401                         </div>
 402
 403                         <ul class="parameters">
 404                                         <li>
 405                                 <span class="var-type">string</span>
 406                                 <span class="var-name">0</span><span class="var-description">: The query string with replacable '?' characters.</span>                  </li>
 407                                         <li>
 408                                 <span class="var-type">mixed</span>
 409                                 <span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span>                        </li>
 410                                 </ul>
 411
 412
 413         </div>
 414 <a name="methodBuildOptionList" id="BuildOptionList"><!-- --></a>
 415 <div class="evenrow">
 416
 417         <div class="method-header">
 418                 <img src="../../media/images/Method.png" />
 419                 <span class="method-title">BuildOptionList</span> (line <span class="line-number">615</span>)
 420         </div>
 421
 422         <!-- ========== Info from phpDoc block ========= -->
 423 <p class="short-description">Build an option list from the query.</p>
 424         <ul class="tags">
 425                                 <li><span class="field">return:</span> Select box HTML</li>
 426                         </ul>
 427
 428         <div class="method-signature">
 429                 <span class="method-result">string</span>
 430                 <span class="method-name">
 431                         BuildOptionList
 432                 </span>
 433                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">'options'</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">false</span>])
 434                         </div>
 435
 436                         <ul class="parameters">
 437                                         <li>
 438                                 <span class="var-type">string</span>
 439                                 <span class="var-name">$current</span><span class="var-description">: Default selection of drop down box (optional)</span>                      </li>
 440                                         <li>
 441                                 <span class="var-type">string</span>
 442                                 <span class="var-name">$location</span><span class="var-description">: for debugging purposes</span>                    </li>
 443                                         <li>
 444                                 <span class="var-type">array</span>
 445                                 <span class="var-name">$parameters</span><span class="var-description">: an array further parameters, including 'maxwidth' =&gt; 20 to set a maximum width</span>                       </li>
 446                                 </ul>
 447
 448
 449         </div>
 450 <a name="methodExec" id="Exec"><!-- --></a>
 451 <div class="oddrow">
 452
 453         <div class="method-header">
 454                 <img src="../../media/images/Method.png" />
 455                 <span class="method-title">Exec</span> (line <span class="line-number">478</span>)
 456         </div>
 457
 458         <!-- ========== Info from phpDoc block ========= -->
 459 <p class="short-description">Execute the query, logging any debugging.</p>
 460 <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/PgQuery/PgQuery.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>
 461 </ol></div></p></p>
 462         <ul class="tags">
 463                                 <li><span class="field">return:</span> The actual result of the query (FWIW)</li>
 464                         </ul>
 465
 466         <div class="method-signature">
 467                 <span class="method-result">resource</span>
 468                 <span class="method-name">
 469                         Exec
 470                 </span>
 471                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">''</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">''</span>])
 472                         </div>
 473
 474                         <ul class="parameters">
 475                                         <li>
 476                                 <span class="var-type">string</span>
 477                                 <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>
 478                                         <li>
 479                                 <span class="var-type">int</span>
 480                                 <span class="var-name">$line</span><span class="var-description">: The line number where Exec was called</span>                 </li>
 481                                         <li>
 482                                 <span class="var-type">string</span>
 483                                 <span class="var-name">$file</span><span class="var-description">: The file where Exec was called</span>                        </li>
 484                                 </ul>
 485
 486
 487         </div>
 488 <a name="methodFetch" id="Fetch"><!-- --></a>
 489 <div class="evenrow">
 490
 491         <div class="method-header">
 492                 <img src="../../media/images/Method.png" />
 493                 <span class="method-title">Fetch</span> (line <span class="line-number">525</span>)
 494         </div>
 495
 496         <!-- ========== Info from phpDoc block ========= -->
 497 <p class="short-description">Fetch the next row from the query results</p>
 498         <ul class="tags">
 499                                 <li><span class="field">return:</span> query row</li>
 500                         </ul>
 501
 502         <div class="method-signature">
 503                 <span class="method-result">mixed</span>
 504                 <span class="method-name">
 505                         Fetch
 506                 </span>
 507                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 508                         </div>
 509
 510                         <ul class="parameters">
 511                                         <li>
 512                                 <span class="var-type">boolean</span>
 513                                 <span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array</span>                     </li>
 514                                 </ul>
 515
 516
 517         </div>
 518 <a name="methodFetchBackwards" id="FetchBackwards"><!-- --></a>
 519 <div class="oddrow">
 520
 521         <div class="method-header">
 522                 <img src="../../media/images/Method.png" />
 523                 <span class="method-title">FetchBackwards</span> (line <span class="line-number">581</span>)
 524         </div>
 525
 526         <!-- ========== Info from phpDoc block ========= -->
 527 <p class="short-description">Fetch backwards from the result resource</p>
 528         <ul class="tags">
 529                                 <li><span class="field">return:</span> query row</li>
 530                         </ul>
 531
 532         <div class="method-signature">
 533                 <span class="method-result">mixed</span>
 534                 <span class="method-name">
 535                         FetchBackwards
 536                 </span>
 537                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 538                         </div>
 539
 540                         <ul class="parameters">
 541                                         <li>
 542                                 <span class="var-type">boolean</span>
 543                                 <span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array (default: <strong>False</strong></span>                    </li>
 544                                 </ul>
 545
 546
 547         </div>
 548 <a name="methodPlain" id="Plain"><!-- --></a>
 549 <div class="evenrow">
 550
 551         <div class="method-header">
 552                 <img src="../../media/images/Method.png" />
 553                 <span class="method-title">Plain</span> (line <span class="line-number">455</span>)
 554         </div>
 555
 556         <!-- ========== Info from phpDoc block ========= -->
 557 <p class="short-description">Convert a string which has already been quoted and escaped for PostgreSQL  into a magic array so that it will be inserted unmodified into the SQL  string.  Use with care!</p>
 558         <ul class="tags">
 559                                 <li><span class="field">return:</span> An array with the value associated with a key of 'plain'</li>
 560                         </ul>
 561
 562         <div class="method-signature">
 563                 <span class="method-result">array</span>
 564                 <span class="method-name">
 565                         Plain
 566                 </span>
 567                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
 568                         </div>
 569
 570                         <ul class="parameters">
 571                                         <li>
 572                                 <span class="var-type">string</span>
 573                                 <span class="var-name">$field</span><span class="var-description">: The value which has alread been quoted and escaped.</span>                  </li>
 574                                 </ul>
 575
 576
 577         </div>
 578 <a name="methodquote" id="quote"><!-- --></a>
 579 <div class="oddrow">
 580
 581         <div class="method-header">
 582                 <img src="../../media/images/Method.png" />
 583                 <span class="method-title">quote</span> (line <span class="line-number">443</span>)
 584         </div>
 585
 586         <!-- ========== Info from phpDoc block ========= -->
 587 <p class="short-description">Quote the given string so it can be safely used within string delimiters  in a query.</p>
 588         <ul class="tags">
 589                                 <li><span class="field">return:</span> NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped</li>
 590                                 <li><span class="field">see:</span> qpg()
 591  which is where this is really done.</li>
 592                         </ul>
 593
 594         <div class="method-signature">
 595                 <span class="method-result">string</span>
 596                 <span class="method-name">
 597                         quote
 598                 </span>
 599                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">null</span>])
 600                         </div>
 601
 602                         <ul class="parameters">
 603                                         <li>
 604                                 <span class="var-type">mixed</span>
 605                                 <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>
 606                                 </ul>
 607
 608
 609         </div>
 610 <a name="methodrows" id="rows"><!-- --></a>
 611 <div class="evenrow">
 612
 613         <div class="method-header">
 614                 <img src="../../media/images/Method.png" />
 615                 <span class="method-title">rows</span> (line <span class="line-number">429</span>)
 616         </div>
 617
 618         <!-- ========== Info from phpDoc block ========= -->
 619 <p class="short-description">Provide a rows() method for forward compatibility with AwlQuery.</p>
 620
 621         <div class="method-signature">
 622                 <span class="method-result">void</span>
 623                 <span class="method-name">
 624                         rows
 625                 </span>
 626                                 ()
 627                         </div>
 628
 629
 630
 631         </div>
 632 <a name="methodSetConnection" id="SetConnection"><!-- --></a>
 633 <div class="oddrow">
 634
 635         <div class="method-header">
 636                 <img src="../../media/images/Method.png" />
 637                 <span class="method-title">SetConnection</span> (line <span class="line-number">394</span>)
 638         </div>
 639
 640         <!-- ========== Info from phpDoc block ========= -->
 641 <p class="short-description">Use a different database connection for this query</p>
 642
 643         <div class="method-signature">
 644                 <span class="method-result">void</span>
 645                 <span class="method-name">
 646                         SetConnection
 647                 </span>
 648                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>)
 649                         </div>
 650
 651                         <ul class="parameters">
 652                                         <li>
 653                                 <span class="var-type">resource</span>
 654                                 <span class="var-name">$new_connection</span><span class="var-description">: The database connection to use.</span>                     </li>
 655                                 </ul>
 656
 657
 658         </div>
 659 <a name="methodUnFetch" id="UnFetch"><!-- --></a>
 660 <div class="evenrow">
 661
 662         <div class="method-header">
 663                 <img src="../../media/images/Method.png" />
 664                 <span class="method-title">UnFetch</span> (line <span class="line-number">570</span>)
 665         </div>
 666
 667         <!-- ========== Info from phpDoc block ========= -->
 668 <p class="short-description">Set row counter back one</p>
 669 <p class="description"><p>In the case that you may like to fetch the same row twice, for example  if your SQL returns some columns that are the same for each row, and you  want to display them cleanly before displaying the other data repeatedly  for each row.</p><p><strong>Example</strong>  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$master_row&nbsp;</span>=&nbsp;<span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/PgQuery/PgQuery.html#methodFetch">Fetch</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 670 <li><div class="src-line">&nbsp;<span class="src-var">$qry</span><span class="src-sym">-&gt;</span><a href="../../awl/PgQuery/PgQuery.html#methodUnFetch">UnFetch</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 671 <li><div class="src-line">&nbsp;<span class="src-id">do_something_first</span><span class="src-sym">(</span><span class="src-var">$master_row</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 672 <li><div class="src-line">&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/PgQuery/PgQuery.html#methodFetch">Fetch</a><span class="src-sym">(</span><span class="src-sym">)&nbsp;)&nbsp;</span><span class="src-sym">{</span></div></li>
 673 <li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-id">do_something_repeatedly</span><span class="src-sym">(</span><span class="src-var">$row</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 674 <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
 675 </ol></div></p></p>
 676
 677         <div class="method-signature">
 678                 <span class="method-result">void</span>
 679                 <span class="method-name">
 680                         UnFetch
 681                 </span>
 682                                 ()
 683                         </div>
 684
 685
 686
 687         </div>
 688 <a name="method_log_error" id="_log_error"><!-- --></a>
 689 <div class="oddrow">
 690
 691         <div class="method-header">
 692                 <img src="../../media/images/Method.png" />
 693                 <span class="method-title">_log_error</span> (line <span class="line-number">412</span>)
 694         </div>
 695
 696         <!-- ========== Info from phpDoc block ========= -->
 697 <p class="short-description">Log error, optionally with file and line location of the caller.</p>
 698 <p class="description"><p>This function should not really be used outside of PgQuery.  For a more  useful generic logging interface consider calling dbg_error_log(...);</p></p>
 699
 700         <div class="method-signature">
 701                 <span class="method-result">void</span>
 702                 <span class="method-name">
 703                         _log_error
 704                 </span>
 705                                         (<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>])
 706                         </div>
 707
 708                         <ul class="parameters">
 709                                         <li>
 710                                 <span class="var-type">string</span>
 711                                 <span class="var-name">$locn</span><span class="var-description">: A string identifying the calling location.</span>                    </li>
 712                                         <li>
 713                                 <span class="var-type">string</span>
 714                                 <span class="var-name">$tag</span><span class="var-description">: A tag string, e.g. identifying the type of event.</span>                      </li>
 715                                         <li>
 716                                 <span class="var-type">string</span>
 717                                 <span class="var-name">$string</span><span class="var-description">: The information to be logged.</span>                       </li>
 718                                         <li>
 719                                 <span class="var-type">int</span>
 720                                 <span class="var-name">$line</span><span class="var-description">: The line number where the logged event occurred.</span>                      </li>
 721                                         <li>
 722                                 <span class="var-type">string</span>
 723                                 <span class="var-name">$file</span><span class="var-description">: The file name where the logged event occurred.</span>                        </li>
 724                                 </ul>
 725
 726
 727         </div>
 728
 729                 </div>
 730         </div>
 731
 732
 733         <p class="notes" id="credit">
 734                 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 735         </p>
 736         </div></body>
 737 </html>