/[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.1 - (show annotations)
Thu Jan 30 03:29:35 2003 UTC (21 years, 7 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' -->
6 <TITLE>Docs For Class CSVFILEDataListSource</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from CSVFILEDataListSource">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class CSVFILEDataListSource
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
37 |
38 --CSVFILEDataListSource</pre>
39 </pre>
40
41 <A NAME="children_summary"</A>
42 <H3>
43 Classes extended from CSVFILEDataListSource: <A HREF="#top" CLASS="links">^TOP</A>
44 </H3>
45
46 <p>
47 <b><i>Located in File: Program_Root/widgets/data_list/CSVFILEDataListSource.inc</i></b><br>
48 </p>
49 <hr>
50 <!-- ========== Info from phpDoc block ========= -->
51 This DataListSource child class gets the data from a
52 CSV (comma seperated values) file on disk.
53 <BR>
54 The CSV MUST have a 'header' line before any data.
55 The 'header' line is a CSV line that provides a name
56 for each column of data in the file.
57
58 All lines that start with '#' or '//' are ignored as
59 comments.
60
61 <UL>
62
63 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
64
65 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
66
67 </UL>
68
69 <hr>
70 <!-- =========== VAR SUMMARY =========== -->
71 <A NAME='var_summary'><!-- --></A>
72 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
73 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
74 <TD>
75 <span CLASS="font12bold">Class Variable Summary</span>
76 <A HREF="#top" CLASS="links">^TOP</A>
77 </TD>
78 </TR>
79
80
81 <!-- =========== Summary =========== -->
82 <TR BGCOLOR='white' CLASS='TableRowColor'>
83 <TD>
84 <CODE><B><A HREF='CSVFILEDataListSource.html#$_csv_headers'>$_csv_headers</A></B></CODE>
85 <BR>
86 <blockquote> this holds the headers read </blockquote>
87 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
88 </TD>
89 </TR>
90
91 <!-- =========== Summary =========== -->
92 <TR BGCOLOR='white' CLASS='TableRowColor'>
93 <TD>
94 <CODE><B><A HREF='CSVFILEDataListSource.html#$_filename'>$_filename</A></B></CODE>
95 <BR>
96 <blockquote> The csv file name/path on disk </blockquote>
97 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
98 </TD>
99 </TR>
100
101 <!-- =========== Summary =========== -->
102 <TR BGCOLOR='white' CLASS='TableRowColor'>
103 <TD>
104 <CODE><B><A HREF='CSVFILEDataListSource.html#$_fp'>$_fp</A></B></CODE>
105 <BR>
106 <blockquote> The file descriptor pointer </blockquote>
107 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
108 </TD>
109 </TR>
110
111 <!-- =========== Summary =========== -->
112 <TR BGCOLOR='white' CLASS='TableRowColor'>
113 <TD>
114 <CODE><B><A HREF='CSVFILEDataListSource.html#$_maxlinelength'>$_maxlinelength</A></B></CODE>
115 <BR>
116 <blockquote> The length of the longest </blockquote>
117 <blockquote> Default Value: <CODE>->4096<-</CODE> </blockquote>
118 </TD>
119 </TR>
120
121 </TABLE>
122
123 <hr>
124 <!-- =========== VAR INHERITED SUMMARY =========== -->
125 <A NAME='var_inherited_summary'><!-- --></A>
126 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
127 <TR CLASS='TableHeadingColor'>
128 <TD>
129 <span CLASS="font12bold">Inherited Class Variable Summary</span>
130 <A HREF="#top" CLASS="links">^TOP</A>
131 </TD>
132 </TR>
133
134
135 <!-- =========== Summary =========== -->
136 <TR BGCOLOR='white'>
137 <TD>
138 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
139 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
140 <tr CLASS="tableheadingcolor">
141 <th>Variable</th>
142 <th>Default Value</th>
143 <th>Description</th>
144 </tr>
145
146 <tr>
147 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_columns'>$_columns</A></td>
148 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
149 <td CLASS="font10">The column descriptions
150 for the data we are working on</td>
151 </tr>
152
153 <tr>
154 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td>
155 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
156 <td CLASS="font10">A placeholder for data that is read/built</td>
157 </tr>
158
159 <tr>
160 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td>
161 <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>
162 <td CLASS="font10">Holds the index into the array of data</td>
163 </tr>
164
165 <tr>
166 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td>
167 <td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td>
168 <td CLASS="font10">This is the message displayed when no data</td>
169 </tr>
170
171 <tr>
172 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td>
173 <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;num_total_rows&quot; =&gt; 0,
174 &quot;offset&quot; =&gt; 0,
175 &quot;limit&quot; =&gt; -1,
176 &quot;orderby&quot; =&gt; '',
177 &quot;reverseorder&quot; =&gt; '',
178 &quot;searchby&quot; =&gt; '',
179 &quot;searchvalue&quot; =&gt; '',
180 &quot;searchmodifier&quot; =&gt; '',
181 &quot;searchtype&quot; =&gt; 'simple')<-</td>
182 <td CLASS="font10">This holds various parameters relating
183 to the query of the data</td>
184 </tr>
185
186 </table>
187 <BR>
188 </TD>
189 </TR>
190
191 </TABLE>
192
193 <hr>
194 <!-- =========== INHERITED METHOD SUMMARY =========== -->
195 <A NAME='functions_inherited'><!-- --></A>
196 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
197 <TR CLASS='TableHeadingColor'>
198 <TD>
199 <span CLASS="font12bold">Inherited Method Summary</span>
200 <A HREF="#top" CLASS="links">^TOP</A>
201 </TD>
202 </TR>
203
204
205 <!-- =========== Summary =========== -->
206 <TR BGCOLOR='white' CLASS='TableRowColor'>
207 <TD>
208 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
209 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
210 <tr CLASS="tableheadingcolor">
211 <th>Function</th>
212 <th>Description</th>
213 </tr>
214
215 <tr>
216 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#constructor DataListSource'>constructor DataListSource ( )</A></td>
217 <td CLASS="font10">The constructor</td>
218
219 <tr>
220 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td>
221 <td CLASS="font10">Add a column of data to manage</td>
222
223 <tr>
224 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery ( )</A></td>
225 <td CLASS="font10">This is a method that should be defined by the
226 child class to do any pre-query type of things.</td>
227
228 <tr>
229 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query ( )</A></td>
230 <td CLASS="font10">This is the function that does the data fetching,
231 and sorting if needed.</td>
232
233 <tr>
234 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index ( )</A></td>
235 <td CLASS="font10">This function returns the
236 data_index value and increments it</td>
237
238 <tr>
239 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit ( )</A></td>
240 <td CLASS="font10">This function gets the current
241 value of the limit value</td>
242
243 <tr>
244 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row ( )</A></td>
245 <td CLASS="font10">This function gets the next data row
246 from the query()</td>
247
248 <tr>
249 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message ( )</A></td>
250 <td CLASS="font10">This function is used to get the
251 message displayed when no data is found</td>
252
253 <tr>
254 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset ( )</A></td>
255 <td CLASS="font10">This function returns the value of the
256 offset</td>
257
258 <tr>
259 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby ( )</A></td>
260 <td CLASS="font10">This function returns the value of the
261 orderby</td>
262
263 <tr>
264 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder ( )</A></td>
265 <td CLASS="font10">This function returns the value of the
266 reverseorder</td>
267
268 <tr>
269 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby ( )</A></td>
270 <td CLASS="font10">This function returns the value of the
271 searchby</td>
272
273 <tr>
274 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value ( )</A></td>
275 <td CLASS="font10">This function returns the value of the
276 search value</td>
277
278 <tr>
279 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type ( )</A></td>
280 <td CLASS="font10">this function returns the current search type
281 for the DataList query</td>
282
283 <tr>
284 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier ( )</A></td>
285 <td CLASS="font10">This function returns the value of the
286 search value</td>
287
288 <tr>
289 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows ( )</A></td>
290 <td CLASS="font10">This returns the total number of rows
291 in our entire data set</td>
292
293 <tr>
294 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td>
295 <td CLASS="font10">The main Query function.</td>
296
297 <tr>
298 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td>
299 <td CLASS="font10">This function is used to set</td>
300
301 <tr>
302 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>
303 <td CLASS="font10">This function is used to set the
304 message displayed when no data is found</td>
305
306 <tr>
307 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td>
308 <td CLASS="font10">This sets the offset value</td>
309
310 <tr>
311 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td>
312 <td CLASS="font10">This sets the orderby column name.</td>
313
314 <tr>
315 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td>
316 <td CLASS="font10">This sets the flag that tells us the
317 direction in which to order the orderby
318 column.</td>
319
320 <tr>
321 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td>
322 <td CLASS="font10">This sets the column that we want to search
323 from.</td>
324
325 <tr>
326 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td>
327 <td CLASS="font10">This sets the data that we want to search
328 for.</td>
329
330 <tr>
331 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td>
332 <td CLASS="font10">This function sets the search type
333 (simple or advanced)</td>
334
335 <tr>
336 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td>
337 <td CLASS="font10">This sets the simple search modifier</td>
338
339 <tr>
340 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td>
341 <td CLASS="font10">This is used to set the total # of
342 rows we have in our data set</td>
343
344 <tr>
345 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort ( )</A></td>
346 <td CLASS="font10">A generic method API that can be used at the bottom
347 half of the do_query() method to sort data that is
348 stored locally.</td>
349
350 <tr>
351 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td>
352 <td CLASS="font10">This function determines if the column</td>
353
354 </table>
355 <br>
356 </TD>
357 </TR>
358
359 </TABLE>
360
361 <hr>
362 <!-- should have constructor at some point -->
363 <!-- =========== Method SUMMARY =========== -->
364 <A NAME='Method_summary'><!-- --></A>
365 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
366 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
367 <TD>
368 <span class="font12bold">Method Summary</span>
369 <A HREF="#top" CLASS="links">^TOP</A>
370 </TD>
371 </TR>
372
373
374 <!-- =========== Summary =========== -->
375 <TR BGCOLOR='white' CLASS='TableRowColor'>
376 <TD>
377 <CODE><B><A HREF='CSVFILEDataListSource.html#constructor CSVFILEDataListSource'>void constructor CSVFILEDataListSource ( $filename, [$maxline = 4096] )</A></B></CODE>
378 <BR>
379 <blockquote> The constructor. </blockquote>
380 </TD>
381 </TR>
382
383 <!-- =========== Summary =========== -->
384 <TR BGCOLOR='white' CLASS='TableRowColor'>
385 <TD>
386 <CODE><B><A HREF='CSVFILEDataListSource.html#add_data_row'>void add_data_row ( $row )</A></B></CODE>
387 <BR>
388 <blockquote> This function adds a row of data
389 if necesarry to the data array </blockquote>
390 </TD>
391 </TR>
392
393 <!-- =========== Summary =========== -->
394 <TR BGCOLOR='white' CLASS='TableRowColor'>
395 <TD>
396 <CODE><B><A HREF='CSVFILEDataListSource.html#cmp'>void cmp ( $data1, $data2 )</A></B></CODE>
397 <BR>
398 <blockquote> </blockquote>
399 </TD>
400 </TR>
401
402 <!-- =========== Summary =========== -->
403 <TR BGCOLOR='white' CLASS='TableRowColor'>
404 <TD>
405 <CODE><B><A HREF='CSVFILEDataListSource.html#do_prequery'>void do_prequery ( )</A></B></CODE>
406 <BR>
407 <blockquote> The prequery. </blockquote>
408 </TD>
409 </TR>
410
411 <!-- =========== Summary =========== -->
412 <TR BGCOLOR='white' CLASS='TableRowColor'>
413 <TD>
414 <CODE><B><A HREF='CSVFILEDataListSource.html#do_query'>void do_query ( )</A></B></CODE>
415 <BR>
416 <blockquote> This function does the query </blockquote>
417 </TD>
418 </TR>
419
420 <!-- =========== Summary =========== -->
421 <TR BGCOLOR='white' CLASS='TableRowColor'>
422 <TD>
423 <CODE><B><A HREF='CSVFILEDataListSource.html#get_next_data_row'>void get_next_data_row ( )</A></B></CODE>
424 <BR>
425 <blockquote> This function returns the next row of
426 valid data. </blockquote>
427 </TD>
428 </TR>
429
430 <!-- =========== Summary =========== -->
431 <TR BGCOLOR='white' CLASS='TableRowColor'>
432 <TD>
433 <CODE><B><A HREF='CSVFILEDataListSource.html#sort'>void sort ( )</A></B></CODE>
434 <BR>
435 <blockquote> </blockquote>
436 </TD>
437 </TR>
438
439 <!-- =========== Summary =========== -->
440 <TR BGCOLOR='white' CLASS='TableRowColor'>
441 <TD>
442 <CODE><B><A HREF='CSVFILEDataListSource.html#_construct_row'>array _construct_row ( $line )</A></B></CODE>
443 <BR>
444 <blockquote> this is used to build a row
445 from a csv line </blockquote>
446 </TD>
447 </TR>
448
449 <!-- =========== Summary =========== -->
450 <TR BGCOLOR='white' CLASS='TableRowColor'>
451 <TD>
452 <CODE><B><A HREF='CSVFILEDataListSource.html#_find_data'>void _find_data ( $row_data )</A></B></CODE>
453 <BR>
454 <blockquote> </blockquote>
455 </TD>
456 </TR>
457
458 <!-- =========== Summary =========== -->
459 <TR BGCOLOR='white' CLASS='TableRowColor'>
460 <TD>
461 <CODE><B><A HREF='CSVFILEDataListSource.html#_get_header'>void _get_header ( )</A></B></CODE>
462 <BR>
463 <blockquote> This file trys to get the CSV header. </blockquote>
464 </TD>
465 </TR>
466
467 </TABLE>
468
469 <hr>
470 <!-- ============ VARIABLE DETAIL =========== -->
471
472 <A NAME='variable_detail'></A>
473 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
474 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
475 <TD>
476 <span CLASS="font12bold">Variable Detail</span>
477 <A HREF="#top" CLASS="links">^TOP</A>
478 </TD>
479 </TR>
480 </TABLE>
481
482
483 <A NAME='$_csv_headers'><!-- --></A><H3>$_csv_headers</H3>
484 <b>Data type:</b> mixed<br>
485 <!-- ========== Info from phpDoc block ========= -->
486 this holds the headers read
487 <BR>
488 from the top of the csv file
489
490 <UL>
491
492 </UL>
493
494 <HR>
495
496 <A NAME='$_filename'><!-- --></A><H3>$_filename</H3>
497 <b>Data type:</b> mixed<br>
498 <!-- ========== Info from phpDoc block ========= -->
499 The csv file name/path on disk
500 <BR>
501
502
503 <UL>
504
505 </UL>
506
507 <HR>
508
509 <A NAME='$_fp'><!-- --></A><H3>$_fp</H3>
510 <b>Data type:</b> mixed<br>
511 <!-- ========== Info from phpDoc block ========= -->
512 The file descriptor pointer
513 <BR>
514
515
516 <UL>
517
518 </UL>
519
520 <HR>
521
522 <A NAME='$_maxlinelength'><!-- --></A><H3>$_maxlinelength</H3>
523 <b>Data type:</b> mixed<br>
524 <!-- ========== Info from phpDoc block ========= -->
525 The length of the longest
526 <BR>
527 line in the csv file
528 (so we read the line properly)
529
530 <UL>
531
532 </UL>
533
534 <HR>
535
536
537 <hr>
538 <!-- ============ FUNCTION DETAIL =========== -->
539
540 <A NAME='function_detail'></A>
541 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
542 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
543 <TD>
544 <span class="font12bold">Method Detail</span>
545 <A HREF="#top" CLASS="links">^TOP</A>
546 </TD>
547 </TR>
548 </TABLE>
549 <BR>
550
551 <DIV CLASS="function">
552 <A NAME='constructor CSVFILEDataListSource'><!-- --></A>
553 <SPAN CLASS="font12bold">constructor CSVFILEDataListSource</SPAN>
554 <BR>
555 <SPAN CLASS="font10bold">Useage : </SPAN>
556 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
557 <span class="font10bold" style="color: #0000FF">constructor CSVFILEDataListSource ( $filename, [$maxline = 4096] )</SPAN>
558 <BR>
559
560 <BR>
561 <SPAN CLASS="font10bold">Description : </SPAN>
562 <!-- ========== Info from phpDoc block ========= -->
563 The constructor.
564 <BR>
565
566 <DL>
567 <DT class="font10bold">Function Parameters:</DT>
568
569 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$filename</SPAN></SPAN> - the path to the CSV file on
570 on disk to use as the data source.</DD>
571
572
573 <DT class="font10bold">Function Info:</DT>
574
575 </DL>
576
577 </DIV>
578 <BR>
579
580 <DIV CLASS="function">
581 <A NAME='add_data_row'><!-- --></A>
582 <SPAN CLASS="font12bold">add_data_row</SPAN>
583 <BR>
584 <SPAN CLASS="font10bold">Useage : </SPAN>
585 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
586 <span class="font10bold" style="color: #0000FF">add_data_row ( $row )</SPAN>
587 <BR>
588
589 <BR>
590 <SPAN CLASS="font10bold">Description : </SPAN>
591 <!-- ========== Info from phpDoc block ========= -->
592 This function adds a row of data
593 if necesarry to the data array
594 <BR>
595
596 <DL>
597 <DT class="font10bold">Function Parameters:</DT>
598
599
600 <DT class="font10bold">Function Info:</DT>
601
602 </DL>
603
604 </DIV>
605 <BR>
606
607 <DIV CLASS="function">
608 <A NAME='cmp'><!-- --></A>
609 <SPAN CLASS="font12bold">cmp</SPAN>
610 <BR>
611 <SPAN CLASS="font10bold">Useage : </SPAN>
612 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
613 <span class="font10bold" style="color: #0000FF">cmp ( $data1, $data2 )</SPAN>
614 <BR>
615
616 <BR>
617 <SPAN CLASS="font10bold">Description : </SPAN>
618 <!-- ========== Info from phpDoc block ========= -->
619
620 <BR>
621
622 <DL>
623 <DT class="font10bold">Function Parameters:</DT>
624
625
626 <DT class="font10bold">Function Info:</DT>
627
628 </DL>
629
630 </DIV>
631 <BR>
632
633 <DIV CLASS="function">
634 <A NAME='do_prequery'><!-- --></A>
635 <SPAN CLASS="font12bold">do_prequery</SPAN>
636 <BR>
637 <SPAN CLASS="font10bold">Useage : </SPAN>
638 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
639 <span class="font10bold" style="color: #0000FF">do_prequery ( )</SPAN>
640 <BR>
641 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_prequery">DataListSource::do_prequery()</a>
642 <BR>
643 <SPAN CLASS="font10bold">Description : </SPAN>
644 <!-- ========== Info from phpDoc block ========= -->
645 The prequery.
646 <BR>
647 We use this to read the file
648 into memory so we can do operations on the data
649 (search, sort, etc.)
650 <DL>
651 <DT class="font10bold">Function Parameters:</DT>
652
653
654 <DT class="font10bold">Function Info:</DT>
655
656 </DL>
657
658 </DIV>
659 <BR>
660
661 <DIV CLASS="function">
662 <A NAME='do_query'><!-- --></A>
663 <SPAN CLASS="font12bold">do_query</SPAN>
664 <BR>
665 <SPAN CLASS="font10bold">Useage : </SPAN>
666 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
667 <span class="font10bold" style="color: #0000FF">do_query ( )</SPAN>
668 <BR>
669 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_query">DataListSource::do_query()</a>
670 <BR>
671 <SPAN CLASS="font10bold">Description : </SPAN>
672 <!-- ========== Info from phpDoc block ========= -->
673 This function does the query
674 <BR>
675 and search/sort
676 <DL>
677 <DT class="font10bold">Function Parameters:</DT>
678
679
680 <DT class="font10bold">Function Info:</DT>
681
682 </DL>
683
684 </DIV>
685 <BR>
686
687 <DIV CLASS="function">
688 <A NAME='get_next_data_row'><!-- --></A>
689 <SPAN CLASS="font12bold">get_next_data_row</SPAN>
690 <BR>
691 <SPAN CLASS="font10bold">Useage : </SPAN>
692 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
693 <span class="font10bold" style="color: #0000FF">get_next_data_row ( )</SPAN>
694 <BR>
695 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#get_next_data_row">DataListSource::get_next_data_row()</a>
696 <BR>
697 <SPAN CLASS="font10bold">Description : </SPAN>
698 <!-- ========== Info from phpDoc block ========= -->
699 This function returns the next row of
700 valid data.
701 <BR>
702
703 <DL>
704 <DT class="font10bold">Function Parameters:</DT>
705
706
707 <DT class="font10bold">Function Info:</DT>
708
709 </DL>
710
711 </DIV>
712 <BR>
713
714 <DIV CLASS="function">
715 <A NAME='sort'><!-- --></A>
716 <SPAN CLASS="font12bold">sort</SPAN>
717 <BR>
718 <SPAN CLASS="font10bold">Useage : </SPAN>
719 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
720 <span class="font10bold" style="color: #0000FF">sort ( )</SPAN>
721 <BR>
722 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#sort">DataListSource::sort()</a>
723 <BR>
724 <SPAN CLASS="font10bold">Description : </SPAN>
725 <!-- ========== Info from phpDoc block ========= -->
726
727 <BR>
728
729 <DL>
730 <DT class="font10bold">Function Parameters:</DT>
731
732
733 <DT class="font10bold">Function Info:</DT>
734
735 </DL>
736
737 </DIV>
738 <BR>
739
740 <DIV CLASS="function">
741 <A NAME='_construct_row'><!-- --></A>
742 <SPAN CLASS="font12bold">_construct_row</SPAN>
743 <BR>
744 <SPAN CLASS="font10bold">Useage : </SPAN>
745 <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
746 <span class="font10bold" style="color: #0000FF">_construct_row ( $line )</SPAN>
747 <BR>
748
749 <BR>
750 <SPAN CLASS="font10bold">Description : </SPAN>
751 <!-- ========== Info from phpDoc block ========= -->
752 this is used to build a row
753 from a csv line
754 <BR>
755
756 <DL>
757 <DT class="font10bold">Function Parameters:</DT>
758
759 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$line</SPAN></SPAN> - the original csv line from the file</DD>
760
761
762 <DT class="font10bold">Function Info:</DT>
763
764 </DL>
765
766 </DIV>
767 <BR>
768
769 <DIV CLASS="function">
770 <A NAME='_find_data'><!-- --></A>
771 <SPAN CLASS="font12bold">_find_data</SPAN>
772 <BR>
773 <SPAN CLASS="font10bold">Useage : </SPAN>
774 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
775 <span class="font10bold" style="color: #0000FF">_find_data ( $row_data )</SPAN>
776 <BR>
777
778 <BR>
779 <SPAN CLASS="font10bold">Description : </SPAN>
780 <!-- ========== Info from phpDoc block ========= -->
781
782 <BR>
783
784 <DL>
785 <DT class="font10bold">Function Parameters:</DT>
786
787
788 <DT class="font10bold">Function Info:</DT>
789
790 </DL>
791
792 </DIV>
793 <BR>
794
795 <DIV CLASS="function">
796 <A NAME='_get_header'><!-- --></A>
797 <SPAN CLASS="font12bold">_get_header</SPAN>
798 <BR>
799 <SPAN CLASS="font10bold">Useage : </SPAN>
800 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
801 <span class="font10bold" style="color: #0000FF">_get_header ( )</SPAN>
802 <BR>
803
804 <BR>
805 <SPAN CLASS="font10bold">Description : </SPAN>
806 <!-- ========== Info from phpDoc block ========= -->
807 This file trys to get the CSV header.
808 <BR>
809
810 <DL>
811 <DT class="font10bold">Function Parameters:</DT>
812
813
814 <DT class="font10bold">Function Info:</DT>
815
816 </DL>
817
818 </DIV>
819 <BR>
820
821
822 <hr>
823 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed