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><span class="src-id"><a href="../../awl/PgQuery/PgQuery.html#var$rows">rows</a>&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">272</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="#SetConnection" title="details" class="method-name">SetConnection</a>
 229                                                                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>)
 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="#UnFetch" title="details" class="method-name">UnFetch</a>
 236                                                                                 ()
 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="#_log_error" title="details" class="method-name">_log_error</a>
 243                                                                                         (<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>])
 244                                                                         </div>
 245                                                                                         </div>
 246                 </div>
 247         </div>
 248
 249         <a name="sec-vars"></a>
 250         <div class="info-box">
 251                 <div class="info-box-title">Variables</div>
 252                 <div class="nav-bar">
 253                         <a href="#sec-description">Description</a> |
 254                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 255
 256
 257                                                                                 |
 258                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 259
 260                                         </div>
 261                 <div class="info-box-body">
 262
 263 <a name="var$errorstring" id="$errorstring"><!-- --></A>
 264 <div class="evenrow">
 265
 266         <div class="var-header">
 267                 <img src="../../media/images/Variable.png" />
 268                 <span class="var-title">
 269                         <span class="var-type">string</span>
 270                         <span class="var-name">$errorstring</span>
 271                                                 (line <span class="line-number">336</span>)
 272                 </span>
 273         </div>
 274
 275         <!-- ========== Info from phpDoc block ========= -->
 276 <p class="short-description">The PostgreSQL error message, if the query fails.</p>
 277 <p class="description"><p>Should be read-only, although any successful Exec should clear it</p></p>
 278         <ul class="tags">
 279                                 <li><span class="field">access:</span> public</li>
 280                         </ul>
 281
 282
 283
 284
 285
 286 </div>
 287 <a name="var$execution_time" id="$execution_time"><!-- --></A>
 288 <div class="oddrow">
 289
 290         <div class="var-header">
 291                 <img src="../../media/images/Variable.png" />
 292                 <span class="var-title">
 293                         <span class="var-type">string</span>
 294                         <span class="var-name">$execution_time</span>
 295                                                 (line <span class="line-number">343</span>)
 296                 </span>
 297         </div>
 298
 299         <!-- ========== Info from phpDoc block ========= -->
 300 <p class="short-description">Stores the query execution time - used to deal with long queries.</p>
 301 <p class="description"><p>should be read-only</p></p>
 302         <ul class="tags">
 303                                 <li><span class="field">access:</span> public</li>
 304                         </ul>
 305
 306
 307
 308
 309
 310 </div>
 311 <a name="var$query_time_warning" id="$query_time_warning"><!-- --></A>
 312 <div class="evenrow">
 313
 314         <div class="var-header">
 315                 <img src="../../media/images/Variable.png" />
 316                 <span class="var-title">
 317                         <span class="var-type">double</span>
 318                         <span class="var-name">$query_time_warning</span>
 319                          = <span class="var-default"> 0.3</span>                        (line <span class="line-number">352</span>)
 320                 </span>
 321         </div>
 322
 323         <!-- ========== Info from phpDoc block ========= -->
 324 <p class="short-description">How long the query should take before a warning is issued.</p>
 325 <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>
 326         <ul class="tags">
 327                                 <li><span class="field">access:</span> public</li>
 328                         </ul>
 329
 330
 331
 332
 333
 334 </div>
 335 <a name="var$rows" id="$rows"><!-- --></A>
 336 <div class="oddrow">
 337
 338         <div class="var-header">
 339                 <img src="../../media/images/Variable.png" />
 340                 <span class="var-title">
 341                         <span class="var-type">int</span>
 342                         <span class="var-name">$rows</span>
 343                                                 (line <span class="line-number">329</span>)
 344                 </span>
 345         </div>
 346
 347         <!-- ========== Info from phpDoc block ========= -->
 348 <p class="short-description">number of rows from pg_numrows - for fetching result</p>
 349 <p class="description"><p>should be read-only</p></p>
 350         <ul class="tags">
 351                                 <li><span class="field">access:</span> public</li>
 352                         </ul>
 353
 354
 355
 356
 357
 358 </div>
 359
 360                 </div>
 361         </div>
 362
 363         <a name="sec-methods"></a>
 364         <div class="info-box">
 365                 <div class="info-box-title">Methods</div>
 366                 <div class="nav-bar">
 367                         <a href="#sec-description">Description</a> |
 368                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 369                                                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 370
 371                 </div>
 372                 <div class="info-box-body">
 373                         <A NAME='method_detail'></A>
 374 <a name="method__construct" id="__construct"><!-- --></a>
 375 <div class="evenrow">
 376
 377         <div class="method-header">
 378                 <img src="../../media/images/Constructor.png" />
 379                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">362</span>)
 380         </div>
 381
 382         <!-- ========== Info from phpDoc block ========= -->
 383 <p class="short-description">Constructor</p>
 384         <ul class="tags">
 385                                 <li><span class="field">return:</span> PgQuery object</li>
 386                         </ul>
 387
 388         <div class="method-signature">
 389                 <span class="method-result">The</span>
 390                 <span class="method-name">
 391                         __construct
 392                 </span>
 393                                         (<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>)
 394                         </div>
 395
 396                         <ul class="parameters">
 397                                         <li>
 398                                 <span class="var-type">string</span>
 399                                 <span class="var-name">0</span><span class="var-description">: The query string with replacable '?' characters.</span>                  </li>
 400                                         <li>
 401                                 <span class="var-type">mixed</span>
 402                                 <span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span>                        </li>
 403                                 </ul>
 404
 405
 406         </div>
 407 <a name="methodBuildOptionList" id="BuildOptionList"><!-- --></a>
 408 <div class="oddrow">
 409
 410         <div class="method-header">
 411                 <img src="../../media/images/Method.png" />
 412                 <span class="method-title">BuildOptionList</span> (line <span class="line-number">604</span>)
 413         </div>
 414
 415         <!-- ========== Info from phpDoc block ========= -->
 416 <p class="short-description">Build an option list from the query.</p>
 417         <ul class="tags">
 418                                 <li><span class="field">return:</span> Select box HTML</li>
 419                         </ul>
 420
 421         <div class="method-signature">
 422                 <span class="method-result">string</span>
 423                 <span class="method-name">
 424                         BuildOptionList
 425                 </span>
 426                                         ([<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>])
 427                         </div>
 428
 429                         <ul class="parameters">
 430                                         <li>
 431                                 <span class="var-type">string</span>
 432                                 <span class="var-name">$current</span><span class="var-description">: Default selection of drop down box (optional)</span>                      </li>
 433                                         <li>
 434                                 <span class="var-type">string</span>
 435                                 <span class="var-name">$location</span><span class="var-description">: for debugging purposes</span>                    </li>
 436                                         <li>
 437                                 <span class="var-type">array</span>
 438                                 <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>
 439                                 </ul>
 440
 441
 442         </div>
 443 <a name="methodExec" id="Exec"><!-- --></a>
 444 <div class="evenrow">
 445
 446         <div class="method-header">
 447                 <img src="../../media/images/Method.png" />
 448                 <span class="method-title">Exec</span> (line <span class="line-number">467</span>)
 449         </div>
 450
 451         <!-- ========== Info from phpDoc block ========= -->
 452 <p class="short-description">Execute the query, logging any debugging.</p>
 453 <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>
 454 </ol></div></p></p>
 455         <ul class="tags">
 456                                 <li><span class="field">return:</span> The actual result of the query (FWIW)</li>
 457                         </ul>
 458
 459         <div class="method-signature">
 460                 <span class="method-result">resource</span>
 461                 <span class="method-name">
 462                         Exec
 463                 </span>
 464                                         ([<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>])
 465                         </div>
 466
 467                         <ul class="parameters">
 468                                         <li>
 469                                 <span class="var-type">string</span>
 470                                 <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>
 471                                         <li>
 472                                 <span class="var-type">int</span>
 473                                 <span class="var-name">$line</span><span class="var-description">: The line number where Exec was called</span>                 </li>
 474                                         <li>
 475                                 <span class="var-type">string</span>
 476                                 <span class="var-name">$file</span><span class="var-description">: The file where Exec was called</span>                        </li>
 477                                 </ul>
 478
 479
 480         </div>
 481 <a name="methodFetch" id="Fetch"><!-- --></a>
 482 <div class="oddrow">
 483
 484         <div class="method-header">
 485                 <img src="../../media/images/Method.png" />
 486                 <span class="method-title">Fetch</span> (line <span class="line-number">514</span>)
 487         </div>
 488
 489         <!-- ========== Info from phpDoc block ========= -->
 490 <p class="short-description">Fetch the next row from the query results</p>
 491         <ul class="tags">
 492                                 <li><span class="field">return:</span> query row</li>
 493                         </ul>
 494
 495         <div class="method-signature">
 496                 <span class="method-result">mixed</span>
 497                 <span class="method-name">
 498                         Fetch
 499                 </span>
 500                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 501                         </div>
 502
 503                         <ul class="parameters">
 504                                         <li>
 505                                 <span class="var-type">boolean</span>
 506                                 <span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array</span>                     </li>
 507                                 </ul>
 508
 509
 510         </div>
 511 <a name="methodFetchBackwards" id="FetchBackwards"><!-- --></a>
 512 <div class="evenrow">
 513
 514         <div class="method-header">
 515                 <img src="../../media/images/Method.png" />
 516                 <span class="method-title">FetchBackwards</span> (line <span class="line-number">570</span>)
 517         </div>
 518
 519         <!-- ========== Info from phpDoc block ========= -->
 520 <p class="short-description">Fetch backwards from the result resource</p>
 521         <ul class="tags">
 522                                 <li><span class="field">return:</span> query row</li>
 523                         </ul>
 524
 525         <div class="method-signature">
 526                 <span class="method-result">mixed</span>
 527                 <span class="method-name">
 528                         FetchBackwards
 529                 </span>
 530                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_array</span> = <span class="var-default">false</span>])
 531                         </div>
 532
 533                         <ul class="parameters">
 534                                         <li>
 535                                 <span class="var-type">boolean</span>
 536                                 <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>
 537                                 </ul>
 538
 539
 540         </div>
 541 <a name="methodPlain" id="Plain"><!-- --></a>
 542 <div class="oddrow">
 543
 544         <div class="method-header">
 545                 <img src="../../media/images/Method.png" />
 546                 <span class="method-title">Plain</span> (line <span class="line-number">444</span>)
 547         </div>
 548
 549         <!-- ========== Info from phpDoc block ========= -->
 550 <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>
 551         <ul class="tags">
 552                                 <li><span class="field">return:</span> An array with the value associated with a key of 'plain'</li>
 553                         </ul>
 554
 555         <div class="method-signature">
 556                 <span class="method-result">array</span>
 557                 <span class="method-name">
 558                         Plain
 559                 </span>
 560                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
 561                         </div>
 562
 563                         <ul class="parameters">
 564                                         <li>
 565                                 <span class="var-type">string</span>
 566                                 <span class="var-name">$field</span><span class="var-description">: The value which has alread been quoted and escaped.</span>                  </li>
 567                                 </ul>
 568
 569
 570         </div>
 571 <a name="methodquote" id="quote"><!-- --></a>
 572 <div class="evenrow">
 573
 574         <div class="method-header">
 575                 <img src="../../media/images/Method.png" />
 576                 <span class="method-title">quote</span> (line <span class="line-number">432</span>)
 577         </div>
 578
 579         <!-- ========== Info from phpDoc block ========= -->
 580 <p class="short-description">Quote the given string so it can be safely used within string delimiters  in a query.</p>
 581         <ul class="tags">
 582                                 <li><span class="field">return:</span> NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped</li>
 583                                 <li><span class="field">see:</span> qpg()
 584  which is where this is really done.</li>
 585                         </ul>
 586
 587         <div class="method-signature">
 588                 <span class="method-result">string</span>
 589                 <span class="method-name">
 590                         quote
 591                 </span>
 592                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">null</span>])
 593                         </div>
 594
 595                         <ul class="parameters">
 596                                         <li>
 597                                 <span class="var-type">mixed</span>
 598                                 <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>
 599                                 </ul>
 600
 601
 602         </div>
 603 <a name="methodSetConnection" id="SetConnection"><!-- --></a>
 604 <div class="oddrow">
 605
 606         <div class="method-header">
 607                 <img src="../../media/images/Method.png" />
 608                 <span class="method-title">SetConnection</span> (line <span class="line-number">389</span>)
 609         </div>
 610
 611         <!-- ========== Info from phpDoc block ========= -->
 612 <p class="short-description">Use a different database connection for this query</p>
 613
 614         <div class="method-signature">
 615                 <span class="method-result">void</span>
 616                 <span class="method-name">
 617                         SetConnection
 618                 </span>
 619                                         (<span class="var-type">resource</span>&nbsp;<span class="var-name">$new_connection</span>)
 620                         </div>
 621
 622                         <ul class="parameters">
 623                                         <li>
 624                                 <span class="var-type">resource</span>
 625                                 <span class="var-name">$new_connection</span><span class="var-description">: The database connection to use.</span>                     </li>
 626                                 </ul>
 627
 628
 629         </div>
 630 <a name="methodUnFetch" id="UnFetch"><!-- --></a>
 631 <div class="evenrow">
 632
 633         <div class="method-header">
 634                 <img src="../../media/images/Method.png" />
 635                 <span class="method-title">UnFetch</span> (line <span class="line-number">559</span>)
 636         </div>
 637
 638         <!-- ========== Info from phpDoc block ========= -->
 639 <p class="short-description">Set row counter back one</p>
 640 <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>
 641 <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>
 642 <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>
 643 <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>
 644 <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>
 645 <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
 646 </ol></div></p></p>
 647
 648         <div class="method-signature">
 649                 <span class="method-result">void</span>
 650                 <span class="method-name">
 651                         UnFetch
 652                 </span>
 653                                 ()
 654                         </div>
 655
 656
 657
 658         </div>
 659 <a name="method_log_error" id="_log_error"><!-- --></a>
 660 <div class="oddrow">
 661
 662         <div class="method-header">
 663                 <img src="../../media/images/Method.png" />
 664                 <span class="method-title">_log_error</span> (line <span class="line-number">407</span>)
 665         </div>
 666
 667         <!-- ========== Info from phpDoc block ========= -->
 668 <p class="short-description">Log error, optionally with file and line location of the caller.</p>
 669 <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>
 670
 671         <div class="method-signature">
 672                 <span class="method-result">void</span>
 673                 <span class="method-name">
 674                         _log_error
 675                 </span>
 676                                         (<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>])
 677                         </div>
 678
 679                         <ul class="parameters">
 680                                         <li>
 681                                 <span class="var-type">string</span>
 682                                 <span class="var-name">$locn</span><span class="var-description">: A string identifying the calling location.</span>                    </li>
 683                                         <li>
 684                                 <span class="var-type">string</span>
 685                                 <span class="var-name">$tag</span><span class="var-description">: A tag string, e.g. identifying the type of event.</span>                      </li>
 686                                         <li>
 687                                 <span class="var-type">string</span>
 688                                 <span class="var-name">$string</span><span class="var-description">: The information to be logged.</span>                       </li>
 689                                         <li>
 690                                 <span class="var-type">int</span>
 691                                 <span class="var-name">$line</span><span class="var-description">: The line number where the logged event occurred.</span>                      </li>
 692                                         <li>
 693                                 <span class="var-type">string</span>
 694                                 <span class="var-name">$file</span><span class="var-description">: The file name where the logged event occurred.</span>                        </li>
 695                                 </ul>
 696
 697
 698         </div>
 699
 700                 </div>
 701         </div>
 702
 703
 704         <p class="notes" id="credit">
 705                 Documentation generated on Mon, 21 Dec 2009 23:33:39 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
 706         </p>
 707         </div></body>
 708 </html>