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