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