<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title>Docs For Class PHPFSPOT_DB</title> <link rel="stylesheet" href="../media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="class-name"><img src="../media/images/Class_logo.png" alt=" Class" title=" Class" style="vertical-align: middle"> PHPFSPOT_DB</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB class</p> <p class="notes"> Located in <a class="field" href="_phpfspot_db.php.html">/phpfspot_db.php</a> (line <span class="field">29</span>) </p> <pre></pre> </div> </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> <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> (<span class="var-type"></span> <span class="var-name">$parent</span>, <span class="var-type"></span> <span class="var-name">$db_path</span>) </div> <div class="method-definition"> <img src="../media/images/Destructor.png" alt=" "/> <span class="method-result">void</span> <a href="#__destruct" title="details" class="method-name">__destruct</a> () </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> <span class="var-name">$table_name</span> = <span class="var-default">""</span>]) </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> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> <span class="method-result">void</span> <a href="#db_fetchSingleRow" title="details" class="method-name">db_fetchSingleRow</a> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> <span class="method-result">void</span> <a href="#db_fetch_object" title="details" class="method-name">db_fetch_object</a> (<span class="var-type"></span> <span class="var-name">$resource</span>) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> <span class="method-result">void</span> <a href="#db_getNumRows" title="details" class="method-name">db_getNumRows</a> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> <span class="method-result">void</span> <a href="#db_query" title="details" class="method-name">db_query</a> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> </div> </div> </div> <a name="sec-methods"></a> <div class="info-box"> <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> <div class="info-box-body"> <A NAME='method_detail'></A> <a name="method__construct" id="__construct"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../media/images/Constructor.png" /> <span class="method-title">Constructor __construct</span> (line <span class="line-number">43</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB class constructor</p> <p class="description"><p>This constructor initially connect to the database.</p></p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">PHPFSPOT_DB</span> <span class="method-name"> __construct </span> (<span class="var-type"></span> <span class="var-name">$parent</span>, <span class="var-type"></span> <span class="var-name">$db_path</span>) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$parent</span> </li> <li> <span class="var-type"></span> <span class="var-name">$db_path</span> </li> </ul> </div> <a name="method__destruct" id="__destruct"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../media/images/Destructor.png" /> <span class="method-title">Destructor __destruct</span> (line <span class="line-number">63</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB class deconstructor</p> <p class="description"><p>This destructor will close the current database connection.</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"> __destruct </span> () </div> </div> <a name="methoddb_check_table_exists" id="db_check_table_exists"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../media/images/Method.png" /> <span class="method-title">db_check_table_exists</span> (line <span class="line-number">253</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB check table exists</p> <p class="description"><p>This function checks if the given table exists in the database</p></p> <ul class="tags"> <li><span class="field">return:</span> if table found otherwise false</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">true</span> <span class="method-name"> db_check_table_exists </span> ([<span class="var-type">string,</span> <span class="var-name">$table_name</span> = <span class="var-default">""</span>]) </div> <ul class="parameters"> <li> <span class="var-type">string,</span> <span class="var-name">$table_name</span><span class="var-description">: table name</span> </li> </ul> </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">163</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB database query & execute</p> <p class="description"><p>This function will execute a SQL query and return nothing.</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_exec </span> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$query</span> </li> </ul> </div> <a name="methoddb_fetchSingleRow" id="db_fetchSingleRow"><!-- --></a> <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">206</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB fetch ONE row</p> <p class="description"><p>This function will execute the given but only return the first result.</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_fetchSingleRow </span> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$query</span> </li> </ul> </div> <a name="methoddb_fetch_object" id="db_fetch_object"><!-- --></a> <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">189</span>) </div> <!-- ========== Info from phpDoc block ========= --> <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_fetch_object </span> (<span class="var-type"></span> <span class="var-name">$resource</span>) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$resource</span> </li> </ul> </div> <a name="methoddb_getNumRows" id="db_getNumRows"><!-- --></a> <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">232</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB number of affected rows</p> <p class="description"><p>This functions returns the number of affected rows but the given SQL query.</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_getNumRows </span> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$query</span> </li> </ul> </div> <a name="methoddb_query" id="db_query"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> <span class="method-title">db_query</span> (line <span class="line-number">127</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">PHPFSPOT_DB database query</p> <p class="description"><p>This function will execute a SQL query and return the result as object.</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_query </span> ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>]) </div> <ul class="parameters"> <li> <span class="var-type"></span> <span class="var-name">$query</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Sat, 12 Apr 2008 18:25:06 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html>