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