docs/phpfspot/PHPFSPOT_DB.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 PHPFSPOT_DB</title>
   7                         <link rel="stylesheet" href="../media/stylesheet.css" />
   8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9                 </head>
  10                 <body>
  11                         <div class="page-body">
  12 <h2 class="class-name"><img src="../media/images/Class_logo.png"
  13                                                                                                                 alt=" Class"
  14                                                                                                                 title=" Class"
  15                                                                                                                 style="vertical-align: middle"> PHPFSPOT_DB</h2>
  16
  17 <a name="sec-description"></a>
  18 <div class="info-box">
  19         <div class="info-box-title">Description</div>
  20         <div class="nav-bar">
  21                                         <span class="disabled">Description</span> |
  22                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  23
  24                                         </div>
  25         <div class="info-box-body">
  26                         <!-- ========== Info from phpDoc block ========= -->
  27 <p class="short-description">PHPFSPOT_DB class</p>
  28                 <p class="notes">
  29                         Located in <a class="field" href="_phpfspot_db.php.html">/phpfspot_db.php</a> (line <span class="field">30</span>)
  30                 </p>
  31
  32
  33                 <pre></pre>
  34
  35                         </div>
  36 </div>
  37
  38
  39
  40
  41         <a name="sec-method-summary"></a>
  42         <div class="info-box">
  43                 <div class="info-box-title">Method Summary</span></div>
  44                 <div class="nav-bar">
  45                         <a href="#sec-description">Description</a> |
  46                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  47                 </div>
  48                 <div class="info-box-body">
  49                         <div class="method-summary">
  50                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  51                                         <img src="../media/images/Constructor.png" alt=" "/>
  52                                                                                         <span class="method-result">PHPFSPOT_DB</span>
  53                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  54                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$parent</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$db_path</span>)
  55                                                                         </div>
  56                                                                                                                                 <div class="method-definition">
  57                                         <img src="../media/images/Destructor.png" alt=" "/>
  58                                                                                         <span class="method-result">void</span>
  59                                                                                 <a href="#__destruct" title="details" class="method-name">__destruct</a>
  60                                                                                 ()
  61                                                                         </div>
  62                                                                                                                                 <div class="method-definition">
  63                                         <img src="../media/images/Method.png" alt=" "/>
  64                                                                                         <span class="method-result">void</span>
  65                                                                                 <a href="#db_check_column_exists" title="details" class="method-name">db_check_column_exists</a>
  66                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$column</span>)
  67                                                                         </div>
  68                                                                                                                                 <div class="method-definition">
  69                                         <img src="../media/images/Method.png" alt=" "/>
  70                                                                                         <span class="method-result">true</span>
  71                                                                                 <a href="#db_check_table_exists" title="details" class="method-name">db_check_table_exists</a>
  72                                                                                         ([<span class="var-type">string,</span>&nbsp;<span class="var-name">$table_name</span> = <span class="var-default">&quot;&quot;</span>])
  73                                                                         </div>
  74                                                                                                                                 <div class="method-definition">
  75                                         <img src="../media/images/Method.png" alt=" "/>
  76                                                                                         <span class="method-result">bool</span>
  77                                                                                 <a href="#db_commit_transaction" title="details" class="method-name">db_commit_transaction</a>
  78                                                                                 ()
  79                                                                         </div>
  80                                                                                                                                 <div class="method-definition">
  81                                         <img src="../media/images/Method.png" alt=" "/>
  82                                                                                         <span class="method-result">void</span>
  83                                                                                 <a href="#db_exec" title="details" class="method-name">db_exec</a>
  84                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
  85                                                                         </div>
  86                                                                                                                                 <div class="method-definition">
  87                                         <img src="../media/images/Method.png" alt=" "/>
  88                                                                                         <span class="method-result">void</span>
  89                                                                                 <a href="#db_fetchSingleRow" title="details" class="method-name">db_fetchSingleRow</a>
  90                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
  91                                                                         </div>
  92                                                                                                                                 <div class="method-definition">
  93                                         <img src="../media/images/Method.png" alt=" "/>
  94                                                                                         <span class="method-result">void</span>
  95                                                                                 <a href="#db_fetch_object" title="details" class="method-name">db_fetch_object</a>
  96                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$resource</span>)
  97                                                                         </div>
  98                                                                                                                                 <div class="method-definition">
  99                                         <img src="../media/images/Method.png" alt=" "/>
 100                                                                                         <span class="method-result">void</span>
 101                                                                                 <a href="#db_getNumRows" title="details" class="method-name">db_getNumRows</a>
 102                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 103                                                                         </div>
 104                                                                                                                                 <div class="method-definition">
 105                                         <img src="../media/images/Method.png" alt=" "/>
 106                                                                                         <span class="method-result">void</span>
 107                                                                                 <a href="#db_query" title="details" class="method-name">db_query</a>
 108                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 109                                                                         </div>
 110                                                                                                                                 <div class="method-definition">
 111                                         <img src="../media/images/Method.png" alt=" "/>
 112                                                                                         <span class="method-result">bool</span>
 113                                                                                 <a href="#db_rollback_transaction" title="details" class="method-name">db_rollback_transaction</a>
 114                                                                                 ()
 115                                                                         </div>
 116                                                                                                                                 <div class="method-definition">
 117                                         <img src="../media/images/Method.png" alt=" "/>
 118                                                                                         <span class="method-result">bool</span>
 119                                                                                 <a href="#db_start_transaction" title="details" class="method-name">db_start_transaction</a>
 120                                                                                 ()
 121                                                                         </div>
 122                                                                                         </div>
 123                 </div>
 124         </div>
 125
 126
 127         <a name="sec-methods"></a>
 128         <div class="info-box">
 129                 <div class="info-box-title">Methods</div>
 130                 <div class="nav-bar">
 131                         <a href="#sec-description">Description</a> |
 132                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 133
 134                 </div>
 135                 <div class="info-box-body">
 136                         <A NAME='method_detail'></A>
 137 <a name="method__construct" id="__construct"><!-- --></a>
 138 <div class="oddrow">
 139
 140         <div class="method-header">
 141                 <img src="../media/images/Constructor.png" />
 142                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">44</span>)
 143         </div>
 144
 145         <!-- ========== Info from phpDoc block ========= -->
 146 <p class="short-description">PHPFSPOT_DB class constructor</p>
 147 <p class="description"><p>This constructor initially connect to the database.</p></p>
 148         <ul class="tags">
 149                                 <li><span class="field">access:</span> public</li>
 150                         </ul>
 151
 152         <div class="method-signature">
 153                 <span class="method-result">PHPFSPOT_DB</span>
 154                 <span class="method-name">
 155                         __construct
 156                 </span>
 157                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$parent</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$db_path</span>)
 158                         </div>
 159
 160                         <ul class="parameters">
 161                                         <li>
 162                                 <span class="var-type"></span>
 163                                 <span class="var-name">$parent</span>                   </li>
 164                                         <li>
 165                                 <span class="var-type"></span>
 166                                 <span class="var-name">$db_path</span>                  </li>
 167                                 </ul>
 168
 169
 170         </div>
 171 <a name="method__destruct" id="__destruct"><!-- --></a>
 172 <div class="evenrow">
 173
 174         <div class="method-header">
 175                 <img src="../media/images/Destructor.png" />
 176                 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">64</span>)
 177         </div>
 178
 179         <!-- ========== Info from phpDoc block ========= -->
 180 <p class="short-description">PHPFSPOT_DB class deconstructor</p>
 181 <p class="description"><p>This destructor will close the current database connection.</p></p>
 182         <ul class="tags">
 183                                 <li><span class="field">access:</span> public</li>
 184                         </ul>
 185
 186         <div class="method-signature">
 187                 <span class="method-result">void</span>
 188                 <span class="method-name">
 189                         __destruct
 190                 </span>
 191                                 ()
 192                         </div>
 193
 194
 195
 196         </div>
 197 <a name="methoddb_check_column_exists" id="db_check_column_exists"><!-- --></a>
 198 <div class="oddrow">
 199
 200         <div class="method-header">
 201                 <img src="../media/images/Method.png" />
 202                 <span class="method-title">db_check_column_exists</span> (line <span class="line-number">284</span>)
 203         </div>
 204
 205         <!-- ========== Info from phpDoc block ========= -->
 206 <p class="short-description">PHPFSPOT_DB check column exist</p>
 207 <p class="description"><p>This function checks if the given column exists within  the specified table.</p></p>
 208         <ul class="tags">
 209                                 <li><span class="field">access:</span> public</li>
 210                         </ul>
 211
 212         <div class="method-signature">
 213                 <span class="method-result">void</span>
 214                 <span class="method-name">
 215                         db_check_column_exists
 216                 </span>
 217                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$column</span>)
 218                         </div>
 219
 220                         <ul class="parameters">
 221                                         <li>
 222                                 <span class="var-type"></span>
 223                                 <span class="var-name">$table_name</span>                       </li>
 224                                         <li>
 225                                 <span class="var-type"></span>
 226                                 <span class="var-name">$column</span>                   </li>
 227                                 </ul>
 228
 229
 230         </div>
 231 <a name="methoddb_check_table_exists" id="db_check_table_exists"><!-- --></a>
 232 <div class="evenrow">
 233
 234         <div class="method-header">
 235                 <img src="../media/images/Method.png" />
 236                 <span class="method-title">db_check_table_exists</span> (line <span class="line-number">253</span>)
 237         </div>
 238
 239         <!-- ========== Info from phpDoc block ========= -->
 240 <p class="short-description">PHPFSPOT_DB check table exists</p>
 241 <p class="description"><p>This function checks if the given table exists in the  database</p></p>
 242         <ul class="tags">
 243                                 <li><span class="field">return:</span> if table found otherwise false</li>
 244                                 <li><span class="field">access:</span> public</li>
 245                         </ul>
 246
 247         <div class="method-signature">
 248                 <span class="method-result">true</span>
 249                 <span class="method-name">
 250                         db_check_table_exists
 251                 </span>
 252                                         ([<span class="var-type">string,</span>&nbsp;<span class="var-name">$table_name</span> = <span class="var-default">&quot;&quot;</span>])
 253                         </div>
 254
 255                         <ul class="parameters">
 256                                         <li>
 257                                 <span class="var-type">string,</span>
 258                                 <span class="var-name">$table_name</span><span class="var-description">: table name</span>                      </li>
 259                                 </ul>
 260
 261
 262         </div>
 263 <a name="methoddb_commit_transaction" id="db_commit_transaction"><!-- --></a>
 264 <div class="oddrow">
 265
 266         <div class="method-header">
 267                 <img src="../media/images/Method.png" />
 268                 <span class="method-title">db_commit_transaction</span> (line <span class="line-number">398</span>)
 269         </div>
 270
 271         <!-- ========== Info from phpDoc block ========= -->
 272 <p class="short-description">commit transaction</p>
 273 <p class="description"><p>this will commit an ongoing transaction on ACID-supporting  database systems</p></p>
 274         <ul class="tags">
 275                                 <li><span class="field">access:</span> public</li>
 276                         </ul>
 277
 278         <div class="method-signature">
 279                 <span class="method-result">bool</span>
 280                 <span class="method-name">
 281                         db_commit_transaction
 282                 </span>
 283                                 ()
 284                         </div>
 285
 286
 287
 288         </div>
 289 <a name="methoddb_exec" id="db_exec"><!-- --></a>
 290 <div class="evenrow">
 291
 292         <div class="method-header">
 293                 <img src="../media/images/Method.png" />
 294                 <span class="method-title">db_exec</span> (line <span class="line-number">162</span>)
 295         </div>
 296
 297         <!-- ========== Info from phpDoc block ========= -->
 298 <p class="short-description">PHPFSPOT_DB database query &amp; execute</p>
 299 <p class="description"><p>This function will execute a SQL query and return nothing.</p></p>
 300         <ul class="tags">
 301                                 <li><span class="field">access:</span> public</li>
 302                         </ul>
 303
 304         <div class="method-signature">
 305                 <span class="method-result">void</span>
 306                 <span class="method-name">
 307                         db_exec
 308                 </span>
 309                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 310                         </div>
 311
 312                         <ul class="parameters">
 313                                         <li>
 314                                 <span class="var-type"></span>
 315                                 <span class="var-name">$query</span>                    </li>
 316                                 </ul>
 317
 318
 319         </div>
 320 <a name="methoddb_fetchSingleRow" id="db_fetchSingleRow"><!-- --></a>
 321 <div class="oddrow">
 322
 323         <div class="method-header">
 324                 <img src="../media/images/Method.png" />
 325                 <span class="method-title">db_fetchSingleRow</span> (line <span class="line-number">208</span>)
 326         </div>
 327
 328         <!-- ========== Info from phpDoc block ========= -->
 329 <p class="short-description">PHPFSPOT_DB fetch ONE row</p>
 330 <p class="description"><p>This function will execute the given but only return the  first result.</p></p>
 331         <ul class="tags">
 332                                 <li><span class="field">access:</span> public</li>
 333                         </ul>
 334
 335         <div class="method-signature">
 336                 <span class="method-result">void</span>
 337                 <span class="method-name">
 338                         db_fetchSingleRow
 339                 </span>
 340                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 341                         </div>
 342
 343                         <ul class="parameters">
 344                                         <li>
 345                                 <span class="var-type"></span>
 346                                 <span class="var-name">$query</span>                    </li>
 347                                 </ul>
 348
 349
 350         </div>
 351 <a name="methoddb_fetch_object" id="db_fetch_object"><!-- --></a>
 352 <div class="evenrow">
 353
 354         <div class="method-header">
 355                 <img src="../media/images/Method.png" />
 356                 <span class="method-title">db_fetch_object</span> (line <span class="line-number">191</span>)
 357         </div>
 358
 359         <!-- ========== Info from phpDoc block ========= -->
 360         <ul class="tags">
 361                                 <li><span class="field">access:</span> public</li>
 362                         </ul>
 363
 364         <div class="method-signature">
 365                 <span class="method-result">void</span>
 366                 <span class="method-name">
 367                         db_fetch_object
 368                 </span>
 369                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$resource</span>)
 370                         </div>
 371
 372                         <ul class="parameters">
 373                                         <li>
 374                                 <span class="var-type"></span>
 375                                 <span class="var-name">$resource</span>                 </li>
 376                                 </ul>
 377
 378
 379         </div>
 380 <a name="methoddb_getNumRows" id="db_getNumRows"><!-- --></a>
 381 <div class="oddrow">
 382
 383         <div class="method-header">
 384                 <img src="../media/images/Method.png" />
 385                 <span class="method-title">db_getNumRows</span> (line <span class="line-number">232</span>)
 386         </div>
 387
 388         <!-- ========== Info from phpDoc block ========= -->
 389 <p class="short-description">PHPFSPOT_DB number of affected rows</p>
 390 <p class="description"><p>This functions returns the number of affected rows but the  given SQL query.</p></p>
 391         <ul class="tags">
 392                                 <li><span class="field">access:</span> public</li>
 393                         </ul>
 394
 395         <div class="method-signature">
 396                 <span class="method-result">void</span>
 397                 <span class="method-name">
 398                         db_getNumRows
 399                 </span>
 400                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 401                         </div>
 402
 403                         <ul class="parameters">
 404                                         <li>
 405                                 <span class="var-type"></span>
 406                                 <span class="var-name">$query</span>                    </li>
 407                                 </ul>
 408
 409
 410         </div>
 411 <a name="methoddb_query" id="db_query"><!-- --></a>
 412 <div class="evenrow">
 413
 414         <div class="method-header">
 415                 <img src="../media/images/Method.png" />
 416                 <span class="method-title">db_query</span> (line <span class="line-number">128</span>)
 417         </div>
 418
 419         <!-- ========== Info from phpDoc block ========= -->
 420 <p class="short-description">PHPFSPOT_DB database query</p>
 421 <p class="description"><p>This function will execute a SQL query and return the result as  object.</p></p>
 422         <ul class="tags">
 423                                 <li><span class="field">access:</span> public</li>
 424                         </ul>
 425
 426         <div class="method-signature">
 427                 <span class="method-result">void</span>
 428                 <span class="method-name">
 429                         db_query
 430                 </span>
 431                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
 432                         </div>
 433
 434                         <ul class="parameters">
 435                                         <li>
 436                                 <span class="var-type"></span>
 437                                 <span class="var-name">$query</span>                    </li>
 438                                 </ul>
 439
 440
 441         </div>
 442 <a name="methoddb_rollback_transaction" id="db_rollback_transaction"><!-- --></a>
 443 <div class="oddrow">
 444
 445         <div class="method-header">
 446                 <img src="../media/images/Method.png" />
 447                 <span class="method-title">db_rollback_transaction</span> (line <span class="line-number">420</span>)
 448         </div>
 449
 450         <!-- ========== Info from phpDoc block ========= -->
 451 <p class="short-description">rollback transaction()</p>
 452 <p class="description"><p>this function aborts a on going transaction</p></p>
 453         <ul class="tags">
 454                                 <li><span class="field">access:</span> public</li>
 455                         </ul>
 456
 457         <div class="method-signature">
 458                 <span class="method-result">bool</span>
 459                 <span class="method-name">
 460                         db_rollback_transaction
 461                 </span>
 462                                 ()
 463                         </div>
 464
 465
 466
 467         </div>
 468 <a name="methoddb_start_transaction" id="db_start_transaction"><!-- --></a>
 469 <div class="evenrow">
 470
 471         <div class="method-header">
 472                 <img src="../media/images/Method.png" />
 473                 <span class="method-title">db_start_transaction</span> (line <span class="line-number">375</span>)
 474         </div>
 475
 476         <!-- ========== Info from phpDoc block ========= -->
 477 <p class="short-description">start transaction</p>
 478 <p class="description"><p>this will start a transaction on ACID-supporting database  systems.</p></p>
 479         <ul class="tags">
 480                                 <li><span class="field">access:</span> public</li>
 481                         </ul>
 482
 483         <div class="method-signature">
 484                 <span class="method-result">bool</span>
 485                 <span class="method-name">
 486                         db_start_transaction
 487                 </span>
 488                                 ()
 489                         </div>
 490
 491
 492
 493         </div>
 494
 495                 </div>
 496         </div>
 497
 498
 499         <p class="notes" id="credit">
 500                 Documentation generated on Sat, 30 May 2009 10:14:36 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 501         </p>
 502         </div></body>
 503 </html>