/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/SQLDataListSource.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/SQLDataListSource.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (show annotations)
Thu May 6 16:24:23 2004 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +1194 -1099 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class SQLDataListSource</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class SQLDataListSource</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <ul class="tags">
28 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_widgets_data_list_SQLDataListSource_inc.html">/widgets/data_list/SQLDataListSource.inc</a> (line <span class="field">18</span>)
32 </p>
33
34
35 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
36 |
37 --SQLDataListSource</pre>
38
39 </div>
40 </div>
41
42 <a name="sec-descendents"></a>
43 <div class="info-box">
44 <div class="info-box-title">Direct descendents</div>
45 <div class="nav-bar">
46 <a href="#sec-description">Description</a> |
47 <span class="disabled">Descendents</span>
48 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50
51 </div>
52 <div class="info-box-body">
53 <table cellpadding="2" cellspacing="0" class="class-table">
54 <tr>
55 <th class="class-table-header">Class</th>
56 <th class="class-table-header">Description</th>
57 </tr>
58 <tr>
59 <td style="padding-right: 2em"><a href="../phpHtmlLib/ADODBSQLDataListSource.html">ADODBSQLDataListSource</a></td>
60 <td>
61 This SQLDataListSource child class interacts with with the specific DB via the php ADODB DB abstraction objects.
62 </td>
63 </tr>
64 <tr>
65 <td style="padding-right: 2em"><a href="../phpHtmlLib/PEARSQLDataListSource.html">PEARSQLDataListSource</a></td>
66 <td>
67 This SQLDataListSource child class interacts with with the specific DB via the php PEAR DB abstraction objects.
68 </td>
69 </tr>
70 <tr>
71 <td style="padding-right: 2em"><a href="../phpHtmlLib/PGSQLDataListSource.html">PGSQLDataListSource</a></td>
72 <td>
73 This SQLDataListSource child class interacts with
74 </td>
75 </tr>
76 </table>
77 </div>
78 </div>
79
80
81 <a name="sec-var-summary"></a>
82 <div class="info-box">
83 <div class="info-box-title">Variable Summary</span></div>
84 <div class="nav-bar">
85 <a href="#sec-description">Description</a> |
86 <a href="#sec-descendents">Descendents</a> |
87 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
88 |
89 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
90
91 </div>
92 <div class="info-box-body">
93 <div class="var-summary">
94 <div class="var-title">
95 <span class="var-type">mixed</span>
96 <a href="#$_db_options" title="details" class="var-name">$_db_options</a>
97 </div>
98 <div class="var-title">
99 <span class="var-type">mixed</span>
100 <a href="#$_default_order_sensitivity" title="details" class="var-name">$_default_order_sensitivity</a>
101 </div>
102 <div class="var-title">
103 <span class="var-type">mixed</span>
104 <a href="#$_query" title="details" class="var-name">$_query</a>
105 </div>
106 </div>
107 </div>
108 </div>
109
110 <a name="sec-method-summary"></a>
111 <div class="info-box">
112 <div class="info-box-title">Method Summary</span></div>
113 <div class="nav-bar">
114 <a href="#sec-description">Description</a> |
115 <a href="#sec-descendents">Descendents</a> |
116 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
117
118 |
119 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
120 </div>
121 <div class="info-box-body">
122 <div class="method-summary">
123
124 <div class="method-definition">
125 <span class="method-result">string</span>
126 <a href="#advanced_search_where_clause" title="details" class="method-name">advanced_search_where_clause</a>
127 ()
128 </div>
129
130 <div class="method-definition">
131 <span class="method-result">string</span>
132 <a href="#build_groupby_clause" title="details" class="method-name">build_groupby_clause</a>
133 ()
134 </div>
135
136 <div class="method-definition">
137 <span class="method-result">string</span>
138 <a href="#build_limit_clause" title="details" class="method-name">build_limit_clause</a>
139 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$limit</span>)
140 </div>
141
142 <div class="method-definition">
143 <span class="method-result">string</span>
144 <a href="#build_order_clause" title="details" class="method-name">build_order_clause</a>
145 ()
146 </div>
147
148 <div class="method-definition">
149 <span class="method-result">string</span>
150 <a href="#build_query" title="details" class="method-name">build_query</a>
151 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$limit_flag</span> = <span class="var-default">TRUE</span>])
152 </div>
153
154 <div class="method-definition">
155 <span class="method-result">string</span>
156 <a href="#build_search_clause" title="details" class="method-name">build_search_clause</a>
157 ()
158 </div>
159
160 <div class="method-definition">
161 <span class="method-result">string</span>
162 <a href="#build_where_clause" title="details" class="method-name">build_where_clause</a>
163 ()
164 </div>
165
166 <div class="method-definition">
167 <span class="method-result">int</span>
168 <a href="#count" title="details" class="method-name">count</a>
169 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$tables</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$count_clause</span> = <span class="var-default">'*'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$table</span>)
170 </div>
171
172 <div class="method-definition">
173 <span class="method-result">void</span>
174 <a href="#do_prequery" title="details" class="method-name">do_prequery</a>
175 ()
176 </div>
177
178 <div class="method-definition">
179 <span class="method-result">boolean</span>
180 <a href="#do_query" title="details" class="method-name">do_query</a>
181 ()
182 </div>
183
184 <div class="method-definition">
185 <span class="method-result">string</span>
186 <a href="#get_count_column" title="details" class="method-name">get_count_column</a>
187 ()
188 </div>
189
190 <div class="method-definition">
191 <span class="method-result">string</span>
192 <a href="#get_db_tables" title="details" class="method-name">get_db_tables</a>
193 ()
194 </div>
195
196 <div class="method-definition">
197 <span class="method-result">string</span>
198 <a href="#get_db_values" title="details" class="method-name">get_db_values</a>
199 ()
200 </div>
201
202 <div class="method-definition">
203 <span class="method-result">none</span>
204 <a href="#get_default_order_case_sensitive" title="details" class="method-name">get_default_order_case_sensitive</a>
205 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
206 </div>
207
208 <div class="method-definition">
209 <span class="method-result">array()</span>
210 <a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a>
211 ()
212 </div>
213
214 <div class="method-definition">
215 <span class="method-result">void</span>
216 <a href="#join_clauses" title="details" class="method-name">join_clauses</a>
217 ()
218 </div>
219
220 <div class="method-definition">
221 <span class="method-result">string</span>
222 <a href="#search_value_filter" title="details" class="method-name">search_value_filter</a>
223 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
224 </div>
225
226 <div class="method-definition">
227 <span class="method-result">void</span>
228 <a href="#setup_db_options" title="details" class="method-name">setup_db_options</a>
229 (<span class="var-type">string</span>&nbsp;<span class="var-name">$values</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tables</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$groupby_clause</span> = <span class="var-default">''</span>])
230 </div>
231
232 <div class="method-definition">
233 <span class="method-result">string.</span>
234 <a href="#setup_order" title="details" class="method-name">setup_order</a>
235 (<span class="var-type">string</span>&nbsp;<span class="var-name">$orderby</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$reverseorder</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$icase_sort</span> = <span class="var-default">FALSE</span>])
236 </div>
237
238 <div class="method-definition">
239 <span class="method-result">void</span>
240 <a href="#set_count_column" title="details" class="method-name">set_count_column</a>
241 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$var</span>)
242 </div>
243
244 <div class="method-definition">
245 <span class="method-result">void</span>
246 <a href="#set_db_groupby_clause" title="details" class="method-name">set_db_groupby_clause</a>
247 (<span class="var-type">string</span>&nbsp;<span class="var-name">$clause</span>)
248 </div>
249
250 <div class="method-definition">
251 <span class="method-result">void</span>
252 <a href="#set_db_tables" title="details" class="method-name">set_db_tables</a>
253 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tables</span>)
254 </div>
255
256 <div class="method-definition">
257 <span class="method-result">void</span>
258 <a href="#set_db_values" title="details" class="method-name">set_db_values</a>
259 (<span class="var-type">string</span>&nbsp;<span class="var-name">$values</span>)
260 </div>
261
262 <div class="method-definition">
263 <span class="method-result">void</span>
264 <a href="#set_db_where_clause" title="details" class="method-name">set_db_where_clause</a>
265 (<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span>)
266 </div>
267
268 <div class="method-definition">
269 <span class="method-result">none</span>
270 <a href="#set_default_order_case_sensitive" title="details" class="method-name">set_default_order_case_sensitive</a>
271 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
272 </div>
273
274 <div class="method-definition">
275 <span class="method-result">string</span>
276 <a href="#simple_search_where_clause" title="details" class="method-name">simple_search_where_clause</a>
277 ()
278 </div>
279
280 <div class="method-definition">
281 <span class="method-result">string</span>
282 <a href="#sql_varchar_filter" title="details" class="method-name">sql_varchar_filter</a>
283 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
284 </div>
285 </div>
286 </div>
287 </div>
288
289 <a name="sec-vars"></a>
290 <div class="info-box">
291 <div class="info-box-title">Variables</div>
292 <div class="nav-bar">
293 <a href="#sec-description">Description</a> |
294 <a href="#sec-descendents">Descendents</a> |
295 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
296
297
298 |
299 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
300
301 </div>
302 <div class="info-box-body">
303 <a name="var$_db_options" id="$_db_options"><!-- --></A>
304 <div class="evenrow">
305
306 <div class="var-header">
307 <span class="var-title">
308 <span class="var-type">mixed</span>
309 <span class="var-name">$_db_options</span>
310 = <span class="var-default">array(&quot;values&quot; =&gt; &quot;&quot;,<br /> &quot;tables&quot; =&gt; &quot;&quot;,<br /> &quot;where_clause&quot; =&gt; &quot;&quot;,<br /> &quot;groupby_clause&quot; =&gt; &quot;&quot;,<br /> &quot;count_column&quot; =&gt; &quot;*&quot;)</span> (line <span class="line-number">25</span>)
311 </span>
312 </div>
313
314 <!-- ========== Info from phpDoc block ========= -->
315 <p class="short-description">this holds all of the options</p>
316 <p class="description"><p>that make up the sql query</p></p>
317
318
319
320
321
322 </div>
323 <a name="var$_default_order_sensitivity" id="$_default_order_sensitivity"><!-- --></A>
324 <div class="oddrow">
325
326 <div class="var-header">
327 <span class="var-title">
328 <span class="var-type">mixed</span>
329 <span class="var-name">$_default_order_sensitivity</span>
330 = <span class="var-default"> TRUE</span> (line <span class="line-number">45</span>)
331 </span>
332 </div>
333
334 <!-- ========== Info from phpDoc block ========= -->
335 <p class="short-description">The flag that tells us to use case sensitive order by as a default.</p>
336 <p class="description"><p>NOTE: we are case sensitive by default</p></p>
337
338
339
340
341
342 </div>
343 <a name="var$_query" id="$_query"><!-- --></A>
344 <div class="evenrow">
345
346 <div class="var-header">
347 <span class="var-title">
348 <span class="var-type">mixed</span>
349 <span class="var-name">$_query</span>
350 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">35</span>)
351 </span>
352 </div>
353
354 <!-- ========== Info from phpDoc block ========= -->
355 <p class="short-description">The entire query built by</p>
356 <p class="description"><p>build_query()</p></p>
357
358
359
360
361
362 </div>
363
364 <h4>Inherited Variables</h4>
365 <A NAME='inherited_vars'><!-- --></A>
366 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
367 <blockquote>
368 <span class="var-title">
369 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br>
370 </span>
371 <span class="var-title">
372 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br>
373 </span>
374 <span class="var-title">
375 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br>
376 </span>
377 <span class="var-title">
378 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br>
379 </span>
380 <span class="var-title">
381 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br>
382 </span>
383 </blockquote>
384
385 </div>
386 </div>
387
388 <a name="sec-methods"></a>
389 <div class="info-box">
390 <div class="info-box-title">Methods</div>
391 <div class="nav-bar">
392 <a href="#sec-description">Description</a> |
393 <a href="#sec-descendents">Descendents</a> |
394 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
395 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
396
397 </div>
398 <div class="info-box-body">
399 <A NAME='method_detail'></A>
400 <a name="methodadvanced_search_where_clause" id="advanced_search_where_clause"><!-- --></a>
401 <div class="oddrow">
402
403 <div class="method-header">
404 <span class="method-title">advanced_search_where_clause</span> (line <span class="line-number">238</span>)
405 </div>
406
407 <!-- ========== Info from phpDoc block ========= -->
408 <p class="short-description">This function is responsible for building the portion of the where clause for doing an advanced search.</p>
409 <p class="description"><p>NOTE: the child class MUST override this method</p></p>
410 <ul class="tags">
411 <li><span class="field">return:</span> - portion of the where clause</li>
412 </ul>
413
414 <div class="method-signature">
415 <span class="method-result">string</span>
416 <span class="method-name">
417 advanced_search_where_clause
418 </span>
419 ()
420 </div>
421
422
423
424 </div>
425 <a name="methodbuild_groupby_clause" id="build_groupby_clause"><!-- --></a>
426 <div class="evenrow">
427
428 <div class="method-header">
429 <span class="method-title">build_groupby_clause</span> (line <span class="line-number">371</span>)
430 </div>
431
432 <!-- ========== Info from phpDoc block ========= -->
433 <p class="short-description">this builds the groupby clause of the query</p>
434
435 <div class="method-signature">
436 <span class="method-result">string</span>
437 <span class="method-name">
438 build_groupby_clause
439 </span>
440 ()
441 </div>
442
443
444
445 </div>
446 <a name="methodbuild_limit_clause" id="build_limit_clause"><!-- --></a>
447 <div class="oddrow">
448
449 <div class="method-header">
450 <span class="method-title">build_limit_clause</span> (line <span class="line-number">488</span>)
451 </div>
452
453 <!-- ========== Info from phpDoc block ========= -->
454 <p class="short-description">This function builds the limit clause portion of a DB query.</p>
455 <p class="description"><p>This is specific to the particular DB implementation.</p></p>
456 <ul class="tags">
457 <li><span class="field">return:</span> - the limit portion of the query.</li>
458 </ul>
459
460 <div class="method-signature">
461 <span class="method-result">string</span>
462 <span class="method-name">
463 build_limit_clause
464 </span>
465 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$limit</span>)
466 </div>
467
468
469
470 <hr class="separator" />
471 <div class="notes">Redefined in descendants as:</div>
472 <ul class="redefinitions">
473 <li>
474 <a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodbuild_limit_clause">ADODBSQLDataListSource::build_limit_clause()</a>
475 : This function builds the limit clause portion of a DB query.
476 </li>
477 <li>
478 <a href="../phpHtmlLib/PEARSQLDataListSource.html#methodbuild_limit_clause">PEARSQLDataListSource::build_limit_clause()</a>
479 : This function builds the limit clause portion of a DB query.
480 </li>
481 <li>
482 <a href="../phpHtmlLib/PGSQLDataListSource.html#methodbuild_limit_clause">PGSQLDataListSource::build_limit_clause()</a>
483 : This function builds the limit clause portion of a DB query.
484 </li>
485 </ul>
486 </div>
487 <a name="methodbuild_order_clause" id="build_order_clause"><!-- --></a>
488 <div class="evenrow">
489
490 <div class="method-header">
491 <span class="method-title">build_order_clause</span> (line <span class="line-number">341</span>)
492 </div>
493
494 <!-- ========== Info from phpDoc block ========= -->
495 <p class="short-description">This builds the db query ORDER BY clause used to sort the data from the DB.</p>
496 <ul class="tags">
497 <li><span class="field">return:</span> - the order by clause</li>
498 </ul>
499
500 <div class="method-signature">
501 <span class="method-result">string</span>
502 <span class="method-name">
503 build_order_clause
504 </span>
505 ()
506 </div>
507
508
509
510 </div>
511 <a name="methodbuild_query" id="build_query"><!-- --></a>
512 <div class="oddrow">
513
514 <div class="method-header">
515 <span class="method-title">build_query</span> (line <span class="line-number">386</span>)
516 </div>
517
518 <!-- ========== Info from phpDoc block ========= -->
519 <p class="short-description">build the entire DB query</p>
520 <ul class="tags">
521 <li><span class="field">return:</span> - the full query string to the DB.</li>
522 </ul>
523
524 <div class="method-signature">
525 <span class="method-result">string</span>
526 <span class="method-name">
527 build_query
528 </span>
529 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$limit_flag</span> = <span class="var-default">TRUE</span>])
530 </div>
531
532 <ul class="parameters">
533 <li>
534 <span class="var-type">boolean</span>
535 <span class="var-name">$limit_flag</span><span class="var-description">: - build the limit clause or not/</span> </li>
536 </ul>
537
538
539 </div>
540 <a name="methodbuild_search_clause" id="build_search_clause"><!-- --></a>
541 <div class="evenrow">
542
543 <div class="method-header">
544 <span class="method-title">build_search_clause</span> (line <span class="line-number">298</span>)
545 </div>
546
547 <!-- ========== Info from phpDoc block ========= -->
548 <p class="short-description">This method builds the where clause.</p>
549
550 <div class="method-signature">
551 <span class="method-result">string</span>
552 <span class="method-name">
553 build_search_clause
554 </span>
555 ()
556 </div>
557
558
559
560 </div>
561 <a name="methodbuild_where_clause" id="build_where_clause"><!-- --></a>
562 <div class="oddrow">
563
564 <div class="method-header">
565 <span class="method-title">build_where_clause</span> (line <span class="line-number">273</span>)
566 </div>
567
568 <!-- ========== Info from phpDoc block ========= -->
569 <p class="short-description">This builds the where clause for the query</p>
570 <ul class="tags">
571 <li><span class="field">return:</span> the where clause.</li>
572 </ul>
573
574 <div class="method-signature">
575 <span class="method-result">string</span>
576 <span class="method-name">
577 build_where_clause
578 </span>
579 ()
580 </div>
581
582
583
584 </div>
585 <a name="methodcount" id="count"><!-- --></a>
586 <div class="evenrow">
587
588 <div class="method-header">
589 <span class="method-title">count</span> (line <span class="line-number">501</span>)
590 </div>
591
592 <!-- ========== Info from phpDoc block ========= -->
593 <p class="short-description">find the number of rows to be returned from a query from a table and where clause</p>
594 <ul class="tags">
595 <li><span class="field">return:</span> the # of rows</li>
596 </ul>
597
598 <div class="method-signature">
599 <span class="method-result">int</span>
600 <span class="method-name">
601 count
602 </span>
603 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$tables</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$count_clause</span> = <span class="var-default">'*'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$table</span>)
604 </div>
605
606 <ul class="parameters">
607 <li>
608 <span class="var-type">string</span>
609 <span class="var-name">$table</span><span class="var-description">: - the table to count from</span> </li>
610 <li>
611 <span class="var-type">string</span>
612 <span class="var-name">$where_clause</span><span class="var-description">: - a where clause</span> </li>
613 </ul>
614
615
616 <hr class="separator" />
617 <div class="notes">Redefined in descendants as:</div>
618 <ul class="redefinitions">
619 <li>
620 <a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodcount">ADODBSQLDataListSource::count()</a>
621 : find the number of rows to be returned from a query from a table and where clause
622 </li>
623 <li>
624 <a href="../phpHtmlLib/PEARSQLDataListSource.html#methodcount">PEARSQLDataListSource::count()</a>
625 : find the number of rows to be returned from a query from a table and where clause
626 </li>
627 <li>
628 <a href="../phpHtmlLib/PGSQLDataListSource.html#methodcount">PGSQLDataListSource::count()</a>
629 : find the number of rows to be returned from a query from a table and where clause
630 </li>
631 </ul>
632 </div>
633 <a name="methoddo_prequery" id="do_prequery"><!-- --></a>
634 <div class="oddrow">
635
636 <div class="method-header">
637 <span class="method-title">do_prequery</span> (line <span class="line-number">403</span>)
638 </div>
639
640 <!-- ========== Info from phpDoc block ========= -->
641
642 <div class="method-signature">
643 <span class="method-result">void</span>
644 <span class="method-name">
645 do_prequery
646 </span>
647 ()
648 </div>
649
650
651 <hr class="separator" />
652 <div class="notes">Redefinition of:</div>
653 <dl>
654 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></dt>
655 <dd>This is a method that should be defined by the child class to do any pre-query type of things.</dd>
656 </dl>
657
658 </div>
659 <a name="methoddo_query" id="do_query"><!-- --></a>
660 <div class="evenrow">
661
662 <div class="method-header">
663 <span class="method-title">do_query</span> (line <span class="line-number">460</span>)
664 </div>
665
666 <!-- ========== Info from phpDoc block ========= -->
667 <p class="short-description">Do the query to the DB and pull in all of the records locally.</p>
668 <ul class="tags">
669 <li><span class="field">return:</span> - the query passed/failed.</li>
670 </ul>
671
672 <div class="method-signature">
673 <span class="method-result">boolean</span>
674 <span class="method-name">
675 do_query
676 </span>
677 ()
678 </div>
679
680
681 <hr class="separator" />
682 <div class="notes">Redefinition of:</div>
683 <dl>
684 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></dt>
685 <dd>This is the function that does the data fetching, and sorting if needed.</dd>
686 </dl>
687
688 <hr class="separator" />
689 <div class="notes">Redefined in descendants as:</div>
690 <ul class="redefinitions">
691 <li>
692 <a href="../phpHtmlLib/ADODBSQLDataListSource.html#methoddo_query">ADODBSQLDataListSource::do_query()</a>
693 : This is the function that does the data fetching, and sorting if needed.
694 </li>
695 <li>
696 <a href="../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query">PEARSQLDataListSource::do_query()</a>
697 : This is the function that does the data fetching, and sorting if needed.
698 </li>
699 <li>
700 <a href="../phpHtmlLib/PGSQLDataListSource.html#methoddo_query">PGSQLDataListSource::do_query()</a>
701 </li>
702 </ul>
703 </div>
704 <a name="methodget_count_column" id="get_count_column"><!-- --></a>
705 <div class="oddrow">
706
707 <div class="method-header">
708 <span class="method-title">get_count_column</span> (line <span class="line-number">146</span>)
709 </div>
710
711 <!-- ========== Info from phpDoc block ========= -->
712 <p class="short-description">this returns the current count column</p>
713
714 <div class="method-signature">
715 <span class="method-result">string</span>
716 <span class="method-name">
717 get_count_column
718 </span>
719 ()
720 </div>
721
722
723
724 </div>
725 <a name="methodget_db_tables" id="get_db_tables"><!-- --></a>
726 <div class="evenrow">
727
728 <div class="method-header">
729 <span class="method-title">get_db_tables</span> (line <span class="line-number">109</span>)
730 </div>
731
732 <!-- ========== Info from phpDoc block ========= -->
733 <p class="short-description">returns the table(s) used in the query</p>
734
735 <div class="method-signature">
736 <span class="method-result">string</span>
737 <span class="method-name">
738 get_db_tables
739 </span>
740 ()
741 </div>
742
743
744
745 </div>
746 <a name="methodget_db_values" id="get_db_values"><!-- --></a>
747 <div class="oddrow">
748
749 <div class="method-header">
750 <span class="method-title">get_db_values</span> (line <span class="line-number">90</span>)
751 </div>
752
753 <!-- ========== Info from phpDoc block ========= -->
754 <p class="short-description">This function returns the values we need to search for in the sql query</p>
755
756 <div class="method-signature">
757 <span class="method-result">string</span>
758 <span class="method-name">
759 get_db_values
760 </span>
761 ()
762 </div>
763
764
765
766 </div>
767 <a name="methodget_default_order_case_sensitive" id="get_default_order_case_sensitive"><!-- --></a>
768 <div class="evenrow">
769
770 <div class="method-header">
771 <span class="method-title">get_default_order_case_sensitive</span> (line <span class="line-number">523</span>)
772 </div>
773
774 <!-- ========== Info from phpDoc block ========= -->
775 <p class="short-description">This function is used to get the flag for the ability to sort/order by case sensitive or not.</p>
776
777 <div class="method-signature">
778 <span class="method-result">none</span>
779 <span class="method-name">
780 get_default_order_case_sensitive
781 </span>
782 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">0</span>)
783 </div>
784
785 <ul class="parameters">
786 <li>
787 <span class="var-type">boolean</span>
788 <span class="var-name">0</span><span class="var-description">: - TRUE = case sensitive by default</span> </li>
789 </ul>
790
791
792 </div>
793 <a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a>
794 <div class="oddrow">
795
796 <div class="method-header">
797 <span class="method-title">get_next_data_row</span> (line <span class="line-number">474</span>)
798 </div>
799
800 <!-- ========== Info from phpDoc block ========= -->
801 <p class="short-description">This function gets the next data row from the query()</p>
802
803 <div class="method-signature">
804 <span class="method-result">array()</span>
805 <span class="method-name">
806 get_next_data_row
807 </span>
808 ()
809 </div>
810
811
812 <hr class="separator" />
813 <div class="notes">Redefinition of:</div>
814 <dl>
815 <dt><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></dt>
816 <dd>This function gets the next data row from the query()</dd>
817 </dl>
818
819 <hr class="separator" />
820 <div class="notes">Redefined in descendants as:</div>
821 <ul class="redefinitions">
822 <li>
823 <a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodget_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a>
824 : This function gets the next data row from the query()
825 </li>
826 <li>
827 <a href="../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row">PEARSQLDataListSource::get_next_data_row()</a>
828 : This function gets the next data row from the query()
829 </li>
830 <li>
831 <a href="../phpHtmlLib/PGSQLDataListSource.html#methodget_next_data_row">PGSQLDataListSource::get_next_data_row()</a>
832 : This function gets the next data row from the query()
833 </li>
834 </ul>
835 </div>
836 <a name="methodjoin_clauses" id="join_clauses"><!-- --></a>
837 <div class="evenrow">
838
839 <div class="method-header">
840 <span class="method-title">join_clauses</span> (line <span class="line-number">156</span>)
841 </div>
842
843 <!-- ========== Info from phpDoc block ========= -->
844
845 <div class="method-signature">
846 <span class="method-result">void</span>
847 <span class="method-name">
848 join_clauses
849 </span>
850 ()
851 </div>
852
853
854
855 </div>
856 <a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a>
857 <div class="oddrow">
858
859 <div class="method-header">
860 <span class="method-title">search_value_filter</span> (line <span class="line-number">250</span>)
861 </div>
862
863 <!-- ========== Info from phpDoc block ========= -->
864 <p class="short-description">This function does the variable cleaning that is required to use a search value in a sql query</p>
865 <ul class="tags">
866 <li><span class="field">return:</span> - the &quot;cleaned&quot; string</li>
867 </ul>
868
869 <div class="method-signature">
870 <span class="method-result">string</span>
871 <span class="method-name">
872 search_value_filter
873 </span>
874 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
875 </div>
876
877 <ul class="parameters">
878 <li>
879 <span class="var-type">string</span>
880 <span class="var-name">$value</span><span class="var-description">: - the origina string from the user</span> </li>
881 </ul>
882
883
884 </div>
885 <a name="methodsetup_db_options" id="setup_db_options"><!-- --></a>
886 <div class="evenrow">
887
888 <div class="method-header">
889 <span class="method-title">setup_db_options</span> (line <span class="line-number">65</span>)
890 </div>
891
892 <!-- ========== Info from phpDoc block ========= -->
893 <p class="short-description">Set which DB options to use for this list.</p>
894
895 <div class="method-signature">
896 <span class="method-result">void</span>
897 <span class="method-name">
898 setup_db_options
899 </span>
900 (<span class="var-type">string</span>&nbsp;<span class="var-name">$values</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tables</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$groupby_clause</span> = <span class="var-default">''</span>])
901 </div>
902
903 <ul class="parameters">
904 <li>
905 <span class="var-type">string</span>
906 <span class="var-name">$values</span><span class="var-description">: - $values - the values you want to select from the db table(s)</span> </li>
907 <li>
908 <span class="var-type">string</span>
909 <span class="var-name">$tables</span><span class="var-description">: - $tables - The tables you want to select on.</span> </li>
910 <li>
911 <span class="var-type">string</span>
912 <span class="var-name">$where_clause</span><span class="var-description">: - $where_clause - portion of the where clause. This expects name=value pairs only.</span> </li>
913 <li>
914 <span class="var-type">string</span>
915 <span class="var-name">$groupby_clause</span><span class="var-description">: - $groupby_clause - the groupby portion of the query. same format as where_clause</span> </li>
916 </ul>
917
918
919 </div>
920 <a name="methodsetup_order" id="setup_order"><!-- --></a>
921 <div class="oddrow">
922
923 <div class="method-header">
924 <span class="method-title">setup_order</span> (line <span class="line-number">316</span>)
925 </div>
926
927 <!-- ========== Info from phpDoc block ========= -->
928 <p class="short-description">This function builds the orderby clause for the DB query.</p>
929
930 <div class="method-signature">
931 <span class="method-result">string.</span>
932 <span class="method-name">
933 setup_order
934 </span>
935 (<span class="var-type">string</span>&nbsp;<span class="var-name">$orderby</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$reverseorder</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$icase_sort</span> = <span class="var-default">FALSE</span>])
936 </div>
937
938 <ul class="parameters">
939 <li>
940 <span class="var-type">string</span>
941 <span class="var-name">$orderby</span><span class="var-description">: - DB table field to order by</span> </li>
942 <li>
943 <span class="var-type">string</span>
944 <span class="var-name">$reverseorder</span><span class="var-description">: - order assension value.</span> </li>
945 <li>
946 <span class="var-type">boolean</span>
947 <span class="var-name">$icase_sort</span><span class="var-description">: - case insensitive sort?</span> </li>
948 </ul>
949
950
951 </div>
952 <a name="methodset_count_column" id="set_count_column"><!-- --></a>
953 <div class="evenrow">
954
955 <div class="method-header">
956 <span class="method-title">set_count_column</span> (line <span class="line-number">137</span>)
957 </div>
958
959 <!-- ========== Info from phpDoc block ========= -->
960 <p class="short-description">This function changes the counted column.</p>
961 <p class="description"><p>By default, we use count(1) But sometime you need count(distinct KEY) for example</p></p>
962
963 <div class="method-signature">
964 <span class="method-result">void</span>
965 <span class="method-name">
966 set_count_column
967 </span>
968 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$var</span>)
969 </div>
970
971
972
973 </div>
974 <a name="methodset_db_groupby_clause" id="set_db_groupby_clause"><!-- --></a>
975 <div class="oddrow">
976
977 <div class="method-header">
978 <span class="method-title">set_db_groupby_clause</span> (line <span class="line-number">127</span>)
979 </div>
980
981 <!-- ========== Info from phpDoc block ========= -->
982 <p class="short-description">Sets the groupby clause for the query</p>
983
984 <div class="method-signature">
985 <span class="method-result">void</span>
986 <span class="method-name">
987 set_db_groupby_clause
988 </span>
989 (<span class="var-type">string</span>&nbsp;<span class="var-name">$clause</span>)
990 </div>
991
992 <ul class="parameters">
993 <li>
994 <span class="var-type">string</span>
995 <span class="var-name">$clause</span><span class="var-description">: name value pairs</span> </li>
996 </ul>
997
998
999 </div>
1000 <a name="methodset_db_tables" id="set_db_tables"><!-- --></a>
1001 <div class="evenrow">
1002
1003 <div class="method-header">
1004 <span class="method-title">set_db_tables</span> (line <span class="line-number">100</span>)
1005 </div>
1006
1007 <!-- ========== Info from phpDoc block ========= -->
1008 <p class="short-description">Set the tables from the DB you want to select on.</p>
1009
1010 <div class="method-signature">
1011 <span class="method-result">void</span>
1012 <span class="method-name">
1013 set_db_tables
1014 </span>
1015 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tables</span>)
1016 </div>
1017
1018 <ul class="parameters">
1019 <li>
1020 <span class="var-type">string</span>
1021 <span class="var-name">$tables</span><span class="var-description">: - $tables</span> </li>
1022 </ul>
1023
1024
1025 </div>
1026 <a name="methodset_db_values" id="set_db_values"><!-- --></a>
1027 <div class="oddrow">
1028
1029 <div class="method-header">
1030 <span class="method-title">set_db_values</span> (line <span class="line-number">79</span>)
1031 </div>
1032
1033 <!-- ========== Info from phpDoc block ========= -->
1034 <p class="short-description">Set the values we want to select from the db.</p>
1035
1036 <div class="method-signature">
1037 <span class="method-result">void</span>
1038 <span class="method-name">
1039 set_db_values
1040 </span>
1041 (<span class="var-type">string</span>&nbsp;<span class="var-name">$values</span>)
1042 </div>
1043
1044 <ul class="parameters">
1045 <li>
1046 <span class="var-type">string</span>
1047 <span class="var-name">$values</span><span class="var-description">: - $values</span> </li>
1048 </ul>
1049
1050
1051 </div>
1052 <a name="methodset_db_where_clause" id="set_db_where_clause"><!-- --></a>
1053 <div class="evenrow">
1054
1055 <div class="method-header">
1056 <span class="method-title">set_db_where_clause</span> (line <span class="line-number">118</span>)
1057 </div>
1058
1059 <!-- ========== Info from phpDoc block ========= -->
1060 <p class="short-description">Set the user portion of the where clause.</p>
1061
1062 <div class="method-signature">
1063 <span class="method-result">void</span>
1064 <span class="method-name">
1065 set_db_where_clause
1066 </span>
1067 (<span class="var-type">string</span>&nbsp;<span class="var-name">$where_clause</span>)
1068 </div>
1069
1070 <ul class="parameters">
1071 <li>
1072 <span class="var-type">string</span>
1073 <span class="var-name">$where_clause</span><span class="var-description">: - name value pairs</span> </li>
1074 </ul>
1075
1076
1077 </div>
1078 <a name="methodset_default_order_case_sensitive" id="set_default_order_case_sensitive"><!-- --></a>
1079 <div class="oddrow">
1080
1081 <div class="method-header">
1082 <span class="method-title">set_default_order_case_sensitive</span> (line <span class="line-number">512</span>)
1083 </div>
1084
1085 <!-- ========== Info from phpDoc block ========= -->
1086 <p class="short-description">This function is used to set the flag for the ability to sort/order by case sensitive or not.</p>
1087
1088 <div class="method-signature">
1089 <span class="method-result">none</span>
1090 <span class="method-name">
1091 set_default_order_case_sensitive
1092 </span>
1093 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1094 </div>
1095
1096 <ul class="parameters">
1097 <li>
1098 <span class="var-type">boolean</span>
1099 <span class="var-name">$flag</span><span class="var-description">: - TRUE = case sensitive by default</span> </li>
1100 </ul>
1101
1102
1103 </div>
1104 <a name="methodsimple_search_where_clause" id="simple_search_where_clause"><!-- --></a>
1105 <div class="evenrow">
1106
1107 <div class="method-header">
1108 <span class="method-title">simple_search_where_clause</span> (line <span class="line-number">190</span>)
1109 </div>
1110
1111 <!-- ========== Info from phpDoc block ========= -->
1112 <p class="short-description">this builds the search clause</p>
1113
1114 <div class="method-signature">
1115 <span class="method-result">string</span>
1116 <span class="method-name">
1117 simple_search_where_clause
1118 </span>
1119 ()
1120 </div>
1121
1122
1123
1124 </div>
1125 <a name="methodsql_varchar_filter" id="sql_varchar_filter"><!-- --></a>
1126 <div class="oddrow">
1127
1128 <div class="method-header">
1129 <span class="method-title">sql_varchar_filter</span> (line <span class="line-number">263</span>)
1130 </div>
1131
1132 <!-- ========== Info from phpDoc block ========= -->
1133 <p class="short-description">Clean up the string so it can work in a db</p>
1134
1135 <div class="method-signature">
1136 <span class="method-result">string</span>
1137 <span class="method-name">
1138 sql_varchar_filter
1139 </span>
1140 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1141 </div>
1142
1143 <ul class="parameters">
1144 <li>
1145 <span class="var-type">string</span>
1146 <span class="var-name">$value</span> </li>
1147 </ul>
1148
1149
1150 </div>
1151 <h4>Inherited Methods</h4>
1152 <a name='inherited_methods'><!-- --></a>
1153 <!-- =========== Summary =========== -->
1154 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
1155 <blockquote>
1156 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br>
1157 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br>
1158 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br>
1159 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br>
1160 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br>
1161 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br>
1162 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br>
1163 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br>
1164 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br>
1165 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br>
1166 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br>
1167 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br>
1168 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br>
1169 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br>
1170 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_secondary_orderby">DataListSource::get_secondary_orderby()</a></span><br>
1171 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br>
1172 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br>
1173 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br>
1174 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br>
1175 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br>
1176 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br>
1177 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br>
1178 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br>
1179 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br>
1180 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br>
1181 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br>
1182 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br>
1183 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_secondary_orderby">DataListSource::set_secondary_orderby()</a></span><br>
1184 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br>
1185 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br>
1186 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br>
1187 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br>
1188 </blockquote>
1189
1190 </div>
1191 </div>
1192
1193
1194 <p class="notes" id="credit">
1195 Documentation generated on Thu, 1 Apr 2004 09:39:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
1196 </p>
1197 </div></body>
1198 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed