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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by jonen, Thu Jan 30 03:29:35 2003 UTC revision 1.2 by jonen, Sat Feb 22 20:56:16 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2  <!--NewPage-->  <!--NewPage-->
3  <HTML>  <HTML>
4  <HEAD>  <HEAD>
5          <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' -->          <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:33 -0800' -->
6          <TITLE>Docs For Class CSVFILEDataListSource</TITLE>          <TITLE>Docs For Class CSVFILEDataListSource</TITLE>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>  <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8  </HEAD>  </HEAD>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
       
   
10  <!-- Links -->  <!-- Links -->
11  <a NAME="top"></A>  <a NAME="top"></A>
12  <table WIDTH="100%" class="links">  <table WIDTH="100%" class="links">
# Line 18  Line 16 
16        <A HREF="#children_summary" class="links" title="Classes extended from CSVFILEDataListSource">Child Classes</A>        <A HREF="#children_summary" class="links" title="Classes extended from CSVFILEDataListSource">Child Classes</A>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20        <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23     </TD>     </TD>
24   </TR>   </TR>
25  </TABLE>  </TABLE>
26  <BR>  <BR>
   
27  <!-- Start of Class Data -->  <!-- Start of Class Data -->
28  <H2>  <H2>
29          Class CSVFILEDataListSource          Class CSVFILEDataListSource
30  </H2>  </H2> (line <span class="linenumber">31</span>)
   
31  <pre>  <pre>
32  <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>  <a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
33     |     |
34     --CSVFILEDataListSource</pre>     --CSVFILEDataListSource</pre>
 </pre>  
   
 <A NAME="children_summary"</A>  
 <H3>  
         Classes extended from CSVFILEDataListSource: <A HREF="#top" CLASS="links">^TOP</A>  
 </H3>  
   
35  <p>  <p>
36          <b><i>Located in File: Program_Root/widgets/data_list/CSVFILEDataListSource.inc</i></b><br>          <b><i>Located in File: Program_Root/widgets/data_list/CSVFILEDataListSource.inc</i></b><br>
37  </p>  </p>
38  <hr>  <hr>
39  <!-- ========== Info from phpDoc block ========= -->  This DataListSource child class gets the data from a  CSV (comma seperated values) file on disk.
40  This DataListSource child class gets the data from a  <br />
41  CSV (comma seperated values) file on disk.  <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>
 <BR>  
 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.  
   
 All lines that start with '#' or '//' are ignored as  
 comments.  
   
42  <UL>  <UL>
43                            <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
44          <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>          </UL>
           
         <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
           
 </UL>  
   
45  <hr>  <hr>
46  <!-- =========== VAR SUMMARY =========== -->  <!-- =========== VAR SUMMARY =========== -->
47  <A NAME='var_summary'><!-- --></A>  <A NAME='var_summary'><!-- --></A>
# Line 77  comments. Line 53  comments.
53                  </TD>                  </TD>
54          </TR>          </TR>
55    
56                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
57          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
58                  <TD>                  <TD>
59                          <CODE><B><A HREF='CSVFILEDataListSource.html#$_csv_headers'>$_csv_headers</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/CSVFILEDataListSource.html#var$_csv_headers">$_csv_headers</A></B></CODE>
60                          <BR>                          <BR>
61                          <blockquote> this holds the headers read </blockquote>                          <blockquote> this holds the headers read </blockquote>
62                          <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
63                  </TD>                  </TD>
64          </TR>          </TR>
65                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
66          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
67                  <TD>                  <TD>
68                          <CODE><B><A HREF='CSVFILEDataListSource.html#$_filename'>$_filename</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/CSVFILEDataListSource.html#var$_filename">$_filename</A></B></CODE>
69                          <BR>                          <BR>
70                          <blockquote> The csv file name/path on disk </blockquote>                          <blockquote> The csv file name/path on disk </blockquote>
71                          <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
72                  </TD>                  </TD>
73          </TR>          </TR>
74                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
75          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
76                  <TD>                  <TD>
77                          <CODE><B><A HREF='CSVFILEDataListSource.html#$_fp'>$_fp</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/CSVFILEDataListSource.html#var$_fp">$_fp</A></B></CODE>
78                          <BR>                          <BR>
79                          <blockquote> The file descriptor pointer </blockquote>                          <blockquote> The file descriptor pointer </blockquote>
80                          <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
81                  </TD>                  </TD>
82          </TR>          </TR>
83                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
84          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
85                  <TD>                  <TD>
86                          <CODE><B><A HREF='CSVFILEDataListSource.html#$_maxlinelength'>$_maxlinelength</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/CSVFILEDataListSource.html#var$_maxlinelength">$_maxlinelength</A></B></CODE>
87                          <BR>                          <BR>
88                          <blockquote> The length of the longest </blockquote>                          <blockquote> The length of the longest </blockquote>
89                          <blockquote> Default Value: <CODE>->4096<-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->4096<-</CODE> </blockquote>
90                  </TD>                  </TD>
91          </TR>          </TR>
92                    </TABLE>
 </TABLE>  
   
