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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Sat Sep 20 00:24:00 2003 UTC (21 years ago) by jonen
Branch: MAIN
Changes since 1.2: +561 -636 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 CSVFILEDataListSource</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 CSVFILEDataListSource</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
22 </div>
23 <div class="info-box-body">
24 <!-- ========== Info from phpDoc block ========= -->
25 <p class="short-description">This DataListSource child class gets the data from a CSV (comma seperated values) file on disk.</p>
26 <p class="description"><p>The CSV MUST have a 'header' line before any data. The 'header' line is a CSV line that provides a name for each column of data in the file.</p><p>All lines that start with '#' or '//' are ignored as comments.</p></p>
27 <ul class="tags">
28 <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>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_widgets_data_list_CSVFILEDataListSource_inc.html">Program_Root/widgets/data_list/CSVFILEDataListSource.inc</a> (line <span class="field">31</span>)
32 </p>
33
34
35 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
36 |
37 --CSVFILEDataListSource</pre>
38
39 </div>
40 </div>
41
42
43 <a name="sec-var-summary"></a>
44 <div class="info-box">
45 <div class="info-box-title">Variable Summary</span></div>
46 <div class="nav-bar">
47 <a href="#sec-description">Description</a> |
48 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
49 |
50 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
51
52 </div>
53 <div class="info-box-body">
54 <div class="var-summary">
55 <div class="var-title">
56 <span class="var-type">mixed</span>
57 <a href="#$_csv_headers" title="details" class="var-name">$_csv_headers</a>
58 </div>
59 <div class="var-title">
60 <span class="var-type">mixed</span>
61 <a href="#$_filename" title="details" class="var-name">$_filename</a>
62 </div>
63 <div class="var-title">
64 <span class="var-type">mixed</span>
65 <a href="#$_fp" title="details" class="var-name">$_fp</a>
66 </div>
67 <div class="var-title">
68 <span class="var-type">mixed</span>
69 <a href="#$_maxlinelength" title="details" class="var-name">$_maxlinelength</a>
70 </div>
71 </div>
72 </div>
73 </div>
74
75 <a name="sec-method-summary"></a>
76 <div class="info-box">
77 <div class="info-box-title">Method Summary</span></div>
78 <div class="nav-bar">
79 <a href="#sec-description">Description</a> |
80 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
81
82 |
83 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
84 </div>
85 <div class="info-box-body">
86 <div class="method-summary">
87
88 <div class="method-definition">
89 <span class="method-result">void</span>
90 <a href="#CSVFILEDataListSource" title="details" class="method-name">CSVFILEDataListSource</a>
91 (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$maxline</span> = <span class="var-default">4096</span>])
92 </div>
93
94 <div class="method-definition">
95 <span class="method-result">void</span>
96 <a href="#add_data_row" title="details" class="method-name">add_data_row</a>
97 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$row</span>)
98 </div>
99
100 <div class="method-definition">
101 <span class="method-result">void</span>
102 <a href="#cmp" title="details" class="method-name">cmp</a>
103 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data1</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$data2</span>)
104 </div>
105
106 <div class="method-definition">
107 <span class="method-result">void</span>
108 <a href="#do_prequery" title="details" class="method-name">do_prequery</a>
109 ()
110 </div>
111
112 <div class="method-definition">
113 <span class="method-result">void</span>
114 <a href="#do_query" title="details" class="method-name">do_query</a>
115 ()
116 </div>
117
118 <div class="method-definition">
119 <span class="method-result">void</span>
120 <a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a>
121 ()
122 </div>
123
124 <div class="method-definition">
125 <span class="method-result">void</span>
126 <a href="#sort" title="details" class="method-name">sort</a>
127 ()
128 </div>
129
130 <div class="method-definition">
131 <span class="method-result">array</span>
132 <a href="#_construct_row" title="details" class="method-name">_construct_row</a>
133 (<span class="var-type">string</span>&nbsp;<span class="var-name">$line</span>)
134 </div>
135
136 <div class="method-definition">
137 <span class="method-result">void</span>
138 <a href="#_find_data" title="details" class="method-name">_find_data</a>
139 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$row_data</span>)
140 </div>
141
142 <div class="method-definition">
143 <span class="method-result">void</span>
144 <a href="#_get_header" title="details" class="method-name">_get_header</a>
145 ()
146 </div>
147 </div>
148 </div>
149 </div>
150
151 <a name="sec-vars"></a>
152 <div class="info-box">
153 <div class="info-box-title">Variables</div>
154 <div class="nav-bar">
155 <a href="#sec-description">Description</a> |
156 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
157
158
159 |
160 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
161
162 </div>
163 <div class="info-box-body">
164 <a name="var$_csv_headers" id="$_csv_headers"><!-- --></A>
165 <div class="oddrow">
166
167 <div class="var-header">
168 <span class="var-title">
169 <span class="var-type">mixed</span>
170 <span class="var-name">$_csv_headers</span>
171 = <span class="var-default">array()</span> (line <span class="line-number">51</span>)
172 </span>
173 </div>
174
175 <!-- ========== Info from phpDoc block ========= -->
176 <p class="short-description">this holds the headers read</p>
177 <p class="description"><p>from the top of the csv file</p></p>
178
179
180
181
182
183 </div>
184 <a name="var$_filename" id="$_filename"><!-- --></A>
185 <div class="evenrow">
186
187 <div class="var-header">
188 <span class="var-title">
189 <span class="var-type">mixed</span>
190 <span class="var-name">$_filename</span>
191 = <span class="var-default"> NULL</span> (line <span class="line-number">38</span>)
192 </span>
193 </div>
194
195 <!-- ========== Info from phpDoc block ========= -->
196 <p class="short-description">The csv file name/path on disk</p>
197
198
199
200
201
202 </div>
203 <a name="var$_fp" id="$_fp"><!-- --></A>
204 <div class="oddrow">
205
206 <div class="var-header">
207 <span class="var-title">
208 <span class="var-type">mixed</span>
209 <span class="var-name">$_fp</span>
210 = <span class="var-default"> NULL</span> (line <span class="line-number">44</span>)
211 </span>
212 </div>
213
214 <!-- ========== Info from phpDoc block ========= -->
215 <p class="short-description">The file descriptor pointer</p>
216
217
218
219
220
221 </div>
222 <a name="var$_maxlinelength" id="$_maxlinelength"><!-- --></A>
223 <div class="evenrow">
224
225 <div class="var-header">
226 <span class="var-title">
227 <span class="var-type">mixed</span>
228 <span class="var-name">$_maxlinelength</span>
229 = <span class="var-default">4096</span> (line <span class="line-number">58</span>)
230 </span>
231 </div>
232
233 <!-- ========== Info from phpDoc block ========= -->
234 <p class="short-description">The length of the longest</p>
235 <p class="description"><p>line in the csv file (so we read the line properly)</p></p>
236
237
238
239
240
241 </div>
242 <h4>Inherited Variables</h4>
243 <A NAME='inherited_vars'><!-- --></A>
244 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
245 <blockquote>
246 <span class="var-title">
247 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br>
248 </span>
249 <span class="var-title">
250 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br>
251 </span>
252 <span class="var-title">
253 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br>
254 </span>
255 <span class="var-title">
256 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br>
257 </span>
258 <span class="var-title">
259 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br>
260 </span>
261 </blockquote>
262
263 </div>
264 </div>
265
266 <a name="sec-methods"></a>
267 <div class="info-box">
268 <div class="info-box-title">Methods</div>
269 <div class="nav-bar">
270 <a href="#sec-description">Description</a> |
271 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
272 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
273
274 </div>
275 <div class="info-box-body">
276 <A NAME='method_detail'></A>
277 <a name="methodCSVFILEDataListSource" id="CSVFILEDataListSource"><!-- --></a>
278 <div class="oddrow">
279
280 <div class="method-header">
281 <span class="method-title">Constructor CSVFILEDataListSource</span> (line <span class="line-number">69</span>)
282 </div>
283
284 <!-- ========== Info from phpDoc block ========= -->
285 <p class="short-description">The constructor.</p>
286
287 <div class="method-signature">
288 <span class="method-result">void</span>
289 <span class="method-name">
290 CSVFILEDataListSource
291 </span>
292 (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$maxline</span> = <span class="var-default">4096</span>])
293 </div>
294
295 <ul class="parameters">
296 <li>
297 <span class="var-type">string</span>
298 <span class="var-name">$filename</span><span class="var-description">: <p>- the path to the CSV file on on disk to use as the data source.</p></span> </li>
299 </ul>
300
301
302 </div>
303 <a name="methodadd_data_row" id="add_data_row"><!-- --></a>
304 <div class="evenrow">
305
306 <div class="method-header">
307 <span class="method-title">add_data_row</span> (line <span class="line-number">192</span>)
308 </div>
309
310 <!-- ========== Info from phpDoc block ========= -->
311 <p class="short-description">This function adds a row of data</p>
312 <p class="description"><p>if necesarry to the data array</p></p>
313
314 <div class="method-signature">
315 <span class="method-result">void</span>
316 <span class="method-name">
317 add_data_row
318 </span>
319 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$row</span>)
320 </div>
321
322
323
324 </div>
325 <a name="methodcmp" id="cmp"><!-- --></a>
326 <div class="oddrow">
327
328 <div class="method-header">
329 <span class="method-title">cmp</span> (line <span class="line-number">221</span>)
330 </div>
331
332 <!-- ========== Info from phpDoc block ========= -->
333
334 <div class="method-signature">
335 <span class="method-result">void</span>
336 <span class="method-name">
337 cmp
338 </span>
339 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data1</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$data2</span>)
340 </div>
341
342
343
344 </div>
345 <a name="methoddo_prequery" id="do_prequery"><!-- --></a>
346 <div class="evenrow">
347
348 <div class="method-header">
349 <span class="method-title">do_prequery</span> (line <span class="line-number">90</span>)
350 </div>
351
352 <!-- ========== Info from phpDoc block ========= -->
353 <p class="short-description">The prequery. We use this to read the file</p>
354 <p class="description"><p>into memory so we can do operations on the data (search, sort, etc.)</p></p>
355
356 <div class="method-signature">
357 <span class="method-result">void</span>
358 <span class="method-name">
359 do_prequery
360 </span>
361 ()
362 </div>
363
364
365 <hr class="separator" />
366 <div class="notes">Redefinition of:</div>
367 <dl>
368 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></dt>
369 <dd>This is a method that should be defined by the child class to do any pre-query type of things.</dd>
370 </dl>
371
372 </div>
373 <a name="methoddo_query" id="do_query"><!-- --></a>
374 <div class="oddrow">
375
376 <div class="method-header">
377 <span class="method-title">do_query</span> (line <span class="line-number">98</span>)
378 </div>
379
380 <!-- ========== Info from phpDoc block ========= -->
381 <p class="short-description">This function does the query</p>
382 <p class="description"><p>and search/sort</p></p>
383
384 <div class="method-signature">
385 <span class="method-result">void</span>
386 <span class="method-name">
387 do_query
388 </span>
389 ()
390 </div>
391
392
393 <hr class="separator" />
394 <div class="notes">Redefinition of:</div>
395 <dl>
396 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></dt>
397 <dd>This is the function that does the data fetching, and sorting if needed.</dd>
398 </dl>
399
400 </div>
401 <a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a>
402 <div class="evenrow">
403
404 <div class="method-header">
405 <span class="method-title">get_next_data_row</span> (line <span class="line-number">122</span>)
406 </div>
407
408 <!-- ========== Info from phpDoc block ========= -->
409 <p class="short-description">This function returns the next row of valid data.</p>
410
411 <div class="method-signature">
412 <span class="method-result">void</span>
413 <span class="method-name">
414 get_next_data_row
415 </span>
416 ()
417 </div>
418
419
420 <hr class="separator" />
421 <div class="notes">Redefinition of:</div>
422 <dl>
423 <dt><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></dt>
424 <dd>This function gets the next data row from the query()</dd>
425 </dl>
426
427 </div>
428 <a name="methodsort" id="sort"><!-- --></a>
429 <div class="oddrow">
430
431 <div class="method-header">
432 <span class="method-title">sort</span> (line <span class="line-number">211</span>)
433 </div>
434
435 <!-- ========== Info from phpDoc block ========= -->
436
437 <div class="method-signature">
438 <span class="method-result">void</span>
439 <span class="method-name">
440 sort
441 </span>
442 ()
443 </div>
444
445
446 <hr class="separator" />
447 <div class="notes">Redefinition of:</div>
448 <dl>
449 <dt><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></dt>
450 <dd>A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database.</dd>
451 </dl>
452
453 </div>
454 <a name="method_construct_row" id="_construct_row"><!-- --></a>
455 <div class="evenrow">
456
457 <div class="method-header">
458 <span class="method-title">_construct_row</span> (line <span class="line-number">169</span>)
459 </div>
460
461 <!-- ========== Info from phpDoc block ========= -->
462 <p class="short-description">this is used to build a row from a csv line</p>
463
464 <div class="method-signature">
465 <span class="method-result">array</span>
466 <span class="method-name">
467 _construct_row
468 </span>
469 (<span class="var-type">string</span>&nbsp;<span class="var-name">$line</span>)
470 </div>
471
472 <ul class="parameters">
473 <li>
474 <span class="var-type">string</span>
475 <span class="var-name">$line</span><span class="var-description">: <p>- the original csv line from the file</p></span> </li>
476 </ul>
477
478
479 </div>
480 <a name="method_find_data" id="_find_data"><!-- --></a>
481 <div class="oddrow">
482
483 <div class="method-header">
484 <span class="method-title">_find_data</span> (line <span class="line-number">230</span>)
485 </div>
486
487 <!-- ========== Info from phpDoc block ========= -->
488
489 <div class="method-signature">
490 <span class="method-result">void</span>
491 <span class="method-name">
492 _find_data
493 </span>
494 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$row_data</span>)
495 </div>
496
497
498
499 </div>
500 <a name="method_get_header" id="_get_header"><!-- --></a>
501 <div class="evenrow">
502
503 <div class="method-header">
504 <span class="method-title">_get_header</span> (line <span class="line-number">149</span>)
505 </div>
506
507 <!-- ========== Info from phpDoc block ========= -->
508 <p class="short-description">This file trys to get the CSV header.</p>
509
510 <div class="method-signature">
511 <span class="method-result">void</span>
512 <span class="method-name">
513 _get_header
514 </span>
515 ()
516 </div>
517
518
519
520 </div>
521 <h4>Inherited Methods</h4>
522 <a name='inherited_methods'><!-- --></a>
523 <!-- =========== Summary =========== -->
524 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
525 <blockquote>
526 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br>
527 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br>
528 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br>
529 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br>
530 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br>
531 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br>
532 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br>
533 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br>
534 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br>
535 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br>
536 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br>
537 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br>
538 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br>
539 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br>
540 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br>
541 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br>
542 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br>
543 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br>
544 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br>
545 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br>
546 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br>
547 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br>
548 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br>
549 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br>
550 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br>
551 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br>
552 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br>
553 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br>
554 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br>
555 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br>
556 </blockquote>
557
558 </div>
559 </div>
560
561 <p class="notes" id="credit">
562 Documention generated on Thu, 31 Jul 2003 18:32:20 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
563 </p>
564 </div></body>
565 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed