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 PHPDS_PDOconnector</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">Class PHPDS_PDOconnector</h2>
14
<a name="sec-description"></a>
15
<div class="info-box">
16
<div class="info-box-title">Description</div>
18
<span class="disabled">Description</span> |
19
<a href="#sec-vars">Vars</a>
20
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
<div class="info-box-body">
24
<p class="implements">
25
Implements interfaces:
27
<li><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html">PHPDS_dbConnector</a></li> </ul>
29
<!-- ========== Info from phpDoc block ========= -->
30
<p class="short-description">This is a base class for PHPDS subsystems</p>
31
<p class="description"><p>It allows dependency injection and dependency fetching; also mimics multiple inheritance</p></p>
33
<li><span class="field">author:</span> greg</li>
34
<li><span class="field">version:</span> 1.0.2 (greg)</li>
37
Located in <a class="field" href="_PHPDS_dbConnector.class.php.html">/PHPDS_dbConnector.class.php</a> (line <span class="field">51</span>)
41
<pre><a href="../../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a>
43
--PHPDS_PDOconnector</pre>
51
<a name="sec-method-summary"></a>
52
<div class="info-box">
53
<div class="info-box-title">Method Summary</span></div>
55
<a href="#sec-description">Description</a> |
56
<a href="#sec-vars">Vars</a>
59
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
61
<div class="info-box-body">
62
<div class="method-summary">
64
<div class="method-definition">
65
<span class="method-result">nothing</span>
66
<a href="#__construct" title="details" class="method-name">__construct</a>
67
(<span class="var-type"></span> <span class="var-name">$dependance</span>, <span class="var-type">object</span> <span class="var-name">$db</span>)
69
<div class="method-definition">
70
<span class="method-result">integer,</span>
71
<a href="#affectedRows" title="details" class="method-name">affectedRows</a>
74
<div class="method-definition">
75
<span class="method-result">void</span>
76
<a href="#connect" title="details" class="method-name">connect</a>
79
<div class="method-definition">
80
<span class="method-result">debug</span>
81
<a href="#debugInstance" title="details" class="method-name">debugInstance</a>
82
([<span class="var-type"></span> <span class="var-name">$ignored</span> = <span class="var-default">null</span>])
84
<div class="method-definition">
85
<span class="method-result">void</span>
86
<a href="#endTransaction" title="details" class="method-name">endTransaction</a>
87
([<span class="var-type"><type></span> <span class="var-name">$commit</span> = <span class="var-default">true</span>])
89
<div class="method-definition">
90
<span class="method-result">array,</span>
91
<a href="#fetchAssoc" title="details" class="method-name">fetchAssoc</a>
94
<div class="method-definition">
95
<span class="method-result">boolean,</span>
96
<a href="#free" title="details" class="method-name">free</a>
99
<div class="method-definition">
100
<span class="method-result">int</span>
101
<a href="#lastId" title="details" class="method-name">lastId</a>
104
<div class="method-definition">
105
<span class="method-result">integer,</span>
106
<a href="#numrows" title="details" class="method-name">numrows</a>
109
<div class="method-definition">
110
<span class="method-result">string,</span>
111
<a href="#protect" title="details" class="method-name">protect</a>
112
(<span class="var-type">$param</span> <span class="var-name">$param</span>)
114
<div class="method-definition">
115
<span class="method-result">php</span>
116
<a href="#query" title="details" class="method-name">query</a>
117
(<span class="var-type">$sql</span> <span class="var-name">$sql</span>)
119
<div class="method-definition">
120
<span class="method-result">string</span>
121
<a href="#returnSqlError" title="details" class="method-name">returnSqlError</a>
122
(<span class="var-type">string</span> <span class="var-name">$query</span>)
124
<div class="method-definition">
125
<span class="method-result">string</span>
126
<a href="#rowResults" title="details" class="method-name">rowResults</a>
127
([<span class="var-type"></span> <span class="var-name">$row</span> = <span class="var-default">0</span>])
129
<div class="method-definition">
130
<span class="method-result">boolean,</span>
131
<a href="#seek" title="details" class="method-name">seek</a>
132
(<span class="var-type">$row_number</span> <span class="var-name">$row_number</span>)
134
<div class="method-definition">
135
<span class="method-result">void</span>
136
<a href="#startTransaction" title="details" class="method-name">startTransaction</a>
143
<a name="sec-vars"></a>
144
<div class="info-box">
145
<div class="info-box-title">Variables</div>
146
<div class="nav-bar">
147
<a href="#sec-description">Description</a> |
148
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
152
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
155
<div class="info-box-body">
156
<h4>Inherited Variables</h4>
157
<A NAME='inherited_vars'><!-- --></A>
158
<p>Inherited from <span class="classname"><a href="../../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a></span></p>
160
<span class="var-title">
161
<span class="var-name"><a href="../../PHPDevShell/PHPDS_dependant.html#var$dependance">PHPDS_dependant::$dependance</a></span><br>
163
<span class="var-title">
164
<span class="var-name"><a href="../../PHPDevShell/PHPDS_dependant.html#var$parent">PHPDS_dependant::$parent</a></span><br>
171
<a name="sec-methods"></a>
172
<div class="info-box">
173
<div class="info-box-title">Methods</div>
174
<div class="nav-bar">
175
<a href="#sec-description">Description</a> |
176
<a href="#sec-vars">Vars</a>
177
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
180
<div class="info-box-body">
181
<A NAME='method_detail'></A>
183
<a name="method__construct" id="__construct"><!-- --></a>
186
<div class="method-header">
187
<span class="method-title">Constructor __construct</span> (line <span class="line-number">69</span>)
190
<!-- ========== Info from phpDoc block ========= -->
191
<p class="short-description">Dependence constructor.</p>
193
<li><span class="field">access:</span> public</li>
196
<div class="method-signature">
197
<span class="method-result">nothing</span>
198
<span class="method-name">
201
(<span class="var-type"></span> <span class="var-name">$dependance</span>, <span class="var-type">object</span> <span class="var-name">$db</span>)
204
<ul class="parameters">
206
<span class="var-type">object</span>
207
<span class="var-name">$db</span><span class="var-description">: the main db object</span> </li>
209
<span class="var-type"></span>
210
<span class="var-name">$dependance</span> </li>
213
<hr class="separator" />
214
<div class="notes">Redefinition of:</div>
216
<dt><a href="../../PHPDevShell/PHPDS_dependant.html#method__construct">PHPDS_dependant::__construct()</a></dt>
217
<dd>magic constructor</dd>
221
<a name="methodaffectedRows" id="affectedRows"><!-- --></a>
222
<div class="evenrow">
224
<div class="method-header">
225
<span class="method-title">affectedRows</span> (line <span class="line-number">225</span>)
228
<!-- ========== Info from phpDoc block ========= -->
229
<p class="short-description">Return the number of affected rows in the result of the query</p>
231
<li><span class="field">return:</span> the number of affected rows</li>
232
<li><span class="field">author:</span> Jason</li>
233
<li><span class="field">version:</span> 1.0</li>
234
<li><span class="field">see:</span> affectedRows()</li>
235
<li><span class="field">date:</span> 20101103</li>
236
<li><span class="field">access:</span> public</li>
239
<div class="method-signature">
240
<span class="method-result">integer,</span>
241
<span class="method-name">
248
<hr class="separator" />
249
<div class="notes">Implementation of:</div>
251
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodaffectedRows">PHPDS_dbConnector::affectedRows()</a></dt>
255
<a name="methodconnect" id="connect"><!-- --></a>
258
<div class="method-header">
259
<span class="method-title">connect</span> (line <span class="line-number">96</span>)
262
<!-- ========== Info from phpDoc block ========= -->
263
<p class="short-description">Connect to the database server (compatibility method)</p>
265
<li><span class="field">author:</span> greg</li>
266
<li><span class="field">version:</span> 1.0</li>
267
<li><span class="field">see:</span> connect()</li>
268
<li><span class="field">date:</span> 20100219</li>
269
<li><span class="field">access:</span> public</li>
272
<div class="method-signature">
273
<span class="method-result">void</span>
274
<span class="method-name">
281
<hr class="separator" />
282
<div class="notes">Implementation of:</div>
284
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodconnect">PHPDS_dbConnector::connect()</a></dt>
288
<a name="methoddebugInstance" id="debugInstance"><!-- --></a>
289
<div class="evenrow">
291
<div class="method-header">
292
<span class="method-title">debugInstance</span> (line <span class="line-number">255</span>)
295
<!-- ========== Info from phpDoc block ========= -->
296
<p class="short-description">Debugging Instance.</p>
298
<li><span class="field">return:</span> object</li>
299
<li><span class="field">access:</span> public</li>
302
<div class="method-signature">
303
<span class="method-result">debug</span>
304
<span class="method-name">
307
([<span class="var-type"></span> <span class="var-name">$ignored</span> = <span class="var-default">null</span>])
310
<ul class="parameters">
312
<span class="var-type"></span>
313
<span class="var-name">$ignored</span> </li>
316
<hr class="separator" />
317
<div class="notes">Redefinition of:</div>
319
<dt><a href="../../PHPDevShell/PHPDS_dependant.html#methoddebugInstance">PHPDS_dependant::debugInstance()</a></dt>
320
<dd>Create instance of PHPDS_debug.</dd>
324
<a name="methodendTransaction" id="endTransaction"><!-- --></a>
327
<div class="method-header">
328
<span class="method-title">endTransaction</span> (line <span class="line-number">299</span>)
331
<!-- ========== Info from phpDoc block ========= -->
332
<p class="short-description">Ends SQL transaction.</p>
334
<li><span class="field">access:</span> public</li>
337
<div class="method-signature">
338
<span class="method-result">void</span>
339
<span class="method-name">
342
([<span class="var-type"><type></span> <span class="var-name">$commit</span> = <span class="var-default">true</span>])
345
<ul class="parameters">
347
<span class="var-type"><type></span>
348
<span class="var-name">$commit</span> </li>
351
<hr class="separator" />
352
<div class="notes">Implementation of:</div>
354
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodendTransaction">PHPDS_dbConnector::endTransaction()</a></dt>
358
<a name="methodfetchAssoc" id="fetchAssoc"><!-- --></a>
359
<div class="evenrow">
361
<div class="method-header">
362
<span class="method-title">fetchAssoc</span> (line <span class="line-number">179</span>)
365
<!-- ========== Info from phpDoc block ========= -->
366
<p class="short-description">Return the next line as an associative array</p>
368
<li><span class="field">return:</span> the resulting line (or false is nothing is found)</li>
369
<li><span class="field">author:</span> greg</li>
370
<li><span class="field">version:</span> 1.0</li>
371
<li><span class="field">see:</span> fetch_assoc()</li>
372
<li><span class="field">date:</span> 20100216</li>
373
<li><span class="field">access:</span> public</li>
376
<div class="method-signature">
377
<span class="method-result">array,</span>
378
<span class="method-name">
385
<hr class="separator" />
386
<div class="notes">Implementation of:</div>
388
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodfetchAssoc">PHPDS_dbConnector::fetchAssoc()</a></dt>
392
<a name="methodfree" id="free"><!-- --></a>
395
<div class="method-header">
396
<span class="method-title">free</span> (line <span class="line-number">80</span>)
399
<!-- ========== Info from phpDoc block ========= -->
400
<p class="short-description">Clears the current connection (useful for example if we're fetching one row at a time and we give up before the end)</p>
402
<li><span class="field">return:</span> TRUE on success or FALSE on failure</li>
403
<li><span class="field">see:</span> free()</li>
404
<li><span class="field">access:</span> public</li>
407
<div class="method-signature">
408
<span class="method-result">boolean,</span>
409
<span class="method-name">
416
<hr class="separator" />
417
<div class="notes">Implementation of:</div>
419
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodfree">PHPDS_dbConnector::free()</a></dt>
423
<a name="methodlastId" id="lastId"><!-- --></a>
424
<div class="evenrow">
426
<div class="method-header">
427
<span class="method-title">lastId</span> (line <span class="line-number">268</span>)
430
<!-- ========== Info from phpDoc block ========= -->
431
<p class="short-description">Simply returns last inserted id from database.</p>
433
<li><span class="field">author:</span> jason</li>
434
<li><span class="field">version:</span> 1.0.1</li>
435
<li><span class="field">date:</span> 20100610 (greg) (v1.0.1) added $this->link</li>
436
<li><span class="field">access:</span> public</li>
439
<div class="method-signature">
440
<span class="method-result">int</span>
441
<span class="method-name">
448
<hr class="separator" />
449
<div class="notes">Implementation of:</div>
451
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodlastId">PHPDS_dbConnector::lastId()</a></dt>
455
<a name="methodnumrows" id="numrows"><!-- --></a>
458
<div class="method-header">
459
<span class="method-title">numrows</span> (line <span class="line-number">210</span>)
462
<!-- ========== Info from phpDoc block ========= -->
463
<p class="short-description">Return the number of rows in the result of the query</p>
465
<li><span class="field">return:</span> the number of rows</li>
466
<li><span class="field">author:</span> greg</li>
467
<li><span class="field">version:</span> 1.0</li>
468
<li><span class="field">see:</span> numrows()</li>
469
<li><span class="field">date:</span> 20100216</li>
470
<li><span class="field">access:</span> public</li>
473
<div class="method-signature">
474
<span class="method-result">integer,</span>
475
<span class="method-name">
482
<hr class="separator" />
483
<div class="notes">Implementation of:</div>
485
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodnumrows">PHPDS_dbConnector::numrows()</a></dt>
489
<a name="methodprotect" id="protect"><!-- --></a>
490
<div class="evenrow">
492
<div class="method-header">
493
<span class="method-title">protect</span> (line <span class="line-number">165</span>)
496
<!-- ========== Info from phpDoc block ========= -->
497
<p class="short-description">Protect a single string from possible hacker (i.e. escape possible harmfull chars)</p>
499
<li><span class="field">return:</span> the escaped string</li>
500
<li><span class="field">author:</span> greg</li>
501
<li><span class="field">version:</span> 1.0</li>
502
<li><span class="field">see:</span> protect()</li>
503
<li><span class="field">date:</span> 20100216</li>
504
<li><span class="field">access:</span> public</li>
507
<div class="method-signature">
508
<span class="method-result">string,</span>
509
<span class="method-name">
512
(<span class="var-type">$param</span> <span class="var-name">$param</span>)
515
<ul class="parameters">
517
<span class="var-type">$param</span>
518
<span class="var-name">$param</span><span class="var-description">: string, the parameter to espace</span> </li>
521
<hr class="separator" />
522
<div class="notes">Implementation of:</div>
524
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodprotect">PHPDS_dbConnector::protect()</a></dt>
528
<a name="methodquery" id="query"><!-- --></a>
531
<div class="method-header">
532
<span class="method-title">query</span> (line <span class="line-number">126</span>)
535
<!-- ========== Info from phpDoc block ========= -->
536
<p class="short-description">Actually send the query to MySQL (through $db)</p>
538
<li><span class="field">return:</span> resource the resulting resource (or false is something bad happened)</li>
539
<li><span class="field">author:</span> greg</li>
540
<li><span class="field">version:</span> 2.0.2</li>
541
<li><span class="field">see:</span> query()</li>
542
<li><span class="field">date:</span> 20100219</li>
543
<li><span class="field">date:</span> 20100305 2.0.1 : fixed a bug with the _db_ prefix subsitution</li>
544
<li><span class="field">date:</span> 20100729 (greg) (2.0.2) throw error</li>
545
<li><span class="field">access:</span> public</li>
548
<div class="method-signature">
549
<span class="method-result">php</span>
550
<span class="method-name">
553
(<span class="var-type">$sql</span> <span class="var-name">$sql</span>)
556
<ul class="parameters">
558
<span class="var-type">$sql</span>
559
<span class="var-name">$sql</span><span class="var-description">: string, the actual sql query</span> </li>
562
<hr class="separator" />
563
<div class="notes">Implementation of:</div>
565
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodquery">PHPDS_dbConnector::query()</a></dt>
569
<a name="methodreturnSqlError" id="returnSqlError"><!-- --></a>
570
<div class="evenrow">
572
<div class="method-header">
573
<span class="method-title">returnSqlError</span> (line <span class="line-number">241</span>)
576
<!-- ========== Info from phpDoc block ========= -->
577
<p class="short-description">This method returns the last MySQL error as a string if there is any. It will also return the actual erroneous SQL statement if the display_sql_on_error property is set to true. This is very helpfull when debugging an SQL related problem.</p>
579
<li><span class="field">author:</span> Don Schoeman <<a href="mailto:titan@phpdevshell.org">titan@phpdevshell.org</a>></li>
580
<li><span class="field">version:</span> 1.0.1</li>
581
<li><span class="field">date:</span> 20100329 prevent an exception if display_sql_on_error is not set</li>
582
<li><span class="field">access:</span> public</li>
585
<div class="method-signature">
586
<span class="method-result">string</span>
587
<span class="method-name">
590
(<span class="var-type">string</span> <span class="var-name">$query</span>)
593
<ul class="parameters">
595
<span class="var-type">string</span>
596
<span class="var-name">$query</span><span class="var-description">: The actual query string.</span> </li>
601
<a name="methodrowResults" id="rowResults"><!-- --></a>
604
<div class="method-header">
605
<span class="method-title">rowResults</span> (line <span class="line-number">280</span>)
608
<!-- ========== Info from phpDoc block ========= -->
609
<p class="short-description">Will return a single row as a string depending on what column was selected.</p>
611
<li><span class="field">author:</span> jason</li>
612
<li><span class="field">version:</span> 1.0</li>
613
<li><span class="field">date:</span> 17062010 (jason)</li>
614
<li><span class="field">access:</span> public</li>
617
<div class="method-signature">
618
<span class="method-result">string</span>
619
<span class="method-name">
622
([<span class="var-type"></span> <span class="var-name">$row</span> = <span class="var-default">0</span>])
625
<ul class="parameters">
627
<span class="var-type"></span>
628
<span class="var-name">$row</span> </li>
631
<hr class="separator" />
632
<div class="notes">Implementation of:</div>
634
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodrowResults">PHPDS_dbConnector::rowResults()</a></dt>
638
<a name="methodseek" id="seek"><!-- --></a>
639
<div class="evenrow">
641
<div class="method-header">
642
<span class="method-title">seek</span> (line <span class="line-number">195</span>)
645
<!-- ========== Info from phpDoc block ========= -->
646
<p class="short-description">Move the internal pointer to the asked line</p>
648
<li><span class="field">return:</span> TRUE on success or FALSE on failure</li>
649
<li><span class="field">author:</span> greg</li>
650
<li><span class="field">version:</span> 1.0</li>
651
<li><span class="field">see:</span> seek()</li>
652
<li><span class="field">date:</span> 20100216</li>
653
<li><span class="field">access:</span> public</li>
656
<div class="method-signature">
657
<span class="method-result">boolean,</span>
658
<span class="method-name">
661
(<span class="var-type">$row_number</span> <span class="var-name">$row_number</span>)
664
<ul class="parameters">
666
<span class="var-type">$row_number</span>
667
<span class="var-name">$row_number</span><span class="var-description">: integer, the line number</span> </li>
670
<hr class="separator" />
671
<div class="notes">Implementation of:</div>
673
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodseek">PHPDS_dbConnector::seek()</a></dt>
677
<a name="methodstartTransaction" id="startTransaction"><!-- --></a>
680
<div class="method-header">
681
<span class="method-title">startTransaction</span> (line <span class="line-number">289</span>)
684
<!-- ========== Info from phpDoc block ========= -->
685
<p class="short-description">Start SQL transaction.</p>
687
<li><span class="field">access:</span> public</li>
690
<div class="method-signature">
691
<span class="method-result">void</span>
692
<span class="method-name">
699
<hr class="separator" />
700
<div class="notes">Implementation of:</div>
702
<dt><a href="../../PHPDevShell/[DB-related]/PHPDS_dbConnector.html#methodstartTransaction">PHPDS_dbConnector::startTransaction()</a></dt>
706
<h4>Inherited Methods</h4>
707
<a name='inherited_methods'><!-- --></a>
708
<!-- =========== Summary =========== -->
709
<p>Inherited From <span class="classname"><a href="../../PHPDevShell/PHPDS_dependant.html">PHPDS_dependant</a></span></p>
711
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#method__construct">PHPDS_dependant::__construct()</a></span><br>
712
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodconstruct">PHPDS_dependant::construct()</a></span><br>
713
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methoddebugInstance">PHPDS_dependant::debugInstance()</a></span><br>
714
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodfactory">PHPDS_dependant::factory()</a></span><br>
715
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodfactoryWith">PHPDS_dependant::factoryWith()</a></span><br>
716
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodinfo">PHPDS_dependant::info()</a></span><br>
717
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodlog">PHPDS_dependant::log()</a></span><br>
718
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#methodPHPDS_dependance">PHPDS_dependant::PHPDS_dependance()</a></span><br>
719
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#method_log">PHPDS_dependant::_log()</a></span><br>
720
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#method__call">PHPDS_dependant::__call()</a></span><br>
721
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#method__get">PHPDS_dependant::__get()</a></span><br>
722
<span class="method-name"><a href="../../PHPDevShell/PHPDS_dependant.html#method__set">PHPDS_dependant::__set()</a></span><br>
729
<p class="notes" id="credit">
730
Documentation generated on Tue, 09 Aug 2011 09:05:10 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
b'\\ No newline at end of file'
added
removed
other/phpdoc/PHPDevShell/[DB-related]/PHPDS_PDOconnector.html