93  <hr>  <hr>
94  <!-- =========== VAR INHERITED SUMMARY =========== -->  <!-- =========== VAR INHERITED SUMMARY =========== -->
95  <A NAME='var_inherited_summary'><!-- --></A>  <A NAME='var_inherited_summary'><!-- --></A>
96  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
97          <TR CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
98                  <TD>                  <TD>
99                          <span CLASS="font12bold">Inherited Class Variable Summary</span>                          <span CLASS="font12bold">Inherited Class Variable Summary</span>
100              <A HREF="#top" CLASS="links">^TOP</A>              <A HREF="#top" CLASS="links">^TOP</A>
101                  </TD>                  </TD>
102          </TR>          </TR>
103    
104                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
105          <TR BGCOLOR='white'>          <TR BGCOLOR='white'>
106                  <TD>                  <TD>
107                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
# Line 142  comments. Line 111  comments.
111                                  <th>Default Value</th>                                  <th>Default Value</th>
112                                  <th>Description</th>                                  <th>Description</th>
113                          </tr>                          </tr>
114                                                                                            <tr>
115                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></td>
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_columns'>$_columns</A></td>  
116                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
117                                  <td CLASS="font10">The column descriptions                                  <td CLASS="font10">The column descriptions  for the data we are working on</td>
 for the data we are working on</td>  
118                          </tr>                          </tr>
119                                                                                            <tr>
120                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></td>
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td>  
121                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
122                                  <td CLASS="font10">A placeholder for data that is read/built</td>                                  <td CLASS="font10">A placeholder for data that is read/built  and stored locally.  Not all data sources  have to use this.</td>
123                          </tr>                          </tr>
124                                                                                            <tr>
125                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></td>
126                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td>                                  <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
                                 <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>  
127                                  <td CLASS="font10">Holds the index into the array of data</td>                                  <td CLASS="font10">Holds the index into the array of data</td>
128                          </tr>                          </tr>
129                                                                                            <tr>
130                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></td>
131                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td>                                  <td CLASS="font10" STYLE="white-space: nowrap">-> "No data was found"<-</td>
                                 <td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td>  
132                                  <td CLASS="font10">This is the message displayed when no data</td>                                  <td CLASS="font10">This is the message displayed when no data</td>
133                          </tr>                          </tr>
134                                                                                            <tr>
135                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></td>
136                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td>                                  <td CLASS="font10" STYLE="white-space: nowrap">->array("num_total_rows" =&gt; 0,
137                                  <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;num_total_rows&quot; =&gt; 0,                                                             "offset" =&gt; 0,
138                                                             &quot;offset&quot; =&gt; 0,                                                             "limit" =&gt; -1,
139                                                             &quot;limit&quot; =&gt; -1,                                                             "orderby" =&gt; '',
140                                                             &quot;orderby&quot; =&gt; '',                                                             "reverseorder" =&gt; '',
141                                                             &quot;reverseorder&quot; =&gt; '',                                                             "searchby" =&gt; '',
142                                                             &quot;searchby&quot; =&gt; '',                                                             "searchvalue" =&gt; '',
143                                                             &quot;searchvalue&quot; =&gt; '',                                                             "searchmodifier" =&gt; '',
144                                                             &quot;searchmodifier&quot; =&gt; '',                                                             "searchtype" =&gt; 'simple')<-</td>
145                                                             &quot;searchtype&quot; =&gt; 'simple')<-</td>                                  <td CLASS="font10">This holds various parameters relating</td>
                                 <td CLASS="font10">This holds various parameters relating  
 to the query of the data</td>  
146                          </tr>                          </tr>
147                                                                                            </table>
                         </table>  
