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">
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'/>
11 <div class="page-body">
12 <h2 class="class-name"><img src="../media/images/Class_logo.png"
15 style="vertical-align: middle"> PHPFSPOT_DB</h2>
17 <a name="sec-description"></a>
18 <div class="info-box">
19 <div class="info-box-title">Description</div>
21 <span class="disabled">Description</span> |
22 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">PHPFSPOT_DB class</p>
29 Located in <a class="field" href="_phpfspot_db.php.html">/phpfspot_db.php</a> (line <span class="field">30</span>)
41 <a name="sec-method-summary"></a>
42 <div class="info-box">
43 <div class="info-box-title">Method Summary</span></div>
45 <a href="#sec-description">Description</a> |
46 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
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> <span class="var-name">$parent</span>, <span class="var-type"></span> <span class="var-name">$db_path</span>)
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>
62 <div class="method-definition">
63 <img src="../media/images/Method.png" alt=" "/>
64 <span class="method-result">true</span>
65 <a href="#db_check_table_exists" title="details" class="method-name">db_check_table_exists</a>
66 ([<span class="var-type">string,</span> <span class="var-name">$table_name</span> = <span class="var-default">""</span>])
68 <div class="method-definition">
69 <img src="../media/images/Method.png" alt=" "/>
70 <span class="method-result">void</span>
71 <a href="#db_exec" title="details" class="method-name">db_exec</a>
72 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
74 <div class="method-definition">
75 <img src="../media/images/Method.png" alt=" "/>
76 <span class="method-result">void</span>
77 <a href="#db_fetchSingleRow" title="details" class="method-name">db_fetchSingleRow</a>
78 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
80 <div class="method-definition">
81 <img src="../media/images/Method.png" alt=" "/>
82 <span class="method-result">void</span>
83 <a href="#db_fetch_object" title="details" class="method-name">db_fetch_object</a>
84 (<span class="var-type"></span> <span class="var-name">$resource</span>)
86 <div class="method-definition">
87 <img src="../media/images/Method.png" alt=" "/>
88 <span class="method-result">void</span>
89 <a href="#db_getNumRows" title="details" class="method-name">db_getNumRows</a>
90 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
92 <div class="method-definition">
93 <img src="../media/images/Method.png" alt=" "/>
94 <span class="method-result">void</span>
95 <a href="#db_query" title="details" class="method-name">db_query</a>
96 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
103 <a name="sec-methods"></a>
104 <div class="info-box">
105 <div class="info-box-title">Methods</div>
106 <div class="nav-bar">
107 <a href="#sec-description">Description</a> |
108 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
111 <div class="info-box-body">
112 <A NAME='method_detail'></A>
113 <a name="method__construct" id="__construct"><!-- --></a>
114 <div class="evenrow">
116 <div class="method-header">
117 <img src="../media/images/Constructor.png" />
118 <span class="method-title">Constructor __construct</span> (line <span class="line-number">44</span>)
121 <!-- ========== Info from phpDoc block ========= -->
122 <p class="short-description">PHPFSPOT_DB class constructor</p>
123 <p class="description"><p>This constructor initially connect to the database.</p></p>
125 <li><span class="field">access:</span> public</li>
128 <div class="method-signature">
129 <span class="method-result">PHPFSPOT_DB</span>
130 <span class="method-name">
133 (<span class="var-type"></span> <span class="var-name">$parent</span>, <span class="var-type"></span> <span class="var-name">$db_path</span>)
136 <ul class="parameters">
138 <span class="var-type"></span>
139 <span class="var-name">$parent</span> </li>
141 <span class="var-type"></span>
142 <span class="var-name">$db_path</span> </li>
147 <a name="method__destruct" id="__destruct"><!-- --></a>
150 <div class="method-header">
151 <img src="../media/images/Destructor.png" />
152 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">64</span>)
155 <!-- ========== Info from phpDoc block ========= -->
156 <p class="short-description">PHPFSPOT_DB class deconstructor</p>
157 <p class="description"><p>This destructor will close the current database connection.</p></p>
159 <li><span class="field">access:</span> public</li>
162 <div class="method-signature">
163 <span class="method-result">void</span>
164 <span class="method-name">
173 <a name="methoddb_check_table_exists" id="db_check_table_exists"><!-- --></a>
174 <div class="evenrow">
176 <div class="method-header">
177 <img src="../media/images/Method.png" />
178 <span class="method-title">db_check_table_exists</span> (line <span class="line-number">254</span>)
181 <!-- ========== Info from phpDoc block ========= -->
182 <p class="short-description">PHPFSPOT_DB check table exists</p>
183 <p class="description"><p>This function checks if the given table exists in the database</p></p>
185 <li><span class="field">return:</span> if table found otherwise false</li>
186 <li><span class="field">access:</span> public</li>
189 <div class="method-signature">
190 <span class="method-result">true</span>
191 <span class="method-name">
192 db_check_table_exists
194 ([<span class="var-type">string,</span> <span class="var-name">$table_name</span> = <span class="var-default">""</span>])
197 <ul class="parameters">
199 <span class="var-type">string,</span>
200 <span class="var-name">$table_name</span><span class="var-description">: table name</span> </li>
205 <a name="methoddb_exec" id="db_exec"><!-- --></a>
208 <div class="method-header">
209 <img src="../media/images/Method.png" />
210 <span class="method-title">db_exec</span> (line <span class="line-number">164</span>)
213 <!-- ========== Info from phpDoc block ========= -->
214 <p class="short-description">PHPFSPOT_DB database query & execute</p>
215 <p class="description"><p>This function will execute a SQL query and return nothing.</p></p>
217 <li><span class="field">access:</span> public</li>
220 <div class="method-signature">
221 <span class="method-result">void</span>
222 <span class="method-name">
225 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
228 <ul class="parameters">
230 <span class="var-type"></span>
231 <span class="var-name">$query</span> </li>
236 <a name="methoddb_fetchSingleRow" id="db_fetchSingleRow"><!-- --></a>
237 <div class="evenrow">
239 <div class="method-header">
240 <img src="../media/images/Method.png" />
241 <span class="method-title">db_fetchSingleRow</span> (line <span class="line-number">207</span>)
244 <!-- ========== Info from phpDoc block ========= -->
245 <p class="short-description">PHPFSPOT_DB fetch ONE row</p>
246 <p class="description"><p>This function will execute the given but only return the first result.</p></p>
248 <li><span class="field">access:</span> public</li>
251 <div class="method-signature">
252 <span class="method-result">void</span>
253 <span class="method-name">
256 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
259 <ul class="parameters">
261 <span class="var-type"></span>
262 <span class="var-name">$query</span> </li>
267 <a name="methoddb_fetch_object" id="db_fetch_object"><!-- --></a>
270 <div class="method-header">
271 <img src="../media/images/Method.png" />
272 <span class="method-title">db_fetch_object</span> (line <span class="line-number">190</span>)
275 <!-- ========== Info from phpDoc block ========= -->
277 <li><span class="field">access:</span> public</li>
280 <div class="method-signature">
281 <span class="method-result">void</span>
282 <span class="method-name">
285 (<span class="var-type"></span> <span class="var-name">$resource</span>)
288 <ul class="parameters">
290 <span class="var-type"></span>
291 <span class="var-name">$resource</span> </li>
296 <a name="methoddb_getNumRows" id="db_getNumRows"><!-- --></a>
297 <div class="evenrow">
299 <div class="method-header">
300 <img src="../media/images/Method.png" />
301 <span class="method-title">db_getNumRows</span> (line <span class="line-number">233</span>)
304 <!-- ========== Info from phpDoc block ========= -->
305 <p class="short-description">PHPFSPOT_DB number of affected rows</p>
306 <p class="description"><p>This functions returns the number of affected rows but the given SQL query.</p></p>
308 <li><span class="field">access:</span> public</li>
311 <div class="method-signature">
312 <span class="method-result">void</span>
313 <span class="method-name">
316 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
319 <ul class="parameters">
321 <span class="var-type"></span>
322 <span class="var-name">$query</span> </li>
327 <a name="methoddb_query" id="db_query"><!-- --></a>
330 <div class="method-header">
331 <img src="../media/images/Method.png" />
332 <span class="method-title">db_query</span> (line <span class="line-number">128</span>)
335 <!-- ========== Info from phpDoc block ========= -->
336 <p class="short-description">PHPFSPOT_DB database query</p>
337 <p class="description"><p>This function will execute a SQL query and return the result as object.</p></p>
339 <li><span class="field">access:</span> public</li>
342 <div class="method-signature">
343 <span class="method-result">void</span>
344 <span class="method-name">
347 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
350 <ul class="parameters">
352 <span class="var-type"></span>
353 <span class="var-name">$query</span> </li>
363 <p class="notes" id="credit">
364 Documentation generated on Sun, 25 May 2008 10:46:40 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>