1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.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: 'Mon, 25 Nov 2002 09:21:30 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class DataListSource</TITLE> |
<title>Docs For Class DataListSource</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='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 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
<!-- Links --> |
<h2 class="class-name">Class DataListSource</h2> |
13 |
<a NAME="top"></A> |
|
14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
15 |
<TR> |
<div class="info-box"> |
16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
17 |
Links: |
<div class="nav-bar"> |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from DataListSource">Child Classes</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-descendents">Descendents</a> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
21 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
22 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
|
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
</div> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<div class="info-box-body"> |
25 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
26 |
</TR> |
<p class="short-description">This is the base class for managing data for the DataList class. This abstracts away the underlying data layer from the DataList, so the data can come from multiple sources.</p> |
27 |
</TABLE> |
<p class="description"><p>Most of the time the data will come from a data base such as Mysql or Oracle. This abstraction enables the data to also come from a tab delimited file, xml, php array</p></p> |
28 |
<BR> |
<ul class="tags"> |
29 |
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
30 |
<!-- Start of Class Data --> |
</ul> |
31 |
<H2> |
<p class="notes"> |
32 |
Class DataListSource |
Located in <a class="field" href="_widgets_data_list_DataListSource_inc.html">/widgets/data_list/DataListSource.inc</a> (line <span class="field">31</span>) |
33 |
</H2> |
</p> |
34 |
|
|
35 |
<pre> |
|
36 |
DataListSource |
<pre></pre> |
37 |
</pre> |
|
38 |
|
</div> |
39 |
<A NAME="children_summary"</A> |
</div> |
40 |
<H3> |
|
41 |
Classes extended from DataListSource: <A HREF="#top" CLASS="links">^TOP</A> |
<a name="sec-descendents"></a> |
42 |
</H3> |
<div class="info-box"> |
43 |
<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html">CSVFILEDataListSource</a> |
<div class="info-box-title">Direct descendents</div> |
44 |
<p> |
<div class="nav-bar"> |
45 |
<b><i>Located in File: Program_Root/widgets/data_list/DataListSource.inc</i></b><br> |
<a href="#sec-description">Description</a> | |
46 |
</p> |
<span class="disabled">Descendents</span> |
47 |
<hr> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
48 |
<!-- ========== Info from phpDoc block ========= --> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
49 |
This is the base class for managing data for |
|
50 |
<BR> |
</div> |
51 |
the DataList class. This abstracts away the |
<div class="info-box-body"> |
52 |
underlying data layer from the DataList, so |
<table cellpadding="2" cellspacing="0" class="class-table"> |
53 |
the data can come from multiple sources. |
<tr> |
54 |
Most of the time the data will come from a |
<th class="class-table-header">Class</th> |
55 |
data base such as Mysql or Oracle. This |
<th class="class-table-header">Description</th> |
56 |
abstraction enables the data to also come from |
</tr> |
57 |
a tab delimited file, xml, php array |
<tr> |
58 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ArrayDataListSource.html">ArrayDataListSource</a></td> |
59 |
<UL> |
<td> |
60 |
|
This DataListSource child class gets the data from an external array |
61 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
</td> |
62 |
|
</tr> |
63 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
<tr> |
64 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></td> |
65 |
</UL> |
<td> |
66 |
|
|
67 |
<hr> |
</td> |
68 |
<!-- =========== VAR SUMMARY =========== --> |
</tr> |
69 |
<A NAME='var_summary'><!-- --></A> |
</table> |
70 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</div> |
71 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</div> |
72 |
<TD> |
|
73 |
<span CLASS="font12bold">Class Variable Summary</span> |
|
74 |
<A HREF="#top" CLASS="links">^TOP</A> |
<a name="sec-var-summary"></a> |
75 |
</TD> |
<div class="info-box"> |
76 |
</TR> |
<div class="info-box-title">Variable Summary</span></div> |
77 |
|
<div class="nav-bar"> |
78 |
|
<a href="#sec-description">Description</a> | |
79 |
<!-- =========== Summary =========== --> |
<a href="#sec-descendents">Descendents</a> | |
80 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
81 |
<TD> |
| |
82 |
<CODE><B><A HREF='DataListSource.html#$_columns'>$_columns</A></B></CODE> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
83 |
<BR> |
|
84 |
<blockquote> The column descriptions |
</div> |
85 |
for the data we are working on </blockquote> |
<div class="info-box-body"> |
86 |
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
<div class="var-summary"> |
87 |
</TD> |
<div class="var-title"> |
88 |
</TR> |
<span class="var-type">array</span> |
89 |
|
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
90 |
<!-- =========== Summary =========== --> |
</div> |
91 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-title"> |
92 |
<TD> |
<span class="var-type">mixed</span> |
93 |
<CODE><B><A HREF='DataListSource.html#$_data'>$_data</A></B></CODE> |
<a href="#$_data" title="details" class="var-name">$_data</a> |
94 |
<BR> |
</div> |
95 |
<blockquote> A placeholder for data that is read/built </blockquote> |
<div class="var-title"> |
96 |
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
<span class="var-type">mixed</span> |
97 |
</TD> |
<a href="#$_data_index" title="details" class="var-name">$_data_index</a> |
98 |
</TR> |
</div> |
99 |
|
<div class="var-title"> |
100 |
<!-- =========== Summary =========== --> |
<span class="var-type">mixed</span> |
101 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#$_not_found_message" title="details" class="var-name">$_not_found_message</a> |
102 |
<TD> |
</div> |
103 |
<CODE><B><A HREF='DataListSource.html#$_data_index'>$_data_index</A></B></CODE> |
<div class="var-title"> |
104 |
<BR> |
<span class="var-type">mixed</span> |
105 |
<blockquote> Holds the index into the array of data </blockquote> |
<a href="#$_query_params" title="details" class="var-name">$_query_params</a> |
106 |
<blockquote> Default Value: <CODE>->0<-</CODE> </blockquote> |
</div> |
107 |
</TD> |
</div> |
108 |
</TR> |
</div> |
109 |
|
</div> |
110 |
<!-- =========== Summary =========== --> |
|
111 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="sec-method-summary"></a> |
112 |
<TD> |
<div class="info-box"> |
113 |
<CODE><B><A HREF='DataListSource.html#$_not_found_message'>$_not_found_message</A></B></CODE> |
<div class="info-box-title">Method Summary</span></div> |
114 |
<BR> |
<div class="nav-bar"> |
115 |
<blockquote> This is the message displayed when no data </blockquote> |
<a href="#sec-description">Description</a> | |
116 |
<blockquote> Default Value: <CODE>->No data was found<-</CODE> </blockquote> |
<a href="#sec-descendents">Descendents</a> | |
117 |
</TD> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
118 |
</TR> |
|
119 |
|
| |
120 |
<!-- =========== Summary =========== --> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
121 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
122 |
<TD> |
<div class="info-box-body"> |
123 |
<CODE><B><A HREF='DataListSource.html#$_query_params'>$_query_params</A></B></CODE> |
<div class="method-summary"> |
124 |
<BR> |
|
125 |
<blockquote> This holds various parameters relating |
<div class="method-definition"> |
126 |
to the query of the data </blockquote> |
<span class="method-result">DataListSource</span> |
127 |
<blockquote> Default Value: <CODE>->array("num_total_rows" => 0, |
<a href="#DataListSource" title="details" class="method-name">DataListSource</a> |
128 |
"offset" => 0, |
() |
129 |
"limit" => -1, |
</div> |
130 |
"orderby" => '', |
|
131 |
"reverseorder" => '', |
<div class="method-definition"> |
132 |
"searchby" => '', |
<span class="method-result">void</span> |
133 |
"searchvalue" => '', |
<a href="#add_column" title="details" class="method-name">add_column</a> |
134 |
"searchmodifier" => '', |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
135 |
"searchtype" => 'simple')<-</CODE> </blockquote> |
</div> |
136 |
</TD> |
|
137 |
</TR> |
<div class="method-definition"> |
138 |
|
<span class="method-result">void</span> |
139 |
</TABLE> |
<a href="#do_prequery" title="details" class="method-name">do_prequery</a> |
140 |
|
() |
141 |
<hr> |
</div> |
142 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
|
143 |
<A NAME='var_inherited_summary'><!-- --></A> |
<div class="method-definition"> |
144 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<span class="method-result">boolean</span> |
145 |
<TR CLASS='TableHeadingColor'> |
<a href="#do_query" title="details" class="method-name">do_query</a> |
146 |
<TD> |
() |
147 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
</div> |
148 |
<A HREF="#top" CLASS="links">^TOP</A> |
|
149 |
</TD> |
<div class="method-definition"> |
150 |
</TR> |
<span class="method-result">int</span> |
151 |
|
<a href="#get_data_index" title="details" class="method-name">get_data_index</a> |
152 |
|
() |
153 |
</TABLE> |
</div> |
154 |
|
|
155 |
<hr> |
<div class="method-definition"> |
156 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
<span class="method-result">int</span> |
157 |
<A NAME='functions_inherited'><!-- --></A> |
<a href="#get_limit" title="details" class="method-name">get_limit</a> |
158 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
() |
159 |
<TR CLASS='TableHeadingColor'> |
</div> |
160 |
<TD> |
|
161 |
<span CLASS="font12bold">Inherited Method Summary</span> |
<div class="method-definition"> |
162 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="method-result">array()</span> |
163 |
</TD> |
<a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a> |
164 |
</TR> |
() |
165 |
|
</div> |
166 |
|
|
167 |
</TABLE> |
<div class="method-definition"> |
168 |
|
<span class="method-result">string</span> |
169 |
<hr> |
<a href="#get_not_found_message" title="details" class="method-name">get_not_found_message</a> |
170 |
<!-- should have constructor at some point --> |
() |
171 |
<!-- =========== Method SUMMARY =========== --> |
</div> |
172 |
<A NAME='Method_summary'><!-- --></A> |
|
173 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
<div class="method-definition"> |
174 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="method-result">int</span> |
175 |
<TD> |
<a href="#get_offset" title="details" class="method-name">get_offset</a> |
176 |
<span class="font12bold">Method Summary</span> |
() |
177 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
178 |
</TD> |
|
179 |
</TR> |
<div class="method-definition"> |
180 |
|
<span class="method-result">int</span> |
181 |
|
<a href="#get_orderby" title="details" class="method-name">get_orderby</a> |
182 |
<!-- =========== Summary =========== --> |
() |
183 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
184 |
<TD> |
|
185 |
<CODE><B><A HREF='DataListSource.html#constructor DataListSource'>void constructor DataListSource ( )</A></B></CODE> |
<div class="method-definition"> |
186 |
<BR> |
<span class="method-result">int</span> |
187 |
<blockquote> The constructor </blockquote> |
<a href="#get_reverseorder" title="details" class="method-name">get_reverseorder</a> |
188 |
</TD> |
() |
189 |
</TR> |
</div> |
190 |
|
|
191 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
192 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">int</span> |
193 |
<TD> |
<a href="#get_searchby" title="details" class="method-name">get_searchby</a> |
194 |
<CODE><B><A HREF='DataListSource.html#add_column'>void add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></B></CODE> |
() |
195 |
<BR> |
</div> |
196 |
<blockquote> Add a column of data to manage </blockquote> |
|
197 |
</TD> |
<div class="method-definition"> |
198 |
</TR> |
<span class="method-result">int</span> |
199 |
|
<a href="#get_searchby_value" title="details" class="method-name">get_searchby_value</a> |
200 |
<!-- =========== Summary =========== --> |
() |
201 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
202 |
<TD> |
|
203 |
<CODE><B><A HREF='DataListSource.html#do_prequery'>void do_prequery ( )</A></B></CODE> |
<div class="method-definition"> |
204 |
<BR> |
<span class="method-result">string</span> |
205 |
<blockquote> This is a method that should be defined by the |
<a href="#get_search_type" title="details" class="method-name">get_search_type</a> |
206 |
child class to do any pre-query type of things. </blockquote> |
() |
207 |
</TD> |
</div> |
208 |
</TR> |
|
209 |
|
<div class="method-definition"> |
210 |
<!-- =========== Summary =========== --> |
<span class="method-result">array</span> |
211 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#get_secondary_orderby" title="details" class="method-name">get_secondary_orderby</a> |
212 |
<TD> |
() |
213 |
<CODE><B><A HREF='DataListSource.html#do_query'>void do_query ( )</A></B></CODE> |
</div> |
214 |
<BR> |
|
215 |
<blockquote> This is the function that does the data fetching, |
<div class="method-definition"> |
216 |
and sorting if needed. </blockquote> |
<span class="method-result">int</span> |
217 |
</TD> |
<a href="#get_simplesearch_modifier" title="details" class="method-name">get_simplesearch_modifier</a> |
218 |
</TR> |
() |
219 |
|
</div> |
220 |
<!-- =========== Summary =========== --> |
|
221 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
222 |
<TD> |
<span class="method-result">int</span> |
223 |
<CODE><B><A HREF='DataListSource.html#get_data_index'>int get_data_index ( )</A></B></CODE> |
<a href="#get_total_rows" title="details" class="method-name">get_total_rows</a> |
224 |
<BR> |
() |
225 |
<blockquote> This function returns the |
</div> |
226 |
data_index value and increments it </blockquote> |
|
227 |
</TD> |
<div class="method-definition"> |
228 |
</TR> |
<span class="method-result">void</span> |
229 |
|
<a href="#query" title="details" class="method-name">query</a> |
230 |
<!-- =========== Summary =========== --> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
231 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
232 |
<TD> |
|
233 |
<CODE><B><A HREF='DataListSource.html#get_limit'>int get_limit ( )</A></B></CODE> |
<div class="method-definition"> |
234 |
<BR> |
<span class="method-result">boolean</span> |
235 |
<blockquote> This function gets the current |
<a href="#row_filter" title="details" class="method-name">row_filter</a> |
236 |
value of the limit value </blockquote> |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
237 |
</TD> |
</div> |
238 |
</TR> |
|
239 |
|
<div class="method-definition"> |
240 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
241 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#set_limit" title="details" class="method-name">set_limit</a> |
242 |
<TD> |
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
243 |
<CODE><B><A HREF='DataListSource.html#get_next_data_row'>array() get_next_data_row ( )</A></B></CODE> |
</div> |
244 |
<BR> |
|
245 |
<blockquote> This function gets the next data row |
<div class="method-definition"> |
246 |
from the query() </blockquote> |
<span class="method-result">void</span> |
247 |
</TD> |
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
248 |
</TR> |
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
249 |
|
</div> |
250 |
<!-- =========== Summary =========== --> |
|
251 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
252 |
<TD> |
<span class="method-result">void</span> |
253 |
<CODE><B><A HREF='DataListSource.html#get_not_found_message'>string get_not_found_message ( )</A></B></CODE> |
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
254 |
<BR> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
255 |
<blockquote> This function is used to get the |
</div> |
256 |
message displayed when no data is found </blockquote> |
|
257 |
</TD> |
<div class="method-definition"> |
258 |
</TR> |
<span class="method-result">void</span> |
259 |
|
<a href="#set_orderby" title="details" class="method-name">set_orderby</a> |
260 |
<!-- =========== Summary =========== --> |
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
261 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
262 |
<TD> |
|
263 |
<CODE><B><A HREF='DataListSource.html#get_offset'>int get_offset ( )</A></B></CODE> |
<div class="method-definition"> |
264 |
<BR> |
<span class="method-result">void</span> |
265 |
<blockquote> This function returns the value of the |
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
266 |
offset </blockquote> |
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
267 |
</TD> |
</div> |
268 |
</TR> |
|
269 |
|
<div class="method-definition"> |
270 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
271 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#set_searchby" title="details" class="method-name">set_searchby</a> |
272 |
<TD> |
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
273 |
<CODE><B><A HREF='DataListSource.html#get_orderby'>int get_orderby ( )</A></B></CODE> |
</div> |
274 |
<BR> |
|
275 |
<blockquote> This function returns the value of the |
<div class="method-definition"> |
276 |
orderby </blockquote> |
<span class="method-result">void</span> |
277 |
</TD> |
<a href="#set_searchby_value" title="details" class="method-name">set_searchby_value</a> |
278 |
</TR> |
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
279 |
|
</div> |
280 |
<!-- =========== Summary =========== --> |
|
281 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
282 |
<TD> |
<span class="method-result">void</span> |
283 |
<CODE><B><A HREF='DataListSource.html#get_reverseorder'>int get_reverseorder ( )</A></B></CODE> |
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
284 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
285 |
<blockquote> This function returns the value of the |
</div> |
286 |
reverseorder </blockquote> |
|
287 |
</TD> |
<div class="method-definition"> |
288 |
</TR> |
<span class="method-result">void</span> |
289 |
|
<a href="#set_secondary_orderby" title="details" class="method-name">set_secondary_orderby</a> |
290 |
<!-- =========== Summary =========== --> |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
291 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
292 |
<TD> |
|
293 |
<CODE><B><A HREF='DataListSource.html#get_searchby'>int get_searchby ( )</A></B></CODE> |
<div class="method-definition"> |
294 |
<BR> |
<span class="method-result">void</span> |
295 |
<blockquote> This function returns the value of the |
<a href="#set_simplesearch_modifier" title="details" class="method-name">set_simplesearch_modifier</a> |
296 |
searchby </blockquote> |
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
297 |
</TD> |
</div> |
298 |
</TR> |
|
299 |
|
<div class="method-definition"> |
300 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
301 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#set_total_rows" title="details" class="method-name">set_total_rows</a> |
302 |
<TD> |
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
303 |
<CODE><B><A HREF='DataListSource.html#get_searchby_value'>int get_searchby_value ( )</A></B></CODE> |
</div> |
304 |
<BR> |
|
305 |
<blockquote> This function returns the value of the |
<div class="method-definition"> |
306 |
search value </blockquote> |
<span class="method-result">void</span> |
307 |
</TD> |
<a href="#sort" title="details" class="method-name">sort</a> |
308 |
</TR> |
() |
309 |
|
</div> |
310 |
<!-- =========== Summary =========== --> |
|
311 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
312 |
<TD> |
<span class="method-result">boolean</span> |
313 |
<CODE><B><A HREF='DataListSource.html#get_search_type'>string get_search_type ( )</A></B></CODE> |
<a href="#_is_column_sortable" title="details" class="method-name">_is_column_sortable</a> |
314 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
315 |
<blockquote> this function returns the current search type |
</div> |
316 |
for the DataList query </blockquote> |
</div> |
317 |
</TD> |
</div> |
318 |
</TR> |
</div> |
319 |
|
|
320 |
<!-- =========== Summary =========== --> |
<a name="sec-vars"></a> |
321 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="info-box"> |
322 |
<TD> |
<div class="info-box-title">Variables</div> |
323 |
<CODE><B><A HREF='DataListSource.html#get_simplesearch_modifier'>int get_simplesearch_modifier ( )</A></B></CODE> |
<div class="nav-bar"> |
324 |
<BR> |
<a href="#sec-description">Description</a> | |
325 |
<blockquote> This function returns the value of the |
<a href="#sec-descendents">Descendents</a> | |
326 |
search value </blockquote> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
327 |
</TD> |
|
328 |
</TR> |
|
329 |
|
| |
330 |
<!-- =========== Summary =========== --> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
331 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
332 |
<TD> |
</div> |
333 |
<CODE><B><A HREF='DataListSource.html#get_total_rows'>int get_total_rows ( )</A></B></CODE> |
<div class="info-box-body"> |
334 |
<BR> |
<a name="var$_columns" id="$_columns"><!-- --></A> |
335 |
<blockquote> This returns the total number of rows |
<div class="oddrow"> |
336 |
in our entire data set </blockquote> |
|
337 |
</TD> |
<div class="var-header"> |
338 |
</TR> |
<span class="var-title"> |
339 |
|
<span class="var-type">array</span> |
340 |
<!-- =========== Summary =========== --> |
<span class="var-name">$_columns</span> |
341 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
= <span class="var-default">array()</span> (line <span class="line-number">39</span>) |
342 |
<TD> |
</span> |
343 |
<CODE><B><A HREF='DataListSource.html#query'>void query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></B></CODE> |
</div> |
344 |
<BR> |
|
345 |
<blockquote> The main Query function. </blockquote> |
<!-- ========== Info from phpDoc block ========= --> |
346 |
</TD> |
<p class="short-description">The column descriptions for the data we are working on</p> |
347 |
</TR> |
|
348 |
|
|
349 |
<!-- =========== Summary =========== --> |
|
350 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
351 |
<TD> |
|
352 |
<CODE><B><A HREF='DataListSource.html#set_limit'>void set_limit ( $limit )</A></B></CODE> |
</div> |
353 |
<BR> |
<a name="var$_data" id="$_data"><!-- --></A> |
354 |
<blockquote> This function is used to set </blockquote> |
<div class="evenrow"> |
355 |
</TD> |
|
356 |
</TR> |
<div class="var-header"> |
357 |
|
<span class="var-title"> |
358 |
<!-- =========== Summary =========== --> |
<span class="var-type">mixed</span> |
359 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-name">$_data</span> |
360 |
<TD> |
= <span class="var-default">array()</span> (line <span class="line-number">80</span>) |
361 |
<CODE><B><A HREF='DataListSource.html#set_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE> |
</span> |
362 |
<BR> |
</div> |
363 |
<blockquote> This function is used to set the |
|
364 |
message displayed when no data is found </blockquote> |
<!-- ========== Info from phpDoc block ========= --> |
365 |
</TD> |
<p class="short-description">A placeholder for data that is read/built and stored locally. Not all data sources have to use this.</p> |
366 |
</TR> |
<p class="description"><p>Each entry in the array corresponds to 1 row of data.</p></p> |
367 |
|
|
368 |
<!-- =========== Summary =========== --> |
|
369 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
370 |
<TD> |
|
371 |
<CODE><B><A HREF='DataListSource.html#set_offset'>void set_offset ( $offset )</A></B></CODE> |
|
372 |
<BR> |
</div> |
373 |
<blockquote> This sets the offset value </blockquote> |
<a name="var$_data_index" id="$_data_index"><!-- --></A> |
374 |
</TD> |
<div class="oddrow"> |
375 |
</TR> |
|
376 |
|
<div class="var-header"> |
377 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
378 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
379 |
<TD> |
<span class="var-name">$_data_index</span> |
380 |
<CODE><B><A HREF='DataListSource.html#set_orderby'>void set_orderby ( $orderby )</A></B></CODE> |
= <span class="var-default"> 0</span> (line <span class="line-number">71</span>) |
381 |
<BR> |
</span> |
382 |
<blockquote> This sets the orderby column name. </blockquote> |
</div> |
383 |
</TD> |
|
384 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
385 |
|
<p class="short-description">Holds the index into the array of data</p> |
386 |
<!-- =========== Summary =========== --> |
<p class="description"><p>so we can keep track of where we are when we are walking the array (only usefull for non DB children)</p></p> |
387 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
388 |
<TD> |
|
389 |
<CODE><B><A HREF='DataListSource.html#set_reverseorder'>void set_reverseorder ( $order )</A></B></CODE> |
|
390 |
<BR> |
|
391 |
<blockquote> This sets the flag that tells us the |
|
392 |
direction in which to order the orderby |
</div> |
393 |
column. </blockquote> |
<a name="var$_not_found_message" id="$_not_found_message"><!-- --></A> |
394 |
</TD> |
<div class="evenrow"> |
395 |
</TR> |
|
396 |
|
<div class="var-header"> |
397 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
398 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
399 |
<TD> |
<span class="var-name">$_not_found_message</span> |
400 |
<CODE><B><A HREF='DataListSource.html#set_searchby'>void set_searchby ( $search_col )</A></B></CODE> |
= <span class="var-default"> "No data was found"</span> (line <span class="line-number">45</span>) |
401 |
<BR> |
</span> |
402 |
<blockquote> This sets the column that we want to search |
</div> |
403 |
from. </blockquote> |
|
404 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
405 |
</TR> |
<p class="short-description">This is the message displayed when no data</p> |
406 |
|
<p class="description"><p>was retrieved from the database</p></p> |
407 |
<!-- =========== Summary =========== --> |
|
408 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
409 |
<TD> |
|
410 |
<CODE><B><A HREF='DataListSource.html#set_searchby_value'>void set_searchby_value ( $search_value )</A></B></CODE> |
|
411 |
<BR> |
|
412 |
<blockquote> This sets the data that we want to search |
</div> |
413 |
for. </blockquote> |
<a name="var$_query_params" id="$_query_params"><!-- --></A> |
414 |
</TD> |
<div class="oddrow"> |
415 |
</TR> |
|
416 |
|
<div class="var-header"> |
417 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
418 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
419 |
<TD> |
<span class="var-name">$_query_params</span> |
420 |
<CODE><B><A HREF='DataListSource.html#set_search_type'>void set_search_type ( $search_type )</A></B></CODE> |
= <span class="var-default">array("num_total_rows" => 0,<br /> "offset" => 0,<br /> "limit" => -1,<br /> "orderby" => '',<br /> "secondaryorderby" => array(),"reverseorder"=>'',"searchby"=>'',"searchvalue"=>'',"searchmodifier"=>'',"searchtype"=>'simple')</span> (line <span class="line-number">53</span>) |
421 |
<BR> |
</span> |
422 |
<blockquote> This function sets the search type |
</div> |
423 |
(simple or advanced) </blockquote> |
|
424 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
425 |
</TR> |
<p class="short-description">This holds various parameters relating</p> |
426 |
|
<p class="description"><p>to the query of the data</p></p> |
427 |
<!-- =========== Summary =========== --> |
|
428 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
429 |
<TD> |
|
430 |
<CODE><B><A HREF='DataListSource.html#set_simplesearch_modifier'>void set_simplesearch_modifier ( $search_modifier )</A></B></CODE> |
|
431 |
<BR> |
|
432 |
<blockquote> This sets the simple search modifier </blockquote> |
</div> |
433 |
</TD> |
|
434 |
</TR> |
</div> |
435 |
|
</div> |
436 |
<!-- =========== Summary =========== --> |
|
437 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="sec-methods"></a> |
438 |
<TD> |
<div class="info-box"> |
439 |
<CODE><B><A HREF='DataListSource.html#set_total_rows'>void set_total_rows ( $num )</A></B></CODE> |
<div class="info-box-title">Methods</div> |
440 |
<BR> |
<div class="nav-bar"> |
441 |
<blockquote> This is used to set the total # of |
<a href="#sec-description">Description</a> | |
442 |
rows we have in our data set </blockquote> |
<a href="#sec-descendents">Descendents</a> | |
443 |
</TD> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
444 |
</TR> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
445 |
|
|
446 |
<!-- =========== Summary =========== --> |
</div> |
447 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="info-box-body"> |
448 |
<TD> |
<A NAME='method_detail'></A> |
449 |
<CODE><B><A HREF='DataListSource.html#sort'>void sort ( )</A></B></CODE> |
<a name="methodDataListSource" id="DataListSource"><!-- --></a> |
450 |
<BR> |
<div class="evenrow"> |
451 |
<blockquote> A generic method API that can be used at the bottom |
|
452 |
half of the do_query() method to sort data that is |
<div class="method-header"> |
453 |
stored locally. </blockquote> |
<span class="method-title">Constructor DataListSource</span> (line <span class="line-number">86</span>) |
454 |
</TD> |
</div> |
455 |
</TR> |
|
456 |
|
<!-- ========== Info from phpDoc block ========= --> |
457 |
<!-- =========== Summary =========== --> |
<p class="short-description">The constructor</p> |
458 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
459 |
<TD> |
<div class="method-signature"> |
460 |
<CODE><B><A HREF='DataListSource.html#_is_column_sortable'>boolean _is_column_sortable ( $data_name )</A></B></CODE> |
<span class="method-result">DataListSource</span> |
461 |
<BR> |
<span class="method-name"> |
462 |
<blockquote> This function determines if the column </blockquote> |
DataListSource |
463 |
</TD> |
</span> |
464 |
</TR> |
() |
465 |
|
</div> |
466 |
</TABLE> |
|
467 |
|
|
468 |
<hr> |
|
469 |
<!-- ============ VARIABLE DETAIL =========== --> |
</div> |
470 |
|
<a name="methodadd_column" id="add_column"><!-- --></a> |
471 |
<A NAME='variable_detail'></A> |
<div class="oddrow"> |
472 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
473 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<div class="method-header"> |
474 |
<TD> |
<span class="method-title">add_column</span> (line <span class="line-number">109</span>) |
475 |
<span CLASS="font12bold">Variable Detail</span> |
</div> |
476 |
<A HREF="#top" CLASS="links">^TOP</A> |
|
477 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
478 |
</TR> |
<p class="short-description">Add a column of data to manage</p> |
479 |
</TABLE> |
|
480 |
|
<div class="method-signature"> |
481 |
|
<span class="method-result">void</span> |
482 |
<A NAME='$_columns'><!-- --></A><H3>$_columns</H3> |
<span class="method-name"> |
483 |
<b>Data type:</b> array<br> |
add_column |
484 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
485 |
The column descriptions |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
486 |
for the data we are working on |
</div> |
487 |
<BR> |
|
488 |
|
<ul class="parameters"> |
489 |
|
<li> |
490 |
<UL> |
<span class="var-type">string</span> |
491 |
|
<span class="var-name">$title</span><span class="var-description">: - the title of the column</span> </li> |
492 |
</UL> |
<li> |
493 |
|
<span class="var-type">string</span> |
494 |
<HR> |
<span class="var-name">$data_name</span><span class="var-description">: - the data value name</span> </li> |
495 |
|
<li> |
496 |
<A NAME='$_data'><!-- --></A><H3>$_data</H3> |
<span class="var-type">boolean</span> |
497 |
<b>Data type:</b> mixed<br> |
<span class="var-name">$sortable</span><span class="var-description">: - is the column sortable? default: FALSE</span> </li> |
498 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
499 |
A placeholder for data that is read/built |
<span class="var-type">boolean</span> |
500 |
<BR> |
<span class="var-name">$searchable</span><span class="var-description">: - is the column searchable default: FALSE</span> </li> |
501 |
and stored locally. Not all data sources |
<li> |
502 |
have to use this. |
<span class="var-type">string</span> |
503 |
Each entry in the array corresponds to 1 row |
<span class="var-name">$sortorder</span><span class="var-description">: - the sort order (ASC, DESC) default: ASC</span> </li> |
504 |
of data. |
</ul> |
505 |
|
|
506 |
<UL> |
|
507 |
|
</div> |
508 |
</UL> |
<a name="methoddo_prequery" id="do_prequery"><!-- --></a> |
509 |
|
<div class="evenrow"> |
510 |
<HR> |
|
511 |
|
<div class="method-header"> |
512 |
<A NAME='$_data_index'><!-- --></A><H3>$_data_index</H3> |
<span class="method-title">do_prequery</span> (line <span class="line-number">198</span>) |
513 |
<b>Data type:</b> mixed<br> |
</div> |
514 |
<!-- ========== Info from phpDoc block ========= --> |
|
515 |
Holds the index into the array of data |
<!-- ========== Info from phpDoc block ========= --> |
516 |
<BR> |
<p class="short-description">This is a method that should be defined by the child class to do any pre-query type of things.</p> |
517 |
so we can keep track of where we are |
<p class="description"><p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p></p> |
518 |
when we are walking the array |
|
519 |
(only usefull for non DB children) |
<div class="method-signature"> |
520 |
|
<span class="method-result">void</span> |
521 |
<UL> |
<span class="method-name"> |
522 |
|
do_prequery |
523 |
</UL> |
</span> |
524 |
|
() |
525 |
<HR> |
</div> |
526 |
|
|
527 |
<A NAME='$_not_found_message'><!-- --></A><H3>$_not_found_message</H3> |
|
528 |
<b>Data type:</b> mixed<br> |
|
529 |
<!-- ========== Info from phpDoc block ========= --> |
<hr class="separator" /> |
530 |
This is the message displayed when no data |
<div class="notes">Redefined in descendants as:</div> |
531 |
<BR> |
<ul class="redefinitions"> |
532 |
was retrieved from the database |
<li> |
533 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_prequery">ArrayDataListSource::do_prequery()</a> |
534 |
<UL> |
: This is a method that should be defined by the child class to do any pre-query type of things. |
535 |
|
</li> |
536 |
</UL> |
<li> |
537 |
|
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a> |
538 |
<HR> |
: The prequery. We use this to read the file |
539 |
|
</li> |
540 |
<A NAME='$_query_params'><!-- --></A><H3>$_query_params</H3> |
<li> |
541 |
<b>Data type:</b> mixed<br> |
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a> |
542 |
<!-- ========== Info from phpDoc block ========= --> |
</li> |
543 |
This holds various parameters relating |
</ul> |
544 |
to the query of the data |
</div> |
545 |
<BR> |
<a name="methoddo_query" id="do_query"><!-- --></a> |
546 |
|
<div class="oddrow"> |
547 |
|
|
548 |
<UL> |
<div class="method-header"> |
549 |
|
<span class="method-title">do_query</span> (line <span class="line-number">213</span>) |
550 |
</UL> |
</div> |
551 |
|
|
552 |
<HR> |
<!-- ========== Info from phpDoc block ========= --> |
553 |
|
<p class="short-description">This is the function that does the data fetching, and sorting if needed.</p> |
554 |
|
<p class="description"><p>If the source is a sql database, this is where the query gets called. This function doesn't actually read the data from the DB yet. That is what get_next_data_row() does.</p></p> |
555 |
<hr> |
<ul class="tags"> |
556 |
<!-- ============ FUNCTION DETAIL =========== --> |
<li><span class="field">return:</span> - the query passed/failed.</li> |
557 |
|
</ul> |
558 |
<A NAME='function_detail'></A> |
|
559 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="method-signature"> |
560 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="method-result">boolean</span> |
561 |
<TD> |
<span class="method-name"> |
562 |
<span class="font12bold">Method Detail</span> |
do_query |
563 |
<A HREF="#top" CLASS="links">^TOP</A> |
</span> |
564 |
</TD> |
() |
565 |
</TR> |
</div> |
566 |
</TABLE> |
|
567 |
<BR> |
|
568 |
|
|
569 |
<DIV CLASS="function"> |
<hr class="separator" /> |
570 |
<A NAME='constructor DataListSource'><!-- --></A> |
<div class="notes">Redefined in descendants as:</div> |
571 |
<SPAN CLASS="font12bold">constructor DataListSource</SPAN> |
<ul class="redefinitions"> |
572 |
<BR> |
<li> |
573 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_query">ArrayDataListSource::do_query()</a> |
574 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
: This function does the query |
575 |
<span class="font10bold" style="color: #0000FF">constructor DataListSource ( )</SPAN> |
</li> |
576 |
<BR> |
<li> |
577 |
|
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a> |
578 |
<BR> |
: This function does the query |
579 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</li> |
580 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
581 |
The constructor |
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a> |
582 |
<BR> |
: Do the query to the DB and pull in all of the records locally. |
583 |
|
</li> |
584 |
<DL> |
<li> |
585 |
<DT class="font10bold">Function Parameters:</DT> |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methoddo_query">ADODBSQLDataListSource::do_query()</a> |
586 |
|
: This is the function that does the data fetching, and sorting if needed. |
587 |
|
</li> |
588 |
<DT class="font10bold">Function Info:</DT> |
<li> |
589 |
|
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query">PEARSQLDataListSource::do_query()</a> |
590 |
</DL> |
: This is the function that does the data fetching, and sorting if needed. |
591 |
|
</li> |
592 |
</DIV> |
<li> |
593 |
<BR> |
<a href="../phpHtmlLib/PGSQLDataListSource.html#methoddo_query">PGSQLDataListSource::do_query()</a> |
594 |
|
</li> |
595 |
<DIV CLASS="function"> |
</ul> |
596 |
<A NAME='add_column'><!-- --></A> |
</div> |
597 |
<SPAN CLASS="font12bold">add_column</SPAN> |
<a name="methodget_data_index" id="get_data_index"><!-- --></a> |
598 |
<BR> |
<div class="evenrow"> |
599 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
600 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-header"> |
601 |
<span class="font10bold" style="color: #0000FF">add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</SPAN> |
<span class="method-title">get_data_index</span> (line <span class="line-number">464</span>) |
602 |
<BR> |
</div> |
603 |
|
|
604 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
605 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<p class="short-description">This function returns the data_index value and increments it</p> |
606 |
<!-- ========== Info from phpDoc block ========= --> |
|
607 |
Add a column of data to manage |
<div class="method-signature"> |
608 |
<BR> |
<span class="method-result">int</span> |
609 |
|
<span class="method-name"> |
610 |
<DL> |
get_data_index |
611 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
612 |
|
() |
613 |
<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">$title</SPAN></SPAN> - the title of the column</DD> |
</div> |
614 |
|
|
615 |
<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">$data_name</SPAN></SPAN> - the data value name</DD> |
|
616 |
|
|
617 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$sortable</SPAN></SPAN> - is the column sortable? |
<hr class="separator" /> |
618 |
default: FALSE</DD> |
<div class="notes">Redefined in descendants as:</div> |
619 |
|
<ul class="redefinitions"> |
620 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$searchable</SPAN></SPAN> - is the column searchable |
<li> |
621 |
default: FALSE</DD> |
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_data_index">ArrayDataListSource::get_data_index()</a> |
622 |
|
: This function returns the data_index value and increments it |
623 |
<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">$sortorder</SPAN></SPAN> - the sort order (ASC, DESC) |
</li> |
624 |
default: ASC</DD> |
</ul> |
625 |
|
</div> |
626 |
|
<a name="methodget_limit" id="get_limit"><!-- --></a> |
627 |
<DT class="font10bold">Function Info:</DT> |
<div class="oddrow"> |
628 |
|
|
629 |
</DL> |
<div class="method-header"> |
630 |
|
<span class="method-title">get_limit</span> (line <span class="line-number">412</span>) |
631 |
</DIV> |
</div> |
632 |
<BR> |
|
633 |
|
<!-- ========== Info from phpDoc block ========= --> |
634 |
<DIV CLASS="function"> |
<p class="short-description">This function gets the current value of the limit value</p> |
635 |
<A NAME='do_prequery'><!-- --></A> |
|
636 |
<SPAN CLASS="font12bold">do_prequery</SPAN> |
<div class="method-signature"> |
637 |
<BR> |
<span class="method-result">int</span> |
638 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"> |
639 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
get_limit |
640 |
<span class="font10bold" style="color: #0000FF">do_prequery ( )</SPAN> |
</span> |
641 |
<BR> |
() |
642 |
Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#do_prequery">SQLDataListSource::do_prequery()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#do_prequery">CSVFILEDataListSource::do_prequery()</a><br> |
</div> |
643 |
<BR> |
|
644 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
645 |
<!-- ========== Info from phpDoc block ========= --> |
|
646 |
This is a method that should be defined by the |
</div> |
647 |
child class to do any pre-query type of things. |
<a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a> |
648 |
<BR> |
<div class="evenrow"> |
649 |
Such as building a sql query string for a DB, |
|
650 |
or checking to make sure the file on disk exists |
<div class="method-header"> |
651 |
if the source is a file on disk. |
<span class="method-title">get_next_data_row</span> (line <span class="line-number">174</span>) |
652 |
<DL> |
</div> |
653 |
<DT class="font10bold">Function Parameters:</DT> |
|
654 |
|
<!-- ========== Info from phpDoc block ========= --> |
655 |
|
<p class="short-description">This function gets the next data row from the query()</p> |
656 |
<DT class="font10bold">Function Info:</DT> |
|
657 |
|
<div class="method-signature"> |
658 |
</DL> |
<span class="method-result">array()</span> |
659 |
|
<span class="method-name"> |
660 |
</DIV> |
get_next_data_row |
661 |
<BR> |
</span> |
662 |
|
() |
663 |
<DIV CLASS="function"> |
</div> |
664 |
<A NAME='do_query'><!-- --></A> |
|
665 |
<SPAN CLASS="font12bold">do_query</SPAN> |
|
666 |
<BR> |
|
667 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<hr class="separator" /> |
668 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="notes">Redefined in descendants as:</div> |
669 |
<span class="font10bold" style="color: #0000FF">do_query ( )</SPAN> |
<ul class="redefinitions"> |
670 |
<BR> |
<li> |
671 |
Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#do_query">SQLDataListSource::do_query()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#do_query">CSVFILEDataListSource::do_query()</a><br> |
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_next_data_row">ArrayDataListSource::get_next_data_row()</a> |
672 |
<BR> |
: This function returns the next row of valid data. |
673 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</li> |
674 |
<!-- ========== Info from phpDoc block ========= --> |
<li> |
675 |
This is the function that does the data fetching, |
<a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a> |
676 |
and sorting if needed. |
: This function gets the next data row from the query() |
677 |
<BR> |
</li> |
678 |
If the source is a sql database, this is where the |
<li> |
679 |
query gets called. This function doesn't actually read the |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodget_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a> |
680 |
data from the DB yet. That is what get_next_data_row() |
: This function gets the next data row from the query() |
681 |
does. |
</li> |
682 |
<DL> |
<li> |
683 |
<DT class="font10bold">Function Parameters:</DT> |
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row">PEARSQLDataListSource::get_next_data_row()</a> |
684 |
|
: This function gets the next data row from the query() |
685 |
|
</li> |
686 |
<DT class="font10bold">Function Info:</DT> |
<li> |
687 |
|
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodget_next_data_row">PGSQLDataListSource::get_next_data_row()</a> |
688 |
</DL> |
: This function gets the next data row from the query() |
689 |
|
</li> |
690 |
</DIV> |
</ul> |
691 |
<BR> |
</div> |
692 |
|
<a name="methodget_not_found_message" id="get_not_found_message"><!-- --></a> |
693 |
<DIV CLASS="function"> |
<div class="oddrow"> |
694 |
<A NAME='get_data_index'><!-- --></A> |
|
695 |
<SPAN CLASS="font12bold">get_data_index</SPAN> |
<div class="method-header"> |
696 |
<BR> |
<span class="method-title">get_not_found_message</span> (line <span class="line-number">246</span>) |
697 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
698 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
699 |
<span class="font10bold" style="color: #0000FF">get_data_index ( )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
700 |
<BR> |
<p class="short-description">This function is used to get the message displayed when no data is found</p> |
701 |
|
|
702 |
<BR> |
<div class="method-signature"> |
703 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">string</span> |
704 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
705 |
This function returns the |
get_not_found_message |
706 |
data_index value and increments it |
</span> |
707 |
<BR> |
() |
708 |
|
</div> |
709 |
<DL> |
|
710 |
<DT class="font10bold">Function Parameters:</DT> |
|
711 |
|
|
712 |
|
</div> |
713 |
<DT class="font10bold">Function Info:</DT> |
<a name="methodget_offset" id="get_offset"><!-- --></a> |
714 |
|
<div class="evenrow"> |
715 |
</DL> |
|
716 |
|
<div class="method-header"> |
717 |
</DIV> |
<span class="method-title">get_offset</span> (line <span class="line-number">289</span>) |
718 |
<BR> |
</div> |
719 |
|
|
720 |
<DIV CLASS="function"> |
<!-- ========== Info from phpDoc block ========= --> |
721 |
<A NAME='get_limit'><!-- --></A> |
<p class="short-description">This function returns the value of the offset</p> |
722 |
<SPAN CLASS="font12bold">get_limit</SPAN> |
|
723 |
<BR> |
<div class="method-signature"> |
724 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-result">int</span> |
725 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<span class="method-name"> |
726 |
<span class="font10bold" style="color: #0000FF">get_limit ( )</SPAN> |
get_offset |
727 |
<BR> |
</span> |
728 |
|
() |
729 |
<BR> |
</div> |
730 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
731 |
<!-- ========== Info from phpDoc block ========= --> |
|
732 |
This function gets the current |
|
733 |
value of the limit value |
</div> |
734 |
<BR> |
<a name="methodget_orderby" id="get_orderby"><!-- --></a> |
735 |
|
<div class="oddrow"> |
736 |
<DL> |
|
737 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-header"> |
738 |
|
<span class="method-title">get_orderby</span> (line <span class="line-number">311</span>) |
739 |
|
</div> |
740 |
<DT class="font10bold">Function Info:</DT> |
|
741 |
|
<!-- ========== Info from phpDoc block ========= --> |
742 |
</DL> |
<p class="short-description">This function returns the value of the orderby</p> |
743 |
|
|
744 |
</DIV> |
<div class="method-signature"> |
745 |
<BR> |
<span class="method-result">int</span> |
746 |
|
<span class="method-name"> |
747 |
<DIV CLASS="function"> |
get_orderby |
748 |
<A NAME='get_next_data_row'><!-- --></A> |
</span> |
749 |
<SPAN CLASS="font12bold">get_next_data_row</SPAN> |
() |
750 |
<BR> |
</div> |
751 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
752 |
<span class="font10bold" style="color: #FF0000">array()</SPAN> |
|
753 |
<span class="font10bold" style="color: #0000FF">get_next_data_row ( )</SPAN> |
|
754 |
<BR> |
</div> |
755 |
Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#get_next_data_row">SQLDataListSource::get_next_data_row()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#get_next_data_row">CSVFILEDataListSource::get_next_data_row()</a><br> |
<a name="methodget_reverseorder" id="get_reverseorder"><!-- --></a> |
756 |
<BR> |
<div class="evenrow"> |
757 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
758 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
759 |
This function gets the next data row |
<span class="method-title">get_reverseorder</span> (line <span class="line-number">332</span>) |
760 |
from the query() |
</div> |
761 |
<BR> |
|
762 |
|
<!-- ========== Info from phpDoc block ========= --> |
763 |
<DL> |
<p class="short-description">This function returns the value of the reverseorder</p> |
764 |
<DT class="font10bold">Function Parameters:</DT> |
|
765 |
|
<div class="method-signature"> |
766 |
|
<span class="method-result">int</span> |
767 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-name"> |
768 |
|
get_reverseorder |
769 |
</DL> |
</span> |
770 |
|
() |
771 |
</DIV> |
</div> |
772 |
<BR> |
|
773 |
|
|
774 |
<DIV CLASS="function"> |
|
775 |
<A NAME='get_not_found_message'><!-- --></A> |
</div> |
776 |
<SPAN CLASS="font12bold">get_not_found_message</SPAN> |
<a name="methodget_searchby" id="get_searchby"><!-- --></a> |
777 |
<BR> |
<div class="oddrow"> |
778 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
779 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="method-header"> |
780 |
<span class="font10bold" style="color: #0000FF">get_not_found_message ( )</SPAN> |
<span class="method-title">get_searchby</span> (line <span class="line-number">352</span>) |
781 |
<BR> |
</div> |
782 |
|
|
783 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
784 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<p class="short-description">This function returns the value of the searchby</p> |
785 |
<!-- ========== Info from phpDoc block ========= --> |
|
786 |
This function is used to get the |
<div class="method-signature"> |
787 |
message displayed when no data is found |
<span class="method-result">int</span> |
788 |
<BR> |
<span class="method-name"> |
789 |
|
get_searchby |
790 |
<DL> |
</span> |
791 |
<DT class="font10bold">Function Parameters:</DT> |
() |
792 |
|
</div> |
793 |
|
|
794 |
<DT class="font10bold">Function Info:</DT> |
|
795 |
|
|
796 |
</DL> |
</div> |
797 |
|
<a name="methodget_searchby_value" id="get_searchby_value"><!-- --></a> |
798 |
</DIV> |
<div class="evenrow"> |
799 |
<BR> |
|
800 |
|
<div class="method-header"> |
801 |
<DIV CLASS="function"> |
<span class="method-title">get_searchby_value</span> (line <span class="line-number">372</span>) |
802 |
<A NAME='get_offset'><!-- --></A> |
</div> |
803 |
<SPAN CLASS="font12bold">get_offset</SPAN> |
|
804 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
805 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<p class="short-description">This function returns the value of the search value</p> |
806 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
807 |
<span class="font10bold" style="color: #0000FF">get_offset ( )</SPAN> |
<div class="method-signature"> |
808 |
<BR> |
<span class="method-result">int</span> |
809 |
|
<span class="method-name"> |
810 |
<BR> |
get_searchby_value |
811 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</span> |
812 |
<!-- ========== Info from phpDoc block ========= --> |
() |
813 |
This function returns the value of the |
</div> |
814 |
offset |
|
815 |
<BR> |
|
816 |
|
|
817 |
<DL> |
</div> |
818 |
<DT class="font10bold">Function Parameters:</DT> |
<a name="methodget_search_type" id="get_search_type"><!-- --></a> |
819 |
|
<div class="oddrow"> |
820 |
|
|
821 |
<DT class="font10bold">Function Info:</DT> |
<div class="method-header"> |
822 |
|
<span class="method-title">get_search_type</span> (line <span class="line-number">433</span>) |
823 |
</DL> |
</div> |
824 |
|
|
825 |
</DIV> |
<!-- ========== Info from phpDoc block ========= --> |
826 |
<BR> |
<p class="short-description">this function returns the current search type for the DataList query</p> |
827 |
|
|
828 |
<DIV CLASS="function"> |
<div class="method-signature"> |
829 |
<A NAME='get_orderby'><!-- --></A> |
<span class="method-result">string</span> |
830 |
<SPAN CLASS="font12bold">get_orderby</SPAN> |
<span class="method-name"> |
831 |
<BR> |
get_search_type |
832 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</span> |
833 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
() |
834 |
<span class="font10bold" style="color: #0000FF">get_orderby ( )</SPAN> |
</div> |
835 |
<BR> |
|
836 |
|
|
837 |
<BR> |
|
838 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
839 |
<!-- ========== Info from phpDoc block ========= --> |
<a name="methodget_secondary_orderby" id="get_secondary_orderby"><!-- --></a> |
840 |
This function returns the value of the |
<div class="evenrow"> |
841 |
orderby |
|
842 |
<BR> |
<div class="method-header"> |
843 |
|
<span class="method-title">get_secondary_orderby</span> (line <span class="line-number">454</span>) |
844 |
<DL> |
</div> |
845 |
<DT class="font10bold">Function Parameters:</DT> |
|
846 |
|
<!-- ========== Info from phpDoc block ========= --> |
847 |
|
<p class="short-description">This gets the list of secondary order by columns.</p> |
848 |
<DT class="font10bold">Function Info:</DT> |
|
849 |
|
<div class="method-signature"> |
850 |
</DL> |
<span class="method-result">array</span> |
851 |
|
<span class="method-name"> |
852 |
</DIV> |
get_secondary_orderby |
853 |
<BR> |
</span> |
854 |
|
() |
855 |
<DIV CLASS="function"> |
</div> |
856 |
<A NAME='get_reverseorder'><!-- --></A> |
|
857 |
<SPAN CLASS="font12bold">get_reverseorder</SPAN> |
|
858 |
<BR> |
|
859 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
860 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<a name="methodget_simplesearch_modifier" id="get_simplesearch_modifier"><!-- --></a> |
861 |
<span class="font10bold" style="color: #0000FF">get_reverseorder ( )</SPAN> |
<div class="oddrow"> |
862 |
<BR> |
|
863 |
|
<div class="method-header"> |
864 |
<BR> |
<span class="method-title">get_simplesearch_modifier</span> (line <span class="line-number">392</span>) |
865 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
866 |
<!-- ========== Info from phpDoc block ========= --> |
|
867 |
This function returns the value of the |
<!-- ========== Info from phpDoc block ========= --> |
868 |
reverseorder |
<p class="short-description">This function returns the value of the search value</p> |
869 |
<BR> |
|
870 |
|
<div class="method-signature"> |
871 |
<DL> |
<span class="method-result">int</span> |
872 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
873 |
|
get_simplesearch_modifier |
874 |
|
</span> |
875 |
<DT class="font10bold">Function Info:</DT> |
() |
876 |
|
</div> |
877 |
</DL> |
|
878 |
|
|
879 |
</DIV> |
|
880 |
<BR> |
</div> |
881 |
|
<a name="methodget_total_rows" id="get_total_rows"><!-- --></a> |
882 |
<DIV CLASS="function"> |
<div class="evenrow"> |
883 |
<A NAME='get_searchby'><!-- --></A> |
|
884 |
<SPAN CLASS="font12bold">get_searchby</SPAN> |
<div class="method-header"> |
885 |
<BR> |
<span class="method-title">get_total_rows</span> (line <span class="line-number">256</span>) |
886 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
887 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
888 |
<span class="font10bold" style="color: #0000FF">get_searchby ( )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
889 |
<BR> |
<p class="short-description">This returns the total number of rows in our entire data set</p> |
890 |
|
|
891 |
<BR> |
<div class="method-signature"> |
892 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">int</span> |
893 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
894 |
This function returns the value of the |
get_total_rows |
895 |
searchby |
</span> |
896 |
<BR> |
() |
897 |
|
</div> |
898 |
<DL> |
|
899 |
<DT class="font10bold">Function Parameters:</DT> |
|
900 |
|
|
901 |
|
</div> |
902 |
<DT class="font10bold">Function Info:</DT> |
<a name="methodquery" id="query"><!-- --></a> |
903 |
|
<div class="oddrow"> |
904 |
</DL> |
|
905 |
|
<div class="method-header"> |
906 |
</DIV> |
<span class="method-title">query</span> (line <span class="line-number">140</span>) |
907 |
<BR> |
</div> |
908 |
|
|
909 |
<DIV CLASS="function"> |
<!-- ========== Info from phpDoc block ========= --> |
910 |
<A NAME='get_searchby_value'><!-- --></A> |
<p class="short-description">The main Query function.</p> |
911 |
<SPAN CLASS="font12bold">get_searchby_value</SPAN> |
<p class="description"><p>This function is responsible for doing any data prefetching from a db,file and doing any sorting and searching on it depending on the values passed in from the DataList object</p></p> |
912 |
<BR> |
|
913 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="method-signature"> |
914 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<span class="method-result">void</span> |
915 |
<span class="font10bold" style="color: #0000FF">get_searchby_value ( )</SPAN> |
<span class="method-name"> |
916 |
<BR> |
query |
917 |
|
</span> |
918 |
<BR> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
919 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
920 |
<!-- ========== Info from phpDoc block ========= --> |
|
921 |
This function returns the value of the |
<ul class="parameters"> |
922 |
search value |
<li> |
923 |
<BR> |
<span class="var-type">int</span> |
924 |
|
<span class="var-name">$offset</span><span class="var-description">: - the offset into the data set</span> </li> |
925 |
<DL> |
<li> |
926 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-type">int</span> |
927 |
|
<span class="var-name">$limit</span><span class="var-description">: - the # of rows to get</span> </li> |
928 |
|
<li> |
929 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">string</span> |
930 |
|
<span class="var-name">$orderby</span><span class="var-description">: - the column to order the data by</span> </li> |
931 |
</DL> |
<li> |
932 |
|
<span class="var-type">string</span> |
933 |
</DIV> |
<span class="var-name">$reverseorder</span><span class="var-description">: - order in asc or reverse?</span> </li> |
934 |
<BR> |
<li> |
935 |
|
<span class="var-type">string</span> |
936 |
<DIV CLASS="function"> |
<span class="var-name">$searchby</span><span class="var-description">: - the column in the dataset to search by</span> </li> |
937 |
<A NAME='get_search_type'><!-- --></A> |
<li> |
938 |
<SPAN CLASS="font12bold">get_search_type</SPAN> |
<span class="var-type">string</span> |
939 |
<BR> |
<span class="var-name">$searchby_value</span><span class="var-description">: - the value to look for</span> </li> |
940 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> |
941 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="var-type">string</span> |
942 |
<span class="font10bold" style="color: #0000FF">get_search_type ( )</SPAN> |
<span class="var-name">$simplesearch_modifier</span><span class="var-description">: - the simple search modifier.</span> </li> |
943 |
<BR> |
</ul> |
944 |
|
|
945 |
<BR> |
|
946 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
947 |
<!-- ========== Info from phpDoc block ========= --> |
<a name="methodrow_filter" id="row_filter"><!-- --></a> |
948 |
this function returns the current search type |
<div class="evenrow"> |
949 |
for the DataList query |
|
950 |
<BR> |
<div class="method-header"> |
951 |
|
<span class="method-title">row_filter</span> (line <span class="line-number">185</span>) |
952 |
<DL> |
</div> |
953 |
<DT class="font10bold">Function Parameters:</DT> |
|
954 |
|
<!-- ========== Info from phpDoc block ========= --> |
955 |
|
<p class="short-description">This is called by the DataList object to allow us a chance to run the next row through a filter</p> |
956 |
<DT class="font10bold">Function Info:</DT> |
<ul class="tags"> |
957 |
|
<li><span class="field">return:</span> - TRUE = allow the row. FALSE = drop it.</li> |
958 |
</DL> |
</ul> |
959 |
|
|
960 |
</DIV> |
<div class="method-signature"> |
961 |
<BR> |
<span class="method-result">boolean</span> |
962 |
|
<span class="method-name"> |
963 |
<DIV CLASS="function"> |
row_filter |
964 |
<A NAME='get_simplesearch_modifier'><!-- --></A> |
</span> |
965 |
<SPAN CLASS="font12bold">get_simplesearch_modifier</SPAN> |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
966 |
<BR> |
</div> |
967 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
968 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
<ul class="parameters"> |
969 |
<span class="font10bold" style="color: #0000FF">get_simplesearch_modifier ( )</SPAN> |
<li> |
970 |
<BR> |
<span class="var-type">array</span> |
971 |
|
<span class="var-name">&$row_data</span><span class="var-description">: - the row to run through the filter</span> </li> |
972 |
<BR> |
</ul> |
973 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
974 |
<!-- ========== Info from phpDoc block ========= --> |
|
975 |
This function returns the value of the |
</div> |
976 |
search value |
<a name="methodset_limit" id="set_limit"><!-- --></a> |
977 |
<BR> |
<div class="oddrow"> |
978 |
|
|
979 |
<DL> |
<div class="method-header"> |
980 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-title">set_limit</span> (line <span class="line-number">402</span>) |
981 |
|
</div> |
982 |
|
|
983 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
984 |
|
<p class="short-description">This function is used to set</p> |
985 |
</DL> |
<p class="description"><p>the limit value, which limits the # of rows of data to allow to return</p></p> |
986 |
|
|
987 |
</DIV> |
<div class="method-signature"> |
988 |
<BR> |
<span class="method-result">void</span> |
989 |
|
<span class="method-name"> |
990 |
<DIV CLASS="function"> |
set_limit |
991 |
<A NAME='get_total_rows'><!-- --></A> |
</span> |
992 |
<SPAN CLASS="font12bold">get_total_rows</SPAN> |
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
993 |
<BR> |
</div> |
994 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
995 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
996 |
<span class="font10bold" style="color: #0000FF">get_total_rows ( )</SPAN> |
|
997 |
<BR> |
</div> |
998 |
|
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
999 |
<BR> |
<div class="evenrow"> |
1000 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1001 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
1002 |
This returns the total number of rows |
<span class="method-title">set_not_found_message</span> (line <span class="line-number">236</span>) |
1003 |
in our entire data set |
</div> |
1004 |
<BR> |
|
1005 |
|
<!-- ========== Info from phpDoc block ========= --> |
1006 |
<DL> |
<p class="short-description">This function is used to set the message displayed when no data is found</p> |
1007 |
<DT class="font10bold">Function Parameters:</DT> |
|
1008 |
|
<div class="method-signature"> |
1009 |
|
<span class="method-result">void</span> |
1010 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-name"> |
1011 |
|
set_not_found_message |
1012 |
</DL> |
</span> |
1013 |
|
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
1014 |
</DIV> |
</div> |
1015 |
<BR> |
|
1016 |
|
<ul class="parameters"> |
1017 |
<DIV CLASS="function"> |
<li> |
1018 |
<A NAME='query'><!-- --></A> |
<span class="var-type">string</span> |
1019 |
<SPAN CLASS="font12bold">query</SPAN> |
<span class="var-name">$mesg</span> </li> |
1020 |
<BR> |
</ul> |
1021 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1022 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1023 |
<span class="font10bold" style="color: #0000FF">query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</SPAN> |
</div> |
1024 |
<BR> |
<a name="methodset_offset" id="set_offset"><!-- --></a> |
1025 |
|
<div class="oddrow"> |
1026 |
<BR> |
|
1027 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-header"> |
1028 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-title">set_offset</span> (line <span class="line-number">278</span>) |
1029 |
The main Query function. |
</div> |
1030 |
<BR> |
|
1031 |
This function is responsible for doing |
<!-- ========== Info from phpDoc block ========= --> |
1032 |
any data prefetching from a db,file |
<p class="short-description">This sets the offset value and resets the index into the data array (in non DB children)</p> |
1033 |
and doing any sorting and searching |
|
1034 |
on it depending on the values passed |
<div class="method-signature"> |
1035 |
in from the DataList object |
<span class="method-result">void</span> |
1036 |
<DL> |
<span class="method-name"> |
1037 |
<DT class="font10bold">Function Parameters:</DT> |
set_offset |
1038 |
|
</span> |
1039 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> - the offset into the data set</DD> |
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
1040 |
|
</div> |
1041 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$limit</SPAN></SPAN> - the # of rows to get</DD> |
|
1042 |
|
<ul class="parameters"> |
1043 |
<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">$orderby</SPAN></SPAN> - the column to order the data by</DD> |
<li> |
1044 |
|
<span class="var-type">int</span> |
1045 |
<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">$reverseorder</SPAN></SPAN> - order in asc or reverse?</DD> |
<span class="var-name">$offset</span><span class="var-description">: offset</span> </li> |
1046 |
|
</ul> |
1047 |
<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">$searchby</SPAN></SPAN> - the column in the dataset |
|
1048 |
to search by</DD> |
|
1049 |
|
</div> |
1050 |
<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">$searchby_value</SPAN></SPAN> - the value to look for</DD> |
<a name="methodset_orderby" id="set_orderby"><!-- --></a> |
1051 |
|
<div class="evenrow"> |
1052 |
<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">$simplesearch_modifier</SPAN></SPAN> - the simple search modifier.</DD> |
|
1053 |
|
<div class="method-header"> |
1054 |
|
<span class="method-title">set_orderby</span> (line <span class="line-number">301</span>) |
1055 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1056 |
|
|
1057 |
</DL> |
<!-- ========== Info from phpDoc block ========= --> |
1058 |
|
<p class="short-description">This sets the orderby column name.</p> |
1059 |
</DIV> |
<p class="description"><p>This corresponds to the column that wants to be sorted/ordered, but not the actual direction (asc, desc)</p></p> |
1060 |
<BR> |
|
1061 |
|
<div class="method-signature"> |
1062 |
<DIV CLASS="function"> |
<span class="method-result">void</span> |
1063 |
<A NAME='set_limit'><!-- --></A> |
<span class="method-name"> |
1064 |
<SPAN CLASS="font12bold">set_limit</SPAN> |
set_orderby |
1065 |
<BR> |
</span> |
1066 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
1067 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
1068 |
<span class="font10bold" style="color: #0000FF">set_limit ( $limit )</SPAN> |
|
1069 |
<BR> |
<ul class="parameters"> |
1070 |
|
<li> |
1071 |
<BR> |
<span class="var-type">int</span> |
1072 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-name">$orderby</span><span class="var-description">: offset</span> </li> |
1073 |
<!-- ========== Info from phpDoc block ========= --> |
</ul> |
1074 |
This function is used to set |
|
1075 |
<BR> |
|
1076 |
the limit value, which limits |
</div> |
1077 |
the # of rows of data to allow |
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
1078 |
to return |
<div class="oddrow"> |
1079 |
<DL> |
|
1080 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-header"> |
1081 |
|
<span class="method-title">set_reverseorder</span> (line <span class="line-number">322</span>) |
1082 |
|
</div> |
1083 |
<DT class="font10bold">Function Info:</DT> |
|
1084 |
|
<!-- ========== Info from phpDoc block ========= --> |
1085 |
</DL> |
<p class="short-description">This sets the flag that tells us the direction in which to order the orderby column.</p> |
1086 |
|
|
1087 |
</DIV> |
<div class="method-signature"> |
1088 |
<BR> |
<span class="method-result">void</span> |
1089 |
|
<span class="method-name"> |
1090 |
<DIV CLASS="function"> |
set_reverseorder |
1091 |
<A NAME='set_not_found_message'><!-- --></A> |
</span> |
1092 |
<SPAN CLASS="font12bold">set_not_found_message</SPAN> |
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
1093 |
<BR> |
</div> |
1094 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1095 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<ul class="parameters"> |
1096 |
<span class="font10bold" style="color: #0000FF">set_not_found_message ( $mesg )</SPAN> |
<li> |
1097 |
<BR> |
<span class="var-type">int</span> |
1098 |
|
<span class="var-name">$order</span><span class="var-description">: offset</span> </li> |
1099 |
<BR> |
</ul> |
1100 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1101 |
<!-- ========== Info from phpDoc block ========= --> |
|
1102 |
This function is used to set the |
</div> |
1103 |
message displayed when no data is found |
<a name="methodset_searchby" id="set_searchby"><!-- --></a> |
1104 |
<BR> |
<div class="evenrow"> |
1105 |
|
|
1106 |
<DL> |
<div class="method-header"> |
1107 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-title">set_searchby</span> (line <span class="line-number">342</span>) |
1108 |
|
</div> |
1109 |
<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">$mesg</SPAN></SPAN> </DD> |
|
1110 |
|
<!-- ========== Info from phpDoc block ========= --> |
1111 |
|
<p class="short-description">This sets the column that we want to search from.</p> |
1112 |
<DT class="font10bold">Function Info:</DT> |
|
1113 |
|
<div class="method-signature"> |
1114 |
</DL> |
<span class="method-result">void</span> |
1115 |
|
<span class="method-name"> |
1116 |
</DIV> |
set_searchby |
1117 |
<BR> |
</span> |
1118 |
|
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
1119 |
<DIV CLASS="function"> |
</div> |
1120 |
<A NAME='set_offset'><!-- --></A> |
|
1121 |
<SPAN CLASS="font12bold">set_offset</SPAN> |
<ul class="parameters"> |
1122 |
<BR> |
<li> |
1123 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-type">int</span> |
1124 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="var-name">$search_col</span><span class="var-description">: offset</span> </li> |
1125 |
<span class="font10bold" style="color: #0000FF">set_offset ( $offset )</SPAN> |
</ul> |
1126 |
<BR> |
|
1127 |
|
|
1128 |
<BR> |
</div> |
1129 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a name="methodset_searchby_value" id="set_searchby_value"><!-- --></a> |
1130 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="oddrow"> |
1131 |
This sets the offset value |
|
1132 |
<BR> |
<div class="method-header"> |
1133 |
and resets the index into the data |
<span class="method-title">set_searchby_value</span> (line <span class="line-number">362</span>) |
1134 |
array (in non DB children) |
</div> |
1135 |
<DL> |
|
1136 |
<DT class="font10bold">Function Parameters:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
1137 |
|
<p class="short-description">This sets the data that we want to search for.</p> |
1138 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> offset</DD> |
|
1139 |
|
<div class="method-signature"> |
1140 |
|
<span class="method-result">void</span> |
1141 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-name"> |
1142 |
|
set_searchby_value |
1143 |
</DL> |
</span> |
1144 |
|
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
1145 |
</DIV> |
</div> |
1146 |
<BR> |
|
1147 |
|
<ul class="parameters"> |
1148 |
<DIV CLASS="function"> |
<li> |
1149 |
<A NAME='set_orderby'><!-- --></A> |
<span class="var-type">int</span> |
1150 |
<SPAN CLASS="font12bold">set_orderby</SPAN> |
<span class="var-name">$search_value</span><span class="var-description">: offset</span> </li> |
1151 |
<BR> |
</ul> |
1152 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
1153 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1154 |
<span class="font10bold" style="color: #0000FF">set_orderby ( $orderby )</SPAN> |
</div> |
1155 |
<BR> |
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
1156 |
|
<div class="evenrow"> |
1157 |
<BR> |
|
1158 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-header"> |
1159 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-title">set_search_type</span> (line <span class="line-number">423</span>) |
1160 |
This sets the orderby column name. |
</div> |
1161 |
<BR> |
|
1162 |
This corresponds to the column |
<!-- ========== Info from phpDoc block ========= --> |
1163 |
that wants to be sorted/ordered, but |
<p class="short-description">This function sets the search type (simple or advanced)</p> |
1164 |
not the actual direction (asc, desc) |
|
1165 |
<DL> |
<div class="method-signature"> |
1166 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">void</span> |
1167 |
|
<span class="method-name"> |
1168 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$orderby</SPAN></SPAN> offset</DD> |
set_search_type |
1169 |
|
</span> |
1170 |
|
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
1171 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1172 |
|
|
1173 |
</DL> |
<ul class="parameters"> |
1174 |
|
<li> |
1175 |
</DIV> |
<span class="var-type">string</span> |
1176 |
<BR> |
<span class="var-name">$search_type</span> </li> |
1177 |
|
</ul> |
1178 |
<DIV CLASS="function"> |
|
1179 |
<A NAME='set_reverseorder'><!-- --></A> |
|
1180 |
<SPAN CLASS="font12bold">set_reverseorder</SPAN> |
</div> |
1181 |
<BR> |
<a name="methodset_secondary_orderby" id="set_secondary_orderby"><!-- --></a> |
1182 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="oddrow"> |
1183 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1184 |
<span class="font10bold" style="color: #0000FF">set_reverseorder ( $order )</SPAN> |
<div class="method-header"> |
1185 |
<BR> |
<span class="method-title">set_secondary_orderby</span> (line <span class="line-number">444</span>) |
1186 |
|
</div> |
1187 |
<BR> |
|
1188 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
1189 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">This method is used to set a secondary list of columns to order/sort by.</p> |
1190 |
This sets the flag that tells us the |
|
1191 |
direction in which to order the orderby |
<div class="method-signature"> |
1192 |
column. |
<span class="method-result">void</span> |
1193 |
<BR> |
<span class="method-name"> |
1194 |
|
set_secondary_orderby |
1195 |
<DL> |
</span> |
1196 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
1197 |
|
</div> |
1198 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$order</SPAN></SPAN> offset</DD> |
|
1199 |
|
<ul class="parameters"> |
1200 |
|
<li> |
1201 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">mixed</span> |
1202 |
|
<span class="var-name">0</span><span class="var-description">: - n numbers of column names to order by</span> </li> |
1203 |
</DL> |
</ul> |
1204 |
|
|
1205 |
</DIV> |
|
1206 |
<BR> |
</div> |
1207 |
|
<a name="methodset_simplesearch_modifier" id="set_simplesearch_modifier"><!-- --></a> |
1208 |
<DIV CLASS="function"> |
<div class="evenrow"> |
1209 |
<A NAME='set_searchby'><!-- --></A> |
|
1210 |
<SPAN CLASS="font12bold">set_searchby</SPAN> |
<div class="method-header"> |
1211 |
<BR> |
<span class="method-title">set_simplesearch_modifier</span> (line <span class="line-number">382</span>) |
1212 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
1213 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1214 |
<span class="font10bold" style="color: #0000FF">set_searchby ( $search_col )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
1215 |
<BR> |
<p class="short-description">This sets the simple search modifier</p> |
1216 |
|
|
1217 |
<BR> |
<div class="method-signature"> |
1218 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">void</span> |
1219 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
1220 |
This sets the column that we want to search |
set_simplesearch_modifier |
1221 |
from. |
</span> |
1222 |
<BR> |
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
1223 |
|
</div> |
1224 |
<DL> |
|
1225 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="parameters"> |
1226 |
|
<li> |
1227 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_col</SPAN></SPAN> offset</DD> |
<span class="var-type">int</span> |
1228 |
|
<span class="var-name">$search_modifier</span><span class="var-description">: offset</span> </li> |
1229 |
|
</ul> |
1230 |
<DT class="font10bold">Function Info:</DT> |
|
1231 |
|
|
1232 |
</DL> |
</div> |
1233 |
|
<a name="methodset_total_rows" id="set_total_rows"><!-- --></a> |
1234 |
</DIV> |
<div class="oddrow"> |
1235 |
<BR> |
|
1236 |
|
<div class="method-header"> |
1237 |
<DIV CLASS="function"> |
<span class="method-title">set_total_rows</span> (line <span class="line-number">266</span>) |
1238 |
<A NAME='set_searchby_value'><!-- --></A> |
</div> |
1239 |
<SPAN CLASS="font12bold">set_searchby_value</SPAN> |
|
1240 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
1241 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<p class="short-description">This is used to set the total # of rows we have in our data set</p> |
1242 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1243 |
<span class="font10bold" style="color: #0000FF">set_searchby_value ( $search_value )</SPAN> |
<div class="method-signature"> |
1244 |
<BR> |
<span class="method-result">void</span> |
1245 |
|
<span class="method-name"> |
1246 |
<BR> |
set_total_rows |
1247 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</span> |
1248 |
<!-- ========== Info from phpDoc block ========= --> |
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
1249 |
This sets the data that we want to search |
</div> |
1250 |
for. |
|
1251 |
<BR> |
<ul class="parameters"> |
1252 |
|
<li> |
1253 |
<DL> |
<span class="var-type">int</span> |
1254 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-name">$num</span> </li> |
1255 |
|
</ul> |
1256 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_value</SPAN></SPAN> offset</DD> |
|
1257 |
|
|
1258 |
|
</div> |
1259 |
<DT class="font10bold">Function Info:</DT> |
<a name="methodsort" id="sort"><!-- --></a> |
1260 |
|
<div class="evenrow"> |
1261 |
</DL> |
|
1262 |
|
<div class="method-header"> |
1263 |
</DIV> |
<span class="method-title">sort</span> (line <span class="line-number">226</span>) |
1264 |
<BR> |
</div> |
1265 |
|
|
1266 |
<DIV CLASS="function"> |
<!-- ========== Info from phpDoc block ========= --> |
1267 |
<A NAME='set_search_type'><!-- --></A> |
<p class="short-description">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.</p> |
1268 |
<SPAN CLASS="font12bold">set_search_type</SPAN> |
<p class="description"><p>It should operate on the $this->_data array</p></p> |
1269 |
<BR> |
|
1270 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="method-signature"> |
1271 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="method-result">void</span> |
1272 |
<span class="font10bold" style="color: #0000FF">set_search_type ( $search_type )</SPAN> |
<span class="method-name"> |
1273 |
<BR> |
sort |
1274 |
|
</span> |
1275 |
<BR> |
() |
1276 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1277 |
<!-- ========== Info from phpDoc block ========= --> |
|
1278 |
This function sets the search type |
|
1279 |
(simple or advanced) |
|
1280 |
<BR> |
<hr class="separator" /> |
1281 |
|
<div class="notes">Redefined in descendants as:</div> |
1282 |
<DL> |
<ul class="redefinitions"> |
1283 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
1284 |
|
<a href="../phpHtmlLib/ArrayDataListSource.html#methodsort">ArrayDataListSource::sort()</a> |
1285 |
<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">$search_type</SPAN></SPAN> </DD> |
: This method sorts our data array by the requested column order by. This could be expensive for HUGE arrays. |
1286 |
|
</li> |
1287 |
|
</ul> |
1288 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1289 |
|
<a name="method_is_column_sortable" id="_is_column_sortable"><!-- --></a> |
1290 |
</DL> |
<div class="oddrow"> |
1291 |
|
|
1292 |
</DIV> |
<div class="method-header"> |
1293 |
<BR> |
<span class="method-title">_is_column_sortable</span> (line <span class="line-number">478</span>) |
1294 |
|
</div> |
1295 |
<DIV CLASS="function"> |
|
1296 |
<A NAME='set_simplesearch_modifier'><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
1297 |
<SPAN CLASS="font12bold">set_simplesearch_modifier</SPAN> |
<p class="short-description">This function determines if the column associated w/ a data_name is sortable or not</p> |
1298 |
<BR> |
<ul class="tags"> |
1299 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li><span class="field">return:</span> - is that column sortable?</li> |
1300 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</ul> |
1301 |
<span class="font10bold" style="color: #0000FF">set_simplesearch_modifier ( $search_modifier )</SPAN> |
|
1302 |
<BR> |
<div class="method-signature"> |
1303 |
|
<span class="method-result">boolean</span> |
1304 |
<BR> |
<span class="method-name"> |
1305 |
<SPAN CLASS="font10bold">Description : </SPAN> |
_is_column_sortable |
1306 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
1307 |
This sets the simple search modifier |
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
1308 |
<BR> |
</div> |
1309 |
|
|
1310 |
<DL> |
<ul class="parameters"> |
1311 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
1312 |
|
<span class="var-type">string</span> |
1313 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_modifier</SPAN></SPAN> offset</DD> |
<span class="var-name">$data_name</span><span class="var-description">: - the data_name filed in the _columns array to look for</span> </li> |
1314 |
|
</ul> |
1315 |
|
|
1316 |
<DT class="font10bold">Function Info:</DT> |
|
1317 |
|
</div> |
1318 |
</DL> |
|
1319 |
|
</div> |
1320 |
</DIV> |
</div> |
1321 |
<BR> |
|
1322 |
|
|
1323 |
<DIV CLASS="function"> |
<p class="notes" id="credit"> |
1324 |
<A NAME='set_total_rows'><!-- --></A> |
Documentation generated on Thu, 1 Apr 2004 09:38:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
1325 |
<SPAN CLASS="font12bold">set_total_rows</SPAN> |
</p> |
1326 |
<BR> |
</div></body> |
1327 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</html> |
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_total_rows ( $num )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This is used to set the total # of |
|
|
rows we have in our data set |
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$num</SPAN></SPAN> </DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='sort'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">sort</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">sort ( )</SPAN> |
|
|
<BR> |
|
|
Overridden in child class(es) as: <a href="../phpHtmlLib/CSVFILEDataListSource.html#sort">CSVFILEDataListSource::sort()</a><br> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
A generic method API that can be used at the bottom |
|
|
half of the do_query() method to sort data that is |
|
|
stored locally. |
|
|
<BR> |
|
|
This is only needed when the source |
|
|
is a non database. |
|
|
|
|
|
It should operate on the $this->_data array |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_is_column_sortable'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_is_column_sortable</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">boolean</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_is_column_sortable ( $data_name )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function determines if the column |
|
|
<BR> |
|
|
associated w/ a data_name is sortable |
|
|
or not |
|
|
<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">$data_name</SPAN></SPAN> - the data_name filed in the |
|
|
_columns array to look for</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - is that column sortable?</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
|
|
|
<hr> |
|
|
</HTML> |
|