148              <BR>              <BR>
149          </TD>          </TD>
150          </TR>          </TR>
151                    </TABLE>
 </TABLE>  
152    
153  <hr>  <hr>
154  <!-- =========== INHERITED METHOD SUMMARY =========== -->  <!-- =========== METHOD SUMMARY =========== -->
155  <A NAME='functions_inherited'><!-- --></A>  <A NAME='method_summary'><!-- --></A>
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#constructor DataListSource'>constructor DataListSource (  )</A></td>  
                                         <td CLASS="font10">The constructor</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td>  
                                         <td CLASS="font10">Add a column of data to manage</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery (  )</A></td>  
                                         <td CLASS="font10">This is a method that should be defined by the  
 child class to do any pre-query type of things.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query (  )</A></td>  
                                         <td CLASS="font10">This is the function that does the data fetching,  
 and sorting if needed.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index (  )</A></td>  
                                         <td CLASS="font10">This function returns the  
 data_index value and increments it</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit (  )</A></td>  
                                         <td CLASS="font10">This function gets the current  
 value of the limit value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row (  )</A></td>  
                                         <td CLASS="font10">This function gets the next data row  
 from the query()</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message (  )</A></td>  
                                         <td CLASS="font10">This function is used to get the  
 message displayed when no data is found</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 offset</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 orderby</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 reverseorder</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 searchby</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 search value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type (  )</A></td>  
                                         <td CLASS="font10">this function returns the current search type  
 for the DataList query</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier (  )</A></td>  
                                         <td CLASS="font10">This function returns the value of the  
 search value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows (  )</A></td>  
                                         <td CLASS="font10">This returns the total number of rows  
 in our entire data set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td>  
                                         <td CLASS="font10">The main Query function.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td>  
                                         <td CLASS="font10">This function is used to set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>  
                                         <td CLASS="font10">This function is used to set the  
 message displayed when no data is found</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td>  
                                         <td CLASS="font10">This sets the offset value</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td>  
                                         <td CLASS="font10">This sets the orderby column name.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td>  
                                         <td CLASS="font10">This sets the flag that tells us the  
 direction in which to order the orderby  
 column.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td>  
                                         <td CLASS="font10">This sets the column that we want to search  
 from.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td>  
                                         <td CLASS="font10">This sets the data that we want to search  
 for.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td>  
                                         <td CLASS="font10">This function sets the search type  
 (simple or advanced)</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td>  
                                         <td CLASS="font10">This sets the simple search modifier</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td>  
                                         <td CLASS="font10">This is used to set the total # of  
 rows we have in our data set</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort (  )</A></td>  
                                         <td CLASS="font10">A generic method API that can be used at the bottom  
 half of the do_query() method to sort data that is  
 stored locally.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td>  
                                         <td CLASS="font10">This function determines if the column</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- should have constructor at some point -->  
 <!-- =========== Method SUMMARY =========== -->  
 <A NAME='Method_summary'><!-- --></A>  
156  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
157          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
158                  <TD>                  <TD>
# Line 370  stored locally.</td> Line 161  stored locally.</td>
161                  </TD>                  </TD>
162          </TR>          </TR>
163    
164                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
165          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
166                  <TD>                  <TD>
167                          <CODE><B><A HREF='CSVFILEDataListSource.html#constructor CSVFILEDataListSource'>void constructor CSVFILEDataListSource ( $filename, [$maxline = 4096] )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methodCSVFILEDataListSource'>void constructor CSVFILEDataListSource ( $filename, [$maxline = 4096] )</A></B></CODE>
168                          <BR>                          <BR>
169                          <blockquote> The constructor. </blockquote>                          <blockquote> The constructor. </blockquote>
170                  </TD>                  </TD>
171          </TR>          </TR>
172                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
173          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
174                  <TD>                  <TD>
175                          <CODE><B><A HREF='CSVFILEDataListSource.html#add_data_row'>void add_data_row ( $row )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methodadd_data_row'>void add_data_row ( $row )</A></B></CODE>
176                          <BR>                          <BR>
177                          <blockquote> This function adds a row of data                          <blockquote> This function adds a row of data </blockquote>
 if necesarry to the data array </blockquote>  
