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">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> <span class="var-name">$table_name</span>, <span class="var-type"></span> <span class="var-name">$column</span>)
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> <span class="var-name">$table_name</span> = <span class="var-default">""</span>])
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>
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> <span class="var-name">$query</span> = <span class="var-default">""</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_fetchSingleRow" title="details" class="method-name">db_fetchSingleRow</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_fetch_object" title="details" class="method-name">db_fetch_object</a>
96 (<span class="var-type"></span> <span class="var-name">$resource</span>)
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> <span class="var-name">$query</span> = <span class="var-default">""</span>])
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> <span class="var-name">$query</span> = <span class="var-default">""</span>])
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>
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>
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>)
135 <div class="info-box-body">
136 <A NAME='method_detail'></A>
137 <a name="method__construct" id="__construct"><!-- --></a>
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>)
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>
149 <li><span class="field">access:</span> public</li>
152 <div class="method-signature">
153 <span class="method-result">PHPFSPOT_DB</span>
154 <span class="method-name">
157 (<span class="var-type"></span> <span class="var-name">$parent</span>, <span class="var-type"></span> <span class="var-name">$db_path</span>)
160 <ul class="parameters">
162 <span class="var-type"></span>
163 <span class="var-name">$parent</span> </li>
165 <span class="var-type"></span>
166 <span class="var-name">$db_path</span> </li>
171 <a name="method__destruct" id="__destruct"><!-- --></a>
172 <div class="evenrow">
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>)
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>
183 <li><span class="field">access:</span> public</li>
186 <div class="method-signature">
187 <span class="method-result">void</span>
188 <span class="method-name">
197 <a name="methoddb_check_column_exists" id="db_check_column_exists"><!-- --></a>
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>)
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>
209 <li><span class="field">access:</span> public</li>
212 <div class="method-signature">
213 <span class="method-result">void</span>
214 <span class="method-name">
215 db_check_column_exists
217 (<span class="var-type"></span> <span class="var-name">$table_name</span>, <span class="var-type"></span> <span class="var-name">$column</span>)
220 <ul class="parameters">
222 <span class="var-type"></span>
223 <span class="var-name">$table_name</span> </li>
225 <span class="var-type"></span>
226 <span class="var-name">$column</span> </li>
231 <a name="methoddb_check_table_exists" id="db_check_table_exists"><!-- --></a>
232 <div class="evenrow">
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>)
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>
243 <li><span class="field">return:</span> if table found otherwise false</li>
244 <li><span class="field">access:</span> public</li>
247 <div class="method-signature">
248 <span class="method-result">true</span>
249 <span class="method-name">
250 db_check_table_exists
252 ([<span class="var-type">string,</span> <span class="var-name">$table_name</span> = <span class="var-default">""</span>])
255 <ul class="parameters">
257 <span class="var-type">string,</span>
258 <span class="var-name">$table_name</span><span class="var-description">: table name</span> </li>
263 <a name="methoddb_commit_transaction" id="db_commit_transaction"><!-- --></a>
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>)
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>
275 <li><span class="field">access:</span> public</li>
278 <div class="method-signature">
279 <span class="method-result">bool</span>
280 <span class="method-name">
281 db_commit_transaction
289 <a name="methoddb_exec" id="db_exec"><!-- --></a>
290 <div class="evenrow">
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>)
297 <!-- ========== Info from phpDoc block ========= -->
298 <p class="short-description">PHPFSPOT_DB database query & execute</p>
299 <p class="description"><p>This function will execute a SQL query and return nothing.</p></p>
301 <li><span class="field">access:</span> public</li>
304 <div class="method-signature">
305 <span class="method-result">void</span>
306 <span class="method-name">
309 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
312 <ul class="parameters">
314 <span class="var-type"></span>
315 <span class="var-name">$query</span> </li>
320 <a name="methoddb_fetchSingleRow" id="db_fetchSingleRow"><!-- --></a>
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>)
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>
332 <li><span class="field">access:</span> public</li>
335 <div class="method-signature">
336 <span class="method-result">void</span>
337 <span class="method-name">
340 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
343 <ul class="parameters">
345 <span class="var-type"></span>
346 <span class="var-name">$query</span> </li>
351 <a name="methoddb_fetch_object" id="db_fetch_object"><!-- --></a>
352 <div class="evenrow">
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>)
359 <!-- ========== Info from phpDoc block ========= -->
361 <li><span class="field">access:</span> public</li>
364 <div class="method-signature">
365 <span class="method-result">void</span>
366 <span class="method-name">
369 (<span class="var-type"></span> <span class="var-name">$resource</span>)
372 <ul class="parameters">
374 <span class="var-type"></span>
375 <span class="var-name">$resource</span> </li>
380 <a name="methoddb_getNumRows" id="db_getNumRows"><!-- --></a>
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>)
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>
392 <li><span class="field">access:</span> public</li>
395 <div class="method-signature">
396 <span class="method-result">void</span>
397 <span class="method-name">
400 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
403 <ul class="parameters">
405 <span class="var-type"></span>
406 <span class="var-name">$query</span> </li>
411 <a name="methoddb_query" id="db_query"><!-- --></a>
412 <div class="evenrow">
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>)
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>
423 <li><span class="field">access:</span> public</li>
426 <div class="method-signature">
427 <span class="method-result">void</span>
428 <span class="method-name">
431 ([<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">""</span>])
434 <ul class="parameters">
436 <span class="var-type"></span>
437 <span class="var-name">$query</span> </li>
442 <a name="methoddb_rollback_transaction" id="db_rollback_transaction"><!-- --></a>
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>)
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>
454 <li><span class="field">access:</span> public</li>
457 <div class="method-signature">
458 <span class="method-result">bool</span>
459 <span class="method-name">
460 db_rollback_transaction
468 <a name="methoddb_start_transaction" id="db_start_transaction"><!-- --></a>
469 <div class="evenrow">
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>)
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>
480 <li><span class="field">access:</span> public</li>
483 <div class="method-signature">
484 <span class="method-result">bool</span>
485 <span class="method-name">
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>