update docs for 1.7 release

[phpfspot.git] / docs / phpfspot / PHPFSPOT_DB.html

diff --git a/docs/phpfspot/PHPFSPOT_DB.html b/docs/phpfspot/PHPFSPOT_DB.html
index d552e999bea20846365d60f77584e769800e0068..7344507bde64c09cc1706218382c3b4be33ca301 100644 (file)
--- a/docs/phpfspot/PHPFSPOT_DB.html
+++ b/docs/phpfspot/PHPFSPOT_DB.html
@@ -47,7 +47,7 @@
                </div>
                <div class="info-box-body">                     
                        <div class="method-summary">
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               <div class="method-definition">
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Constructor.png" alt=" "/>
                                                                                        <span class="method-result">PHPFSPOT_DB</span>
                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
@@ -60,12 +60,24 @@
                                                                                ()
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">void</span>
+                                                                               <a href="#db_check_column_exists" title="details" class="method-name">db_check_column_exists</a>
+                                                                                       (<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>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">true</span>
                                                                                <a href="#db_check_table_exists" title="details" class="method-name">db_check_table_exists</a>
                                                                                        ([<span class="var-type">string,</span>&nbsp;<span class="var-name">$table_name</span> = <span class="var-default">&quot;&quot;</span>])
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">bool</span>
+                                                                               <a href="#db_commit_transaction" title="details" class="method-name">db_commit_transaction</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#db_exec" title="details" class="method-name">db_exec</a>
@@ -94,6 +106,18 @@
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#db_query" title="details" class="method-name">db_query</a>
                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$query</span> = <span class="var-default">&quot;&quot;</span>])
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">bool</span>
+                                                                               <a href="#db_rollback_transaction" title="details" class="method-name">db_rollback_transaction</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">bool</span>
+                                                                               <a href="#db_start_transaction" title="details" class="method-name">db_start_transaction</a>
+                                                                               ()
                                                                        </div>
                                                                                        </div>
                </div>
@@ -111,7 +135,7 @@
                <div class="info-box-body">
                        <A NAME='method_detail'></A>
 <a name="method__construct" id="__construct"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Constructor.png" />
@@ -145,7 +169,7 @@
                        
        </div>
 <a name="method__destruct" id="__destruct"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Destructor.png" />
@@ -169,13 +193,47 @@
        
                
                        
+       </div>
+<a name="methoddb_check_column_exists" id="db_check_column_exists"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">db_check_column_exists</span> (line <span class="line-number">284</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">PHPFSPOT_DB check column exist</p>
+<p class="description"><p>This function checks if the given column exists within  the specified table.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">void</span>
+               <span class="method-name">
+                       db_check_column_exists
+               </span>
+                                       (<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>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$table_name</span>                       </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$column</span>                   </li>
+                               </ul>
+               
+                       
        </div>
 <a name="methoddb_check_table_exists" id="db_check_table_exists"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">db_check_table_exists</span> (line <span class="line-number">254</span>)
+               <span class="method-title">db_check_table_exists</span> (line <span class="line-number">253</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
@@ -202,12 +260,38 @@
                
                        
        </div>
-<a name="methoddb_exec" id="db_exec"><!-- --></a>
+<a name="methoddb_commit_transaction" id="db_commit_transaction"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">db_exec</span> (line <span class="line-number">164</span>)
+               <span class="method-title">db_commit_transaction</span> (line <span class="line-number">398</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">commit transaction</p>
+<p class="description"><p>this will commit an ongoing transaction on ACID-supporting  database systems</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">bool</span>
+               <span class="method-name">
+                       db_commit_transaction
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methoddb_exec" id="db_exec"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">db_exec</span> (line <span class="line-number">162</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
@@ -234,11 +318,11 @@
                        
        </div>
 <a name="methoddb_fetchSingleRow" id="db_fetchSingleRow"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">db_fetchSingleRow</span> (line <span class="line-number">207</span>)
+               <span class="method-title">db_fetchSingleRow</span> (line <span class="line-number">208</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
@@ -265,11 +349,11 @@
                        
        </div>
 <a name="methoddb_fetch_object" id="db_fetch_object"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">db_fetch_object</span> (line <span class="line-number">190</span>)
+               <span class="method-title">db_fetch_object</span> (line <span class="line-number">191</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
@@ -294,11 +378,11 @@
                        
        </div>
 <a name="methoddb_getNumRows" id="db_getNumRows"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">db_getNumRows</span> (line <span class="line-number">233</span>)
+               <span class="method-title">db_getNumRows</span> (line <span class="line-number">232</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
@@ -325,7 +409,7 @@
                        
        </div>
 <a name="methoddb_query" id="db_query"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
@@ -354,6 +438,58 @@
                                </ul>
                
                        
+       </div>
+<a name="methoddb_rollback_transaction" id="db_rollback_transaction"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">db_rollback_transaction</span> (line <span class="line-number">420</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">rollback transaction()</p>
+<p class="description"><p>this function aborts a on going transaction</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">bool</span>
+               <span class="method-name">
+                       db_rollback_transaction
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methoddb_start_transaction" id="db_start_transaction"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">db_start_transaction</span> (line <span class="line-number">375</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">start transaction</p>
+<p class="description"><p>this will start a transaction on ACID-supporting database  systems.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">bool</span>
+               <span class="method-name">
+                       db_start_transaction
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
        </div>
                                                
                </div>
@@ -361,7 +497,7 @@
 
        
        <p class="notes" id="credit">
-               Documentation generated on Wed, 02 Jul 2008 20:41:02 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+               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>
        </p>
        </div></body>
 </html>
\ No newline at end of file