178                  </TD>                  </TD>
179          </TR>          </TR>
180                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
181          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
182                  <TD>                  <TD>
183                          <CODE><B><A HREF='CSVFILEDataListSource.html#cmp'>void cmp ( $data1, $data2 )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methodcmp'>void cmp ( $data1, $data2 )</A></B></CODE>
184                          <BR>                          <BR>
185                          <blockquote>  </blockquote>                          <blockquote>  </blockquote>
186                  </TD>                  </TD>
187          </TR>          </TR>
188                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
189          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
190                  <TD>                  <TD>
191                          <CODE><B><A HREF='CSVFILEDataListSource.html#do_prequery'>void do_prequery (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery'>void do_prequery (  )</A></B></CODE>
192                          <BR>                          <BR>
193                          <blockquote> The prequery. </blockquote>                          <blockquote> The prequery.  We use this to read the file </blockquote>
194                  </TD>                  </TD>
195          </TR>          </TR>
196                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
197          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
198                  <TD>                  <TD>
199                          <CODE><B><A HREF='CSVFILEDataListSource.html#do_query'>void do_query (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query'>void do_query (  )</A></B></CODE>
200                          <BR>                          <BR>
201                          <blockquote> This function does the query </blockquote>                          <blockquote> This function does the query </blockquote>
202                  </TD>                  </TD>
203          </TR>          </TR>
204                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
205          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
206                  <TD>                  <TD>
207                          <CODE><B><A HREF='CSVFILEDataListSource.html#get_next_data_row'>void get_next_data_row (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methodget_next_data_row'>void get_next_data_row (  )</A></B></CODE>
208                          <BR>                          <BR>
209                          <blockquote> This function returns the next row of                          <blockquote> This function returns the next row of  valid data. </blockquote>
 valid data. </blockquote>  
210                  </TD>                  </TD>
211          </TR>          </TR>
212                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
213          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
214                  <TD>                  <TD>
215                          <CODE><B><A HREF='CSVFILEDataListSource.html#sort'>void sort (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#methodsort'>void sort (  )</A></B></CODE>
216                          <BR>                          <BR>
217                          <blockquote>  </blockquote>                          <blockquote>  </blockquote>
218                  </TD>                  </TD>
219          </TR>          </TR>
220                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
221          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
222                  <TD>                  <TD>
223                          <CODE><B><A HREF='CSVFILEDataListSource.html#_construct_row'>array _construct_row ( $line )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#method_construct_row'>array _construct_row ( $line )</A></B></CODE>
224                          <BR>                          <BR>
225                          <blockquote> this is used to build a row                          <blockquote> this is used to build a row  from a csv line </blockquote>
 from a csv line </blockquote>  
226                  </TD>                  </TD>
227          </TR>          </TR>
228                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
229          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
230                  <TD>                  <TD>
231                          <CODE><B><A HREF='CSVFILEDataListSource.html#_find_data'>void _find_data ( $row_data )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#method_find_data'>void _find_data ( $row_data )</A></B></CODE>
232                          <BR>                          <BR>
233                          <blockquote>  </blockquote>                          <blockquote>  </blockquote>
234                  </TD>                  </TD>
235          </TR>          </TR>
236                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
237          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
238                  <TD>                  <TD>
239                          <CODE><B><A HREF='CSVFILEDataListSource.html#_get_header'>void _get_header (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/CSVFILEDataListSource.html#method_get_header'>void _get_header (  )</A></B></CODE>
240                          <BR>                          <BR>
241                          <blockquote> This file trys to get the CSV header. </blockquote>                          <blockquote> This file trys to get the CSV header. </blockquote>
242                  </TD>                  </TD>
243          </TR>          </TR>
244                    </TABLE>
245  </TABLE>  <!-- =========== INHERITED METHOD SUMMARY =========== -->
246    <A NAME='functions_inherited'><!-- --></A>
247    <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
248            <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
249                    <TD>
250                            <span CLASS="font12bold">Inherited Method Summary</span>
251                <A HREF="#top" CLASS="links">^TOP</A>
252                    </TD>
253            </TR>
254    
255                    <!-- =========== Summary =========== -->
256            <TR BGCOLOR='white' CLASS='TableRowColor'>
257                    <TD>
258                            <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
259                <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
260                                    <tr CLASS="tableheadingcolor">
261                                            <th>Function</th>
262                                            <th>Description</th>
263                                    </tr>
264                                                                    <tr>
265                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></td>
266                                            <td CLASS="font10">The constructor</td>
267                                                                    <tr>
268                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></td>
269                                            <td CLASS="font10">Add a column of data to manage</td>
270                                                                    <tr>
271                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></td>
272                                            <td CLASS="font10">This is a method that should be defined by the  child class to do any pre-query type of things.</td>
273                                                                    <tr>
274                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></td>
275                                            <td CLASS="font10">This is the function that does the data fetching,  and sorting if needed.</td>
276                                                                    <tr>
277                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></td>
278                                            <td CLASS="font10">This function returns the  data_index value and increments it</td>
279                                                                    <tr>
280                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></td>
281                                            <td CLASS="font10">This function gets the current  value of the limit value</td>
282                                                                    <tr>
283                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></td>
284                                            <td CLASS="font10">This function gets the next data row  from the query()</td>
285                                                                    <tr>
286                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></td>
287                                            <td CLASS="font10">This function is used to get the  message displayed when no data is found</td>
288                                                                    <tr>
289                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></td>
290                                            <td CLASS="font10">This function returns the value of the  offset</td>
291                                                                    <tr>
292                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></td>
293                                            <td CLASS="font10">This function returns the value of the  orderby</td>
294                                                                    <tr>
295                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></td>
296                                            <td CLASS="font10">This function returns the value of the  reverseorder</td>
297                                                                    <tr>
298                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></td>
299                                            <td CLASS="font10">This function returns the value of the  searchby</td>
300                                                                    <tr>
301                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></td>
302                                            <td CLASS="font10">This function returns the value of the  search value</td>
303                                                                    <tr>
304                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></td>
305                                            <td CLASS="font10">this function returns the current search type  for the DataList query</td>
306                                                                    <tr>
307                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></td>
308                                            <td CLASS="font10">This function returns the value of the  search value</td>
309                                                                    <tr>
310                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></td>
311                                            <td CLASS="font10">This returns the total number of rows  in our entire data set</td>
312                                                                    <tr>
313                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></td>
314                                            <td CLASS="font10">The main Query function.</td>
315                                                                    <tr>
316                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></td>
317                                            <td CLASS="font10">This function is used to set</td>
318                                                                    <tr>
319                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></td>
320                                            <td CLASS="font10">This function is used to set the  message displayed when no data is found</td>
321                                                                    <tr>
322                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></td>
323                                            <td CLASS="font10">This sets the offset value  and resets the index into the data  array (in non DB children)</td>
324                                                                    <tr>
325                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></td>
326                                            <td CLASS="font10">This sets the orderby column name.</td>
327                                                                    <tr>
328                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></td>
329                                            <td CLASS="font10">This sets the flag that tells us the  direction in which to order the orderby  column.</td>
330                                                                    <tr>
331                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></td>
332                                            <td CLASS="font10">This sets the column that we want to search  from.</td>
333                                                                    <tr>
334                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></td>
335                                            <td CLASS="font10">This sets the data that we want to search  for.</td>
336                                                                    <tr>
337                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></td>
338                                            <td CLASS="font10">This function sets the search type  (simple or advanced)</td>
339                                                                    <tr>
340                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></td>
341                                            <td CLASS="font10">This sets the simple search modifier</td>
342                                                                    <tr>
343                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></td>
344                                            <td CLASS="font10">This is used to set the total # of  rows we have in our data set</td>
345                                                                    <tr>
346                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></td>
347                                            <td CLASS="font10">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.</td>
348                                                                    <tr>
349                                            <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></td>
350                                            <td CLASS="font10">This function determines if the column  associated w/ a data_name is sortable  or not</td>
351                                                            </table>
352                <br>                        
353                    </TD>
354            </TR>
355            </TABLE>
356  <hr>  <hr>
357  <!-- ============ VARIABLE DETAIL =========== -->  <!-- ============ VARIABLE DETAIL =========== -->
358    
# Line 479  from a csv line </blockquote> Line 366  from a csv line </blockquote>
366          </TR>          </TR>
367  </TABLE>  </TABLE>
368    
369    <A NAME='var$_csv_headers'><!-- --></A><H3>$_csv_headers</H3> (line <span class="linenumber">51</span>)<br />
370  <A NAME='$_csv_headers'><!-- --></A><H3>$_csv_headers</H3>  <b>Data type:</b> mixed<br>this holds the headers read
371  <b>Data type:</b> mixed<br>  <br />
372  <!-- ========== Info from phpDoc block ========= -->  <p>from the top of the csv file</p>
 this holds the headers read  
 <BR>  
 from the top of the csv file  
   
373  <UL>  <UL>
374                    </UL>
 </UL>  
   
375  <HR>  <HR>
376    <A NAME='var$_filename'><!-- --></A><H3>$_filename</H3> (line <span class="linenumber">38</span>)<br />
377  <A NAME='$_filename'><!-- --></A><H3>$_filename</H3>  <b>Data type:</b> mixed<br>The csv file name/path on disk
378  <b>Data type:</b> mixed<br>  <br />
 <!-- ========== Info from phpDoc block ========= -->  
 The csv file name/path on disk  
 <BR>  
   
379    
380  <UL>  <UL>
381                    </UL>
 </UL>  
   
382  <HR>  <HR>
383    <A NAME='var$_fp'><!-- --></A><H3>$_fp</H3> (line <span class="linenumber">44</span>)<br />
384  <A NAME='$_fp'><!-- --></A><H3>$_fp</H3>  <b>Data type:</b> mixed<br>The file descriptor pointer
385  <b>Data type:</b> mixed<br>  <br />
 <!-- ========== Info from phpDoc block ========= -->  
 The file descriptor pointer  
 <BR>  
   
386    
387  <UL>  <UL>
388                    </UL>
 </UL>  
   
389  <HR>  <HR>
390    <A NAME='var$_maxlinelength'><!-- --></A><H3>$_maxlinelength</H3> (line <span class="linenumber">58</span>)<br />
391  <A NAME='$_maxlinelength'><!-- --></A><H3>$_maxlinelength</H3>  <b>Data type:</b> mixed<br>The length of the longest
392  <b>Data type:</b> mixed<br>  <br />
393  <!-- ========== Info from phpDoc block ========= -->  <p>line in the csv file  (so we read the line properly)</p>
 The length of the longest  
 <BR>  
 line in the csv file  
 (so we read the line properly)  
   
394  <UL>  <UL>
395                    </UL>
 </UL>  
   
396  <HR>  <HR>
   
   
397  <hr>  <hr>
398  <!-- ============ FUNCTION DETAIL =========== -->  <!-- ============ METHOD DETAIL =========== -->
399    
400  <A NAME='function_detail'></A>  <A NAME='method_detail'></A>
401  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
402          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
403                  <TD>                  <TD>
# Line 547  line in the csv file Line 407  line in the csv file
407          </TR>          </TR>
408  </TABLE>  </TABLE>
409  <BR>  <BR>
   
410  <DIV CLASS="function">  <DIV CLASS="function">
411  <A NAME='constructor CSVFILEDataListSource'><!-- --></A>  <A NAME='methodCSVFILEDataListSource'><!-- --></A>
412  <SPAN CLASS="font12bold">constructor CSVFILEDataListSource</SPAN>  <SPAN CLASS="font12bold">Constructor CSVFILEDataListSource</SPAN> (line <span class="linenumber">69</span>)
413  <BR>  <BR>
414  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
415  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
416  <span class="font10bold" style="color: #0000FF">constructor CSVFILEDataListSource ( $filename, [$maxline = 4096] )</SPAN>  <span class="font10bold" style="color: #0000FF">CSVFILEDataListSource(
417    string
418    $filename, [mixed
419    $maxline = 4096])</SPAN>
420  <BR>  <BR>
421    
422  <BR>  <BR>
423  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
424  The constructor.  The constructor.
425  <BR>  <br />
426    
427  <DL>  <DL>
428    <DT class="font10bold">Function Parameters:</DT>          <DT class="font10bold">Function Parameters:</DT>
429                      <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 on disk to use as the data source.</DD>
430    <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          
431                   on disk to use as the data source.</DD>          <DT class="font10bold">Function Info:</DT>
432              </DL>
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
433  </DIV>  </DIV>
434  <BR>  <BR>
   
435  <DIV CLASS="function">  <DIV CLASS="function">
436  <A NAME='add_data_row'><!-- --></A>  <A NAME='methodadd_data_row'><!-- --></A>
437  <SPAN CLASS="font12bold">add_data_row</SPAN>  <SPAN CLASS="font12bold">add_data_row</SPAN> (line <span class="linenumber">186</span>)
438  <BR>  <BR>
439  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
440  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
441  <span class="font10bold" style="color: #0000FF">add_data_row ( $row )</SPAN>  <span class="font10bold" style="color: #0000FF">add_data_row(
442    mixed
443    $row)</SPAN>
444  <BR>  <BR>
445    
446  <BR>  <BR>
447  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
448  This function adds a row of data  This function adds a row of data
449  if necesarry to the data array  <br />
450  <BR>  <p>if necesarry to the data array</p>
   
451  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
452    
453            <DT class="font10bold">Function Info:</DT>
454            </DL>
455  </DIV>  </DIV>
456  <BR>  <BR>
   
457  <DIV CLASS="function">  <DIV CLASS="function">
458  <A NAME='cmp'><!-- --></A>  <A NAME='methodcmp'><!-- --></A>
459  <SPAN CLASS="font12bold">cmp</SPAN>  <SPAN CLASS="font12bold">cmp</SPAN> (line <span class="linenumber">215</span>)
460  <BR>  <BR>
461  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
462  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
463  <span class="font10bold" style="color: #0000FF">cmp ( $data1, $data2 )</SPAN>  <span class="font10bold" style="color: #0000FF">cmp(
464    mixed
465    $data1, mixed
466    $data2)</SPAN>
467  <BR>  <BR>
468    
469  <BR>  <BR>
470  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
471    
472  <BR>  <br />
473    
474  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
475    
476            <DT class="font10bold">Function Info:</DT>
477            </DL>
478  </DIV>  </DIV>
479  <BR>  <BR>
   
480  <DIV CLASS="function">  <DIV CLASS="function">
481  <A NAME='do_prequery'><!-- --></A>  <A NAME='methoddo_prequery'><!-- --></A>
482  <SPAN CLASS="font12bold">do_prequery</SPAN>  <SPAN CLASS="font12bold">do_prequery</SPAN> (line <span class="linenumber">90</span>)
483  <BR>  <BR>
484  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
485  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
486  <span class="font10bold" style="color: #0000FF">do_prequery (  )</SPAN>  <span class="font10bold" style="color: #0000FF">do_prequery(
487    )</SPAN>
488  <BR>  <BR>
489  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_prequery">DataListSource::do_prequery()</a>  
490    <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a> This is a method that should be defined by the  child class to do any pre-query type of things.
491  <BR>  <BR>
492  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
493  <!-- ========== Info from phpDoc block ========= -->  The prequery.  We use this to read the file
494  The prequery.  <br />
495  <BR>  <p>into memory so we can do operations on the data  (search, sort, etc.)</p>
 We use this to read the file  
 into memory so we can do operations on the data  
 (search, sort, etc.)  
496  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
497    
498            <DT class="font10bold">Function Info:</DT>
499            </DL>
500  </DIV>  </DIV>
501  <BR>  <BR>
   
502  <DIV CLASS="function">  <DIV CLASS="function">
503  <A NAME='do_query'><!-- --></A>  <A NAME='methoddo_query'><!-- --></A>
504  <SPAN CLASS="font12bold">do_query</SPAN>  <SPAN CLASS="font12bold">do_query</SPAN> (line <span class="linenumber">98</span>)
505  <BR>  <BR>
506  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
507  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
508  <span class="font10bold" style="color: #0000FF">do_query (  )</SPAN>  <span class="font10bold" style="color: #0000FF">do_query(
509    )</SPAN>
510  <BR>  <BR>
511  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_query">DataListSource::do_query()</a>  
512    <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a> This is the function that does the data fetching,  and sorting if needed.
513  <BR>  <BR>
514  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
515  This function does the query  This function does the query
516  <BR>  <br />
517  and search/sort  <p>and search/sort</p>
518  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
519    
520            <DT class="font10bold">Function Info:</DT>
521            </DL>
522  </DIV>  </DIV>
523  <BR>  <BR>
   
524  <DIV CLASS="function">  <DIV CLASS="function">
525  <A NAME='get_next_data_row'><!-- --></A>  <A NAME='methodget_next_data_row'><!-- --></A>
526  <SPAN CLASS="font12bold">get_next_data_row</SPAN>  <SPAN CLASS="font12bold">get_next_data_row</SPAN> (line <span class="linenumber">116</span>)
527  <BR>  <BR>
528  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
529  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
530  <span class="font10bold" style="color: #0000FF">get_next_data_row (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_next_data_row(
531    )</SPAN>
532  <BR>  <BR>
533  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#get_next_data_row">DataListSource::get_next_data_row()</a>  
534    <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a> This function gets the next data row  from the query()
535  <BR>  <BR>
536  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
537  <!-- ========== Info from phpDoc block ========= -->  This function returns the next row of  valid data.
538  This function returns the next row of  <br />
 valid data.  
 <BR>  
539    
540  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
541    
542            <DT class="font10bold">Function Info:</DT>
543            </DL>
544  </DIV>  </DIV>
545  <BR>  <BR>
   
546  <DIV CLASS="function">  <DIV CLASS="function">
547  <A NAME='sort'><!-- --></A>  <A NAME='methodsort'><!-- --></A>
548  <SPAN CLASS="font12bold">sort</SPAN>  <SPAN CLASS="font12bold">sort</SPAN> (line <span class="linenumber">205</span>)
549  <BR>  <BR>
550  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
551  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
552  <span class="font10bold" style="color: #0000FF">sort (  )</SPAN>  <span class="font10bold" style="color: #0000FF">sort(
553    )</SPAN>
554  <BR>  <BR>
555  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#sort">DataListSource::sort()</a>  
556    <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a> 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.
557  <BR>  <BR>
558  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
559    
560  <BR>  <br />
561    
562  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
563    
564            <DT class="font10bold">Function Info:</DT>
565            </DL>
566  </DIV>  </DIV>
567  <BR>  <BR>
   
568  <DIV CLASS="function">  <DIV CLASS="function">
569  <A NAME='_construct_row'><!-- --></A>  <A NAME='method_construct_row'><!-- --></A>
570  <SPAN CLASS="font12bold">_construct_row</SPAN>  <SPAN CLASS="font12bold">_construct_row</SPAN> (line <span class="linenumber">163</span>)
571  <BR>  <BR>
572  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
573  <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
574  <span class="font10bold" style="color: #0000FF">_construct_row ( $line )</SPAN>  <span class="font10bold" style="color: #0000FF">_construct_row(
575    string
576    $line)</SPAN>
577  <BR>  <BR>
578    
579  <BR>  <BR>
580  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
581  <!-- ========== Info from phpDoc block ========= -->  this is used to build a row  from a csv line
582  this is used to build a row  <br />
 from a csv line  
 <BR>  
583    
584  <DL>  <DL>
585    <DT class="font10bold">Function Parameters:</DT>          <DT class="font10bold">Function Parameters:</DT>
586                      <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>
587    <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>          
588              <DT class="font10bold">Function Info:</DT>
589            </DL>
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
590  </DIV>  </DIV>
591  <BR>  <BR>
   
592  <DIV CLASS="function">  <DIV CLASS="function">
593  <A NAME='_find_data'><!-- --></A>  <A NAME='method_find_data'><!-- --></A>
594  <SPAN CLASS="font12bold">_find_data</SPAN>  <SPAN CLASS="font12bold">_find_data</SPAN> (line <span class="linenumber">224</span>)
595  <BR>  <BR>
596  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
597  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
598  <span class="font10bold" style="color: #0000FF">_find_data ( $row_data )</SPAN>  <span class="font10bold" style="color: #0000FF">_find_data(
599    mixed
600    $row_data)</SPAN>
601  <BR>  <BR>
602    
603  <BR>  <BR>
604  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
605    
606  <BR>  <br />
607    
608  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
609    
610            <DT class="font10bold">Function Info:</DT>
611            </DL>
612  </DIV>  </DIV>
613  <BR>  <BR>
   
614  <DIV CLASS="function">  <DIV CLASS="function">
615  <A NAME='_get_header'><!-- --></A>  <A NAME='method_get_header'><!-- --></A>
616  <SPAN CLASS="font12bold">_get_header</SPAN>  <SPAN CLASS="font12bold">_get_header</SPAN> (line <span class="linenumber">143</span>)
617  <BR>  <BR>
618  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
619  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
620  <span class="font10bold" style="color: #0000FF">_get_header (  )</SPAN>  <span class="font10bold" style="color: #0000FF">_get_header(
621    )</SPAN>
622  <BR>  <BR>
623    
624  <BR>  <BR>
625  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
626  This file trys to get the CSV header.  This file trys to get the CSV header.
627  <BR>  <br />
628    
629  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
630    
631            <DT class="font10bold">Function Info:</DT>
632            </DL>
633  </DIV>  </DIV>
634  <BR>  <BR>
635            <div id="credit">
636                    <hr>
637  <hr>                  Documention generated on Thu, 20 Feb 2003 16:22:33 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
638  </HTML>          </div>
639    </body>
640    </html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed