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

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

Parent Directory Parent Directory | Revision Log Revision Log

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