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:33 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class SQLDataListSource</TITLE> |
<title>Docs For Class SQLDataListSource</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 SQLDataListSource</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 SQLDataListSource">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> |
<ul class="tags"> |
27 |
</TABLE> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
28 |
<BR> |
</ul> |
29 |
|
<p class="notes"> |
30 |
<!-- Start of Class Data --> |
Located in <a class="field" href="_widgets_data_list_SQLDataListSource_inc.html">/widgets/data_list/SQLDataListSource.inc</a> (line <span class="field">18</span>) |
31 |
<H2> |
</p> |
32 |
Class SQLDataListSource |
|
33 |
</H2> |
|
34 |
|
<pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a> |
|
<pre> |
|
|
<pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a> |
|
35 |
| |
| |
36 |
--SQLDataListSource</pre> |
--SQLDataListSource</pre> |
37 |
</pre> |
|
38 |
|
</div> |
39 |
<A NAME="children_summary"</A> |
</div> |
40 |
<H3> |
|
41 |
Classes extended from SQLDataListSource: <A HREF="#top" CLASS="links">^TOP</A> |
<a name="sec-descendents"></a> |
42 |
</H3> |
<div class="info-box"> |
43 |
<a href="../phpHtmlLib/PEARSQLDataListSource.html">PEARSQLDataListSource</a>, <a href="../phpHtmlLib/ADODBSQLDataListSource.html">ADODBSQLDataListSource</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/SQLDataListSource.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 |
|
|
50 |
<BR> |
</div> |
51 |
|
<div class="info-box-body"> |
52 |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
53 |
<UL> |
<tr> |
54 |
|
<th class="class-table-header">Class</th> |
55 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
<th class="class-table-header">Description</th> |
56 |
|
</tr> |
57 |
</UL> |
<tr> |
58 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ADODBSQLDataListSource.html">ADODBSQLDataListSource</a></td> |
59 |
<hr> |
<td> |
60 |
<!-- =========== VAR SUMMARY =========== --> |
This SQLDataListSource child class interacts with with the specific DB via the php ADODB DB abstraction objects. |
61 |
<A NAME='var_summary'><!-- --></A> |
</td> |
62 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</tr> |
63 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<tr> |
64 |
<TD> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/PEARSQLDataListSource.html">PEARSQLDataListSource</a></td> |
65 |
<span CLASS="font12bold">Class Variable Summary</span> |
<td> |
66 |
<A HREF="#top" CLASS="links">^TOP</A> |
This SQLDataListSource child class interacts with with the specific DB via the php PEAR DB abstraction objects. |
67 |
</TD> |
</td> |
68 |
</TR> |
</tr> |
69 |
|
<tr> |
70 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/PGSQLDataListSource.html">PGSQLDataListSource</a></td> |
71 |
<!-- =========== Summary =========== --> |
<td> |
72 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
This SQLDataListSource child class interacts with |
73 |
<TD> |
</td> |
74 |
<CODE><B><A HREF='SQLDataListSource.html#$_db_options'>$_db_options</A></B></CODE> |
</tr> |
75 |
<BR> |
</table> |
76 |
<blockquote> this holds all of the options |
</div> |
77 |
that make up the sql query </blockquote> |
</div> |
78 |
<blockquote> Default Value: <CODE>->array("values" => "", |
|
79 |
"tables" => "", |
|
80 |
"where_clause" => "", |
<a name="sec-var-summary"></a> |
81 |
"groupby_clause" => "", |
<div class="info-box"> |
82 |
"count_column" => "*")<-</CODE> </blockquote> |
<div class="info-box-title">Variable Summary</span></div> |
83 |
</TD> |
<div class="nav-bar"> |
84 |
</TR> |
<a href="#sec-description">Description</a> | |
85 |
|
<a href="#sec-descendents">Descendents</a> | |
86 |
<!-- =========== Summary =========== --> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
87 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| |
88 |
<TD> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
89 |
<CODE><B><A HREF='SQLDataListSource.html#$_query'>$_query</A></B></CODE> |
|
90 |
<BR> |
</div> |
91 |
<blockquote> The entire query built by </blockquote> |
<div class="info-box-body"> |
92 |
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote> |
<div class="var-summary"> |
93 |
</TD> |
<div class="var-title"> |
94 |
</TR> |
<span class="var-type">mixed</span> |
95 |
|
<a href="#$_db_options" title="details" class="var-name">$_db_options</a> |
96 |
</TABLE> |
</div> |
97 |
|
<div class="var-title"> |
98 |
<hr> |
<span class="var-type">mixed</span> |
99 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
<a href="#$_default_order_sensitivity" title="details" class="var-name">$_default_order_sensitivity</a> |
100 |
<A NAME='var_inherited_summary'><!-- --></A> |
</div> |
101 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="var-title"> |
102 |
<TR CLASS='TableHeadingColor'> |
<span class="var-type">mixed</span> |
103 |
<TD> |
<a href="#$_query" title="details" class="var-name">$_query</a> |
104 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
</div> |
105 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
106 |
</TD> |
</div> |
107 |
</TR> |
</div> |
108 |
|
|
109 |
|
<a name="sec-method-summary"></a> |
110 |
<!-- =========== Summary =========== --> |
<div class="info-box"> |
111 |
<TR BGCOLOR='white'> |
<div class="info-box-title">Method Summary</span></div> |
112 |
<TD> |
<div class="nav-bar"> |
113 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
<a href="#sec-description">Description</a> | |
114 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
<a href="#sec-descendents">Descendents</a> | |
115 |
<tr CLASS="tableheadingcolor"> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
116 |
<th>Variable</th> |
|
117 |
<th>Default Value</th> |
| |
118 |
<th>Description</th> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
119 |
</tr> |
</div> |
120 |
|
<div class="info-box-body"> |
121 |
<tr> |
<div class="method-summary"> |
122 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_columns'>$_columns</A></td> |
|
123 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
<div class="method-definition"> |
124 |
<td CLASS="font10">The column descriptions |
<span class="method-result">string</span> |
125 |
for the data we are working on</td> |
<a href="#advanced_search_where_clause" title="details" class="method-name">advanced_search_where_clause</a> |
126 |
</tr> |
() |
127 |
|
</div> |
128 |
<tr> |
|
129 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td> |
<div class="method-definition"> |
130 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
<span class="method-result">string</span> |
131 |
<td CLASS="font10">A placeholder for data that is read/built</td> |
<a href="#build_groupby_clause" title="details" class="method-name">build_groupby_clause</a> |
132 |
</tr> |
() |
133 |
|
</div> |
134 |
<tr> |
|
135 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td> |
<div class="method-definition"> |
136 |
<td CLASS="font10" STYLE="white-space: nowrap">->0<-</td> |
<span class="method-result">string</span> |
137 |
<td CLASS="font10">Holds the index into the array of data</td> |
<a href="#build_limit_clause" title="details" class="method-name">build_limit_clause</a> |
138 |
</tr> |
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, <span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
139 |
|
</div> |
140 |
<tr> |
|
141 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td> |
<div class="method-definition"> |
142 |
<td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td> |
<span class="method-result">string</span> |
143 |
<td CLASS="font10">This is the message displayed when no data</td> |
<a href="#build_order_clause" title="details" class="method-name">build_order_clause</a> |
144 |
</tr> |
() |
145 |
|
</div> |
146 |
<tr> |
|
147 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td> |
<div class="method-definition"> |
148 |
<td CLASS="font10" STYLE="white-space: nowrap">->array("num_total_rows" => 0, |
<span class="method-result">string</span> |
149 |
"offset" => 0, |
<a href="#build_query" title="details" class="method-name">build_query</a> |
150 |
"limit" => -1, |
([<span class="var-type">boolean</span> <span class="var-name">$limit_flag</span> = <span class="var-default">TRUE</span>]) |
151 |
"orderby" => '', |
</div> |
152 |
"reverseorder" => '', |
|
153 |
"searchby" => '', |
<div class="method-definition"> |
154 |
"searchvalue" => '', |
<span class="method-result">string</span> |
155 |
"searchmodifier" => '', |
<a href="#build_search_clause" title="details" class="method-name">build_search_clause</a> |
156 |
"searchtype" => 'simple')<-</td> |
() |
157 |
<td CLASS="font10">This holds various parameters relating |
</div> |
158 |
to the query of the data</td> |
|
159 |
</tr> |
<div class="method-definition"> |
160 |
|
<span class="method-result">string</span> |
161 |
</table> |
<a href="#build_where_clause" title="details" class="method-name">build_where_clause</a> |
162 |
<BR> |
() |
163 |
</TD> |
</div> |
164 |
</TR> |
|
165 |
|
<div class="method-definition"> |
166 |
</TABLE> |
<span class="method-result">int</span> |
167 |
|
<a href="#count" title="details" class="method-name">count</a> |
168 |
<hr> |
(<span class="var-type">mixed</span> <span class="var-name">$tables</span>, [<span class="var-type">string</span> <span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span> <span class="var-name">$count_clause</span> = <span class="var-default">'*'</span>], <span class="var-type">string</span> <span class="var-name">$table</span>) |
169 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
</div> |
170 |
<A NAME='functions_inherited'><!-- --></A> |
|
171 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="method-definition"> |
172 |
<TR CLASS='TableHeadingColor'> |
<span class="method-result">void</span> |
173 |
<TD> |
<a href="#do_prequery" title="details" class="method-name">do_prequery</a> |
174 |
<span CLASS="font12bold">Inherited Method Summary</span> |
() |
175 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
176 |
</TD> |
|
177 |
</TR> |
<div class="method-definition"> |
178 |
|
<span class="method-result">boolean</span> |
179 |
|
<a href="#do_query" title="details" class="method-name">do_query</a> |
180 |
<!-- =========== Summary =========== --> |
() |
181 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
182 |
<TD> |
|
183 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span> |
<div class="method-definition"> |
184 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
<span class="method-result">string</span> |
185 |
<tr CLASS="tableheadingcolor"> |
<a href="#get_count_column" title="details" class="method-name">get_count_column</a> |
186 |
<th>Function</th> |
() |
187 |
<th>Description</th> |
</div> |
188 |
</tr> |
|
189 |
|
<div class="method-definition"> |
190 |
<tr> |
<span class="method-result">string</span> |
191 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#constructor DataListSource'>constructor DataListSource ( )</A></td> |
<a href="#get_db_tables" title="details" class="method-name">get_db_tables</a> |
192 |
<td CLASS="font10">The constructor</td> |
() |
193 |
|
</div> |
194 |
<tr> |
|
195 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td> |
<div class="method-definition"> |
196 |
<td CLASS="font10">Add a column of data to manage</td> |
<span class="method-result">string</span> |
197 |
|
<a href="#get_db_values" title="details" class="method-name">get_db_values</a> |
198 |
<tr> |
() |
199 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery ( )</A></td> |
</div> |
200 |
<td CLASS="font10">This is a method that should be defined by the |
|
201 |
child class to do any pre-query type of things.</td> |
<div class="method-definition"> |
202 |
|
<span class="method-result">none</span> |
203 |
<tr> |
<a href="#get_default_order_case_sensitive" title="details" class="method-name">get_default_order_case_sensitive</a> |
204 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query ( )</A></td> |
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
205 |
<td CLASS="font10">This is the function that does the data fetching, |
</div> |
206 |
and sorting if needed.</td> |
|
207 |
|
<div class="method-definition"> |
208 |
<tr> |
<span class="method-result">array()</span> |
209 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index ( )</A></td> |
<a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a> |
210 |
<td CLASS="font10">This function returns the |
() |
211 |
data_index value and increments it</td> |
</div> |
212 |
|
|
213 |
<tr> |
<div class="method-definition"> |
214 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit ( )</A></td> |
<span class="method-result">void</span> |
215 |
<td CLASS="font10">This function gets the current |
<a href="#join_clauses" title="details" class="method-name">join_clauses</a> |
216 |
value of the limit value</td> |
() |
217 |
|
</div> |
218 |
<tr> |
|
219 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row ( )</A></td> |
<div class="method-definition"> |
220 |
<td CLASS="font10">This function gets the next data row |
<span class="method-result">string</span> |
221 |
from the query()</td> |
<a href="#search_value_filter" title="details" class="method-name">search_value_filter</a> |
222 |
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
223 |
<tr> |
</div> |
224 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message ( )</A></td> |
|
225 |
<td CLASS="font10">This function is used to get the |
<div class="method-definition"> |
226 |
message displayed when no data is found</td> |
<span class="method-result">void</span> |
227 |
|
<a href="#setup_db_options" title="details" class="method-name">setup_db_options</a> |
228 |
<tr> |
(<span class="var-type">string</span> <span class="var-name">$values</span>, <span class="var-type">string</span> <span class="var-name">$tables</span>, [<span class="var-type">string</span> <span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$groupby_clause</span> = <span class="var-default">''</span>]) |
229 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset ( )</A></td> |
</div> |
230 |
<td CLASS="font10">This function returns the value of the |
|
231 |
offset</td> |
<div class="method-definition"> |
232 |
|
<span class="method-result">string.</span> |
233 |
<tr> |
<a href="#setup_order" title="details" class="method-name">setup_order</a> |
234 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby ( )</A></td> |
(<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">boolean</span> <span class="var-name">$icase_sort</span> = <span class="var-default">FALSE</span>]) |
235 |
<td CLASS="font10">This function returns the value of the |
</div> |
236 |
orderby</td> |
|
237 |
|
<div class="method-definition"> |
238 |
<tr> |
<span class="method-result">void</span> |
239 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder ( )</A></td> |
<a href="#set_count_column" title="details" class="method-name">set_count_column</a> |
240 |
<td CLASS="font10">This function returns the value of the |
(<span class="var-type">mixed</span> <span class="var-name">$var</span>) |
241 |
reverseorder</td> |
</div> |
242 |
|
|
243 |
<tr> |
<div class="method-definition"> |
244 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby ( )</A></td> |
<span class="method-result">void</span> |
245 |
<td CLASS="font10">This function returns the value of the |
<a href="#set_db_groupby_clause" title="details" class="method-name">set_db_groupby_clause</a> |
246 |
searchby</td> |
(<span class="var-type">string</span> <span class="var-name">$clause</span>) |
247 |
|
</div> |
248 |
<tr> |
|
249 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value ( )</A></td> |
<div class="method-definition"> |
250 |
<td CLASS="font10">This function returns the value of the |
<span class="method-result">void</span> |
251 |
search value</td> |
<a href="#set_db_tables" title="details" class="method-name">set_db_tables</a> |
252 |
|
(<span class="var-type">string</span> <span class="var-name">$tables</span>) |
253 |
<tr> |
</div> |
254 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type ( )</A></td> |
|
255 |
<td CLASS="font10">this function returns the current search type |
<div class="method-definition"> |
256 |
for the DataList query</td> |
<span class="method-result">void</span> |
257 |
|
<a href="#set_db_values" title="details" class="method-name">set_db_values</a> |
258 |
<tr> |
(<span class="var-type">string</span> <span class="var-name">$values</span>) |
259 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier ( )</A></td> |
</div> |
260 |
<td CLASS="font10">This function returns the value of the |
|
261 |
search value</td> |
<div class="method-definition"> |
262 |
|
<span class="method-result">void</span> |
263 |
<tr> |
<a href="#set_db_where_clause" title="details" class="method-name">set_db_where_clause</a> |
264 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows ( )</A></td> |
(<span class="var-type">string</span> <span class="var-name">$where_clause</span>) |
265 |
<td CLASS="font10">This returns the total number of rows |
</div> |
266 |
in our entire data set</td> |
|
267 |
|
<div class="method-definition"> |
268 |
<tr> |
<span class="method-result">none</span> |
269 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td> |
<a href="#set_default_order_case_sensitive" title="details" class="method-name">set_default_order_case_sensitive</a> |
270 |
<td CLASS="font10">The main Query function.</td> |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
271 |
|
</div> |
272 |
<tr> |
|
273 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td> |
<div class="method-definition"> |
274 |
<td CLASS="font10">This function is used to set</td> |
<span class="method-result">string</span> |
275 |
|
<a href="#simple_search_where_clause" title="details" class="method-name">simple_search_where_clause</a> |
276 |
<tr> |
() |
277 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td> |
</div> |
278 |
<td CLASS="font10">This function is used to set the |
|
279 |
message displayed when no data is found</td> |
<div class="method-definition"> |
280 |
|
<span class="method-result">string</span> |
281 |
<tr> |
<a href="#sql_varchar_filter" title="details" class="method-name">sql_varchar_filter</a> |
282 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td> |
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
283 |
<td CLASS="font10">This sets the offset value</td> |
</div> |
284 |
|
</div> |
285 |
<tr> |
</div> |
286 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td> |
</div> |
287 |
<td CLASS="font10">This sets the orderby column name.</td> |
|
288 |
|
<a name="sec-vars"></a> |
289 |
<tr> |
<div class="info-box"> |
290 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td> |
<div class="info-box-title">Variables</div> |
291 |
<td CLASS="font10">This sets the flag that tells us the |
<div class="nav-bar"> |
292 |
direction in which to order the orderby |
<a href="#sec-description">Description</a> | |
293 |
column.</td> |
<a href="#sec-descendents">Descendents</a> | |
294 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
295 |
<tr> |
|
296 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td> |
|
297 |
<td CLASS="font10">This sets the column that we want to search |
| |
298 |
from.</td> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
299 |
|
|
300 |
<tr> |
</div> |
301 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td> |
<div class="info-box-body"> |
302 |
<td CLASS="font10">This sets the data that we want to search |
<a name="var$_db_options" id="$_db_options"><!-- --></A> |
303 |
for.</td> |
<div class="evenrow"> |
304 |
|
|
305 |
<tr> |
<div class="var-header"> |
306 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td> |
<span class="var-title"> |
307 |
<td CLASS="font10">This function sets the search type |
<span class="var-type">mixed</span> |
308 |
(simple or advanced)</td> |
<span class="var-name">$_db_options</span> |
309 |
|
= <span class="var-default">array("values" => "",<br /> "tables" => "",<br /> "where_clause" => "",<br /> "groupby_clause" => "",<br /> "count_column" => "*")</span> (line <span class="line-number">25</span>) |
310 |
<tr> |
</span> |
311 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td> |
</div> |
312 |
<td CLASS="font10">This sets the simple search modifier</td> |
|
313 |
|
<!-- ========== Info from phpDoc block ========= --> |
314 |
<tr> |
<p class="short-description">this holds all of the options</p> |
315 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td> |
<p class="description"><p>that make up the sql query</p></p> |
316 |
<td CLASS="font10">This is used to set the total # of |
|
317 |
rows we have in our data set</td> |
|
318 |
|
|
319 |
<tr> |
|
320 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort ( )</A></td> |
|
321 |
<td CLASS="font10">A generic method API that can be used at the bottom |
</div> |
322 |
half of the do_query() method to sort data that is |
<a name="var$_default_order_sensitivity" id="$_default_order_sensitivity"><!-- --></A> |
323 |
stored locally.</td> |
<div class="oddrow"> |
324 |
|
|
325 |
<tr> |
<div class="var-header"> |
326 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td> |
<span class="var-title"> |
327 |
<td CLASS="font10">This function determines if the column</td> |
<span class="var-type">mixed</span> |
328 |
|
<span class="var-name">$_default_order_sensitivity</span> |
329 |
</table> |
= <span class="var-default"> TRUE</span> (line <span class="line-number">45</span>) |
330 |
<br> |
</span> |
331 |
</TD> |
</div> |
332 |
</TR> |
|
333 |
|
<!-- ========== Info from phpDoc block ========= --> |
334 |
</TABLE> |
<p class="short-description">The flag that tells us to use case sensitive order by as a default.</p> |
335 |
|
<p class="description"><p>NOTE: we are case sensitive by default</p></p> |
336 |
<hr> |
|
337 |
<!-- should have constructor at some point --> |
|
338 |
<!-- =========== Method SUMMARY =========== --> |
|
339 |
<A NAME='Method_summary'><!-- --></A> |
|
340 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
|
341 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</div> |
342 |
<TD> |
<a name="var$_query" id="$_query"><!-- --></A> |
343 |
<span class="font12bold">Method Summary</span> |
<div class="evenrow"> |
344 |
<A HREF="#top" CLASS="links">^TOP</A> |
|
345 |
</TD> |
<div class="var-header"> |
346 |
</TR> |
<span class="var-title"> |
347 |
|
<span class="var-type">mixed</span> |
348 |
|
<span class="var-name">$_query</span> |
349 |
<!-- =========== Summary =========== --> |
= <span class="var-default"> ""</span> (line <span class="line-number">35</span>) |
350 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</span> |
351 |
<TD> |
</div> |
352 |
<CODE><B><A HREF='SQLDataListSource.html#advanced_search_where_clause'>string advanced_search_where_clause ( )</A></B></CODE> |
|
353 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
354 |
<blockquote> This function is responsible for |
<p class="short-description">The entire query built by</p> |
355 |
building the portion of the where clause |
<p class="description"><p>build_query()</p></p> |
356 |
for doing an advanced search. </blockquote> |
|
357 |
</TD> |
|
358 |
</TR> |
|
359 |
|
|
360 |
<!-- =========== Summary =========== --> |
|
361 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
362 |
<TD> |
<h4>Inherited Variables</h4> |
363 |
<CODE><B><A HREF='SQLDataListSource.html#build_groupby_clause'>string build_groupby_clause ( )</A></B></CODE> |
<A NAME='inherited_vars'><!-- --></A> |
364 |
<BR> |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p> |
365 |
<blockquote> this builds the groupby clause of the query </blockquote> |
<blockquote> |
366 |
</TD> |
<span class="var-title"> |
367 |
</TR> |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br> |
368 |
|
</span> |
369 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
370 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br> |
371 |
<TD> |
</span> |
372 |
<CODE><B><A HREF='SQLDataListSource.html#build_limit_clause'>string build_limit_clause ( $offset, $limit )</A></B></CODE> |
<span class="var-title"> |
373 |
<BR> |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br> |
374 |
<blockquote> This function builds the limit </blockquote> |
</span> |
375 |
</TD> |
<span class="var-title"> |
376 |
</TR> |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br> |
377 |
|
</span> |
378 |
<!-- =========== Summary =========== --> |
<span class="var-title"> |
379 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br> |
380 |
<TD> |
</span> |
381 |
<CODE><B><A HREF='SQLDataListSource.html#build_order_clause'>string build_order_clause ( )</A></B></CODE> |
</blockquote> |
382 |
<BR> |
|
383 |
<blockquote> This builds the db query ORDER BY |
</div> |
384 |
clause used to sort the data from the DB. </blockquote> |
</div> |
385 |
</TD> |
|
386 |
</TR> |
<a name="sec-methods"></a> |
387 |
|
<div class="info-box"> |
388 |
<!-- =========== Summary =========== --> |
<div class="info-box-title">Methods</div> |
389 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="nav-bar"> |
390 |
<TD> |
<a href="#sec-description">Description</a> | |
391 |
<CODE><B><A HREF='SQLDataListSource.html#build_query'>string build_query ( [$limit_flag = TRUE] )</A></B></CODE> |
<a href="#sec-descendents">Descendents</a> | |
392 |
<BR> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
393 |
<blockquote> build the entire DB query </blockquote> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
394 |
</TD> |
|
395 |
</TR> |
</div> |
396 |
|
<div class="info-box-body"> |
397 |
<!-- =========== Summary =========== --> |
<A NAME='method_detail'></A> |
398 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="methodadvanced_search_where_clause" id="advanced_search_where_clause"><!-- --></a> |
399 |
<TD> |
<div class="oddrow"> |
400 |
<CODE><B><A HREF='SQLDataListSource.html#build_search_clause'>string build_search_clause ( )</A></B></CODE> |
|
401 |
<BR> |
<div class="method-header"> |
402 |
<blockquote> This method builds the where clause. </blockquote> |
<span class="method-title">advanced_search_where_clause</span> (line <span class="line-number">238</span>) |
403 |
</TD> |
</div> |
404 |
</TR> |
|
405 |
|
<!-- ========== Info from phpDoc block ========= --> |
406 |
<!-- =========== Summary =========== --> |
<p class="short-description">This function is responsible for building the portion of the where clause for doing an advanced search.</p> |
407 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<p class="description"><p>NOTE: the child class MUST override this method</p></p> |
408 |
<TD> |
<ul class="tags"> |
409 |
<CODE><B><A HREF='SQLDataListSource.html#build_where_clause'>string build_where_clause ( )</A></B></CODE> |
<li><span class="field">return:</span> - portion of the where clause</li> |
410 |
<BR> |
</ul> |
411 |
<blockquote> This builds the where clause for |
|
412 |
the query </blockquote> |
<div class="method-signature"> |
413 |
</TD> |
<span class="method-result">string</span> |
414 |
</TR> |
<span class="method-name"> |
415 |
|
advanced_search_where_clause |
416 |
<!-- =========== Summary =========== --> |
</span> |
417 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
() |
418 |
<TD> |
</div> |
419 |
<CODE><B><A HREF='SQLDataListSource.html#count'>int count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></B></CODE> |
|
420 |
<BR> |
|
421 |
<blockquote> find the number of rows to be returned |
|
422 |
from a query from a table and where clause </blockquote> |
</div> |
423 |
</TD> |
<a name="methodbuild_groupby_clause" id="build_groupby_clause"><!-- --></a> |
424 |
</TR> |
<div class="evenrow"> |
425 |
|
|
426 |
<!-- =========== Summary =========== --> |
<div class="method-header"> |
427 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-title">build_groupby_clause</span> (line <span class="line-number">371</span>) |
428 |
<TD> |
</div> |
429 |
<CODE><B><A HREF='SQLDataListSource.html#do_prequery'>void do_prequery ( )</A></B></CODE> |
|
430 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
431 |
<blockquote> </blockquote> |
<p class="short-description">this builds the groupby clause of the query</p> |
432 |
</TD> |
|
433 |
</TR> |
<div class="method-signature"> |
434 |
|
<span class="method-result">string</span> |
435 |
<!-- =========== Summary =========== --> |
<span class="method-name"> |
436 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
build_groupby_clause |
437 |
<TD> |
</span> |
438 |
<CODE><B><A HREF='SQLDataListSource.html#do_query'>void do_query ( )</A></B></CODE> |
() |
439 |
<BR> |
</div> |
440 |
<blockquote> Do the query to the DB and pull in all of |
|
441 |
the records locally. </blockquote> |
|
442 |
</TD> |
|
443 |
</TR> |
</div> |
444 |
|
<a name="methodbuild_limit_clause" id="build_limit_clause"><!-- --></a> |
445 |
<!-- =========== Summary =========== --> |
<div class="oddrow"> |
446 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
447 |
<TD> |
<div class="method-header"> |
448 |
<CODE><B><A HREF='SQLDataListSource.html#get_count_column'>string get_count_column ( )</A></B></CODE> |
<span class="method-title">build_limit_clause</span> (line <span class="line-number">488</span>) |
449 |
<BR> |
</div> |
450 |
<blockquote> this returns the current count column </blockquote> |
|
451 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
452 |
</TR> |
<p class="short-description">This function builds the limit clause portion of a DB query.</p> |
453 |
|
<p class="description"><p>This is specific to the particular DB implementation.</p></p> |
454 |
<!-- =========== Summary =========== --> |
<ul class="tags"> |
455 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<li><span class="field">return:</span> - the limit portion of the query.</li> |
456 |
<TD> |
</ul> |
457 |
<CODE><B><A HREF='SQLDataListSource.html#get_count_column'>string get_count_column ( )</A></B></CODE> |
|
458 |
<BR> |
<div class="method-signature"> |
459 |
<blockquote> this gets the count column </blockquote> |
<span class="method-result">string</span> |
460 |
</TD> |
<span class="method-name"> |
461 |
</TR> |
build_limit_clause |
462 |
|
</span> |
463 |
<!-- =========== Summary =========== --> |
(<span class="var-type">mixed</span> <span class="var-name">$offset</span>, <span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
464 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
465 |
<TD> |
|
466 |
<CODE><B><A HREF='SQLDataListSource.html#get_db_tables'>string get_db_tables ( )</A></B></CODE> |
|
467 |
<BR> |
|
468 |
<blockquote> returns the table(s) used in the query </blockquote> |
<hr class="separator" /> |
469 |
</TD> |
<div class="notes">Redefined in descendants as:</div> |
470 |
</TR> |
<ul class="redefinitions"> |
471 |
|
<li> |
472 |
<!-- =========== Summary =========== --> |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodbuild_limit_clause">ADODBSQLDataListSource::build_limit_clause()</a> |
473 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
: This function builds the limit clause portion of a DB query. |
474 |
<TD> |
</li> |
475 |
<CODE><B><A HREF='SQLDataListSource.html#get_db_values'>string get_db_values ( )</A></B></CODE> |
<li> |
476 |
<BR> |
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodbuild_limit_clause">PEARSQLDataListSource::build_limit_clause()</a> |
477 |
<blockquote> This function returns the </blockquote> |
: This function builds the limit clause portion of a DB query. |
478 |
</TD> |
</li> |
479 |
</TR> |
<li> |
480 |
|
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodbuild_limit_clause">PGSQLDataListSource::build_limit_clause()</a> |
481 |
<!-- =========== Summary =========== --> |
: This function builds the limit clause portion of a DB query. |
482 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</li> |
483 |
<TD> |
</ul> |
484 |
<CODE><B><A HREF='SQLDataListSource.html#get_next_data_row'>array() get_next_data_row ( )</A></B></CODE> |
</div> |
485 |
<BR> |
<a name="methodbuild_order_clause" id="build_order_clause"><!-- --></a> |
486 |
<blockquote> This function gets the next data row |
<div class="evenrow"> |
487 |
from the query() </blockquote> |
|
488 |
</TD> |
<div class="method-header"> |
489 |
</TR> |
<span class="method-title">build_order_clause</span> (line <span class="line-number">341</span>) |
490 |
|
</div> |
491 |
<!-- =========== Summary =========== --> |
|
492 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
493 |
<TD> |
<p class="short-description">This builds the db query ORDER BY clause used to sort the data from the DB.</p> |
494 |
<CODE><B><A HREF='SQLDataListSource.html#join_clauses'>void join_clauses ( )</A></B></CODE> |
<ul class="tags"> |
495 |
<BR> |
<li><span class="field">return:</span> - the order by clause</li> |
496 |
<blockquote> </blockquote> |
</ul> |
497 |
</TD> |
|
498 |
</TR> |
<div class="method-signature"> |
499 |
|
<span class="method-result">string</span> |
500 |
<!-- =========== Summary =========== --> |
<span class="method-name"> |
501 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
build_order_clause |
502 |
<TD> |
</span> |
503 |
<CODE><B><A HREF='SQLDataListSource.html#search_value_filter'>string search_value_filter ( $value )</A></B></CODE> |
() |
504 |
<BR> |
</div> |
505 |
<blockquote> This function does the variable cleaning </blockquote> |
|
506 |
</TD> |
|
507 |
</TR> |
|
508 |
|
</div> |
509 |
<!-- =========== Summary =========== --> |
<a name="methodbuild_query" id="build_query"><!-- --></a> |
510 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="oddrow"> |
511 |
<TD> |
|
512 |
<CODE><B><A HREF='SQLDataListSource.html#setup_db_options'>void setup_db_options ( $values, $tables, [$where_clause = ''], [$groupby_clause = ''] )</A></B></CODE> |
<div class="method-header"> |
513 |
<BR> |
<span class="method-title">build_query</span> (line <span class="line-number">386</span>) |
514 |
<blockquote> Set which DB options |
</div> |
515 |
to use for this list. </blockquote> |
|
516 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
517 |
</TR> |
<p class="short-description">build the entire DB query</p> |
518 |
|
<ul class="tags"> |
519 |
<!-- =========== Summary =========== --> |
<li><span class="field">return:</span> - the full query string to the DB.</li> |
520 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</ul> |
521 |
<TD> |
|
522 |
<CODE><B><A HREF='SQLDataListSource.html#setup_order'>string. setup_order ( $orderby, $reverseorder )</A></B></CODE> |
<div class="method-signature"> |
523 |
<BR> |
<span class="method-result">string</span> |
524 |
<blockquote> This function builds the orderby clause |
<span class="method-name"> |
525 |
for the DB query. </blockquote> |
build_query |
526 |
</TD> |
</span> |
527 |
</TR> |
([<span class="var-type">boolean</span> <span class="var-name">$limit_flag</span> = <span class="var-default">TRUE</span>]) |
528 |
|
</div> |
529 |
<!-- =========== Summary =========== --> |
|
530 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="parameters"> |
531 |
<TD> |
<li> |
532 |
<CODE><B><A HREF='SQLDataListSource.html#set_count_column'>void set_count_column ( $var )</A></B></CODE> |
<span class="var-type">boolean</span> |
533 |
<BR> |
<span class="var-name">$limit_flag</span><span class="var-description">: - build the limit clause or not/</span> </li> |
534 |
<blockquote> This function changes the counted column. </blockquote> |
</ul> |
535 |
</TD> |
|
536 |
</TR> |
|
537 |
|
</div> |
538 |
<!-- =========== Summary =========== --> |
<a name="methodbuild_search_clause" id="build_search_clause"><!-- --></a> |
539 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="evenrow"> |
540 |
<TD> |
|
541 |
<CODE><B><A HREF='SQLDataListSource.html#set_db_groupby_clause'>void set_db_groupby_clause ( $clause )</A></B></CODE> |
<div class="method-header"> |
542 |
<BR> |
<span class="method-title">build_search_clause</span> (line <span class="line-number">298</span>) |
543 |
<blockquote> Sets the groupby clause for the query </blockquote> |
</div> |
544 |
</TD> |
|
545 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
546 |
|
<p class="short-description">This method builds the where clause.</p> |
547 |
<!-- =========== Summary =========== --> |
|
548 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-signature"> |
549 |
<TD> |
<span class="method-result">string</span> |
550 |
<CODE><B><A HREF='SQLDataListSource.html#set_db_tables'>void set_db_tables ( $tables )</A></B></CODE> |
<span class="method-name"> |
551 |
<BR> |
build_search_clause |
552 |
<blockquote> Set the tables from the DB you |
</span> |
553 |
want to select on. </blockquote> |
() |
554 |
</TD> |
</div> |
555 |
</TR> |
|
556 |
|
|
557 |
<!-- =========== Summary =========== --> |
|
558 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
559 |
<TD> |
<a name="methodbuild_where_clause" id="build_where_clause"><!-- --></a> |
560 |
<CODE><B><A HREF='SQLDataListSource.html#set_db_values'>void set_db_values ( $values )</A></B></CODE> |
<div class="oddrow"> |
561 |
<BR> |
|
562 |
<blockquote> Set the values we want to select |
<div class="method-header"> |
563 |
from the db. </blockquote> |
<span class="method-title">build_where_clause</span> (line <span class="line-number">273</span>) |
564 |
</TD> |
</div> |
565 |
</TR> |
|
566 |
|
<!-- ========== Info from phpDoc block ========= --> |
567 |
<!-- =========== Summary =========== --> |
<p class="short-description">This builds the where clause for the query</p> |
568 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="tags"> |
569 |
<TD> |
<li><span class="field">return:</span> the where clause.</li> |
570 |
<CODE><B><A HREF='SQLDataListSource.html#set_db_where_clause'>void set_db_where_clause ( $where_clause )</A></B></CODE> |
</ul> |
571 |
<BR> |
|
572 |
<blockquote> Set the user portion of the where |
<div class="method-signature"> |
573 |
clause. </blockquote> |
<span class="method-result">string</span> |
574 |
</TD> |
<span class="method-name"> |
575 |
</TR> |
build_where_clause |
576 |
|
</span> |
577 |
<!-- =========== Summary =========== --> |
() |
578 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
579 |
<TD> |
|
580 |
<CODE><B><A HREF='SQLDataListSource.html#simple_search_where_clause'>string simple_search_where_clause ( )</A></B></CODE> |
|
581 |
<BR> |
|
582 |
<blockquote> this builds the search clause </blockquote> |
</div> |
583 |
</TD> |
<a name="methodcount" id="count"><!-- --></a> |
584 |
</TR> |
<div class="evenrow"> |
585 |
|
|
586 |
<!-- =========== Summary =========== --> |
<div class="method-header"> |
587 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-title">count</span> (line <span class="line-number">501</span>) |
588 |
<TD> |
</div> |
589 |
<CODE><B><A HREF='SQLDataListSource.html#sql_varchar_filter'>string sql_varchar_filter ( $value )</A></B></CODE> |
|
590 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
591 |
<blockquote> Clean up the string so it can work in a db </blockquote> |
<p class="short-description">find the number of rows to be returned from a query from a table and where clause</p> |
592 |
</TD> |
<ul class="tags"> |
593 |
</TR> |
<li><span class="field">return:</span> the # of rows</li> |
594 |
|
</ul> |
595 |
</TABLE> |
|
596 |
|
<div class="method-signature"> |
597 |
<hr> |
<span class="method-result">int</span> |
598 |
<!-- ============ VARIABLE DETAIL =========== --> |
<span class="method-name"> |
599 |
|
count |
600 |
<A NAME='variable_detail'></A> |
</span> |
601 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
(<span class="var-type">mixed</span> <span class="var-name">$tables</span>, [<span class="var-type">string</span> <span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span> <span class="var-name">$count_clause</span> = <span class="var-default">'*'</span>], <span class="var-type">string</span> <span class="var-name">$table</span>) |
602 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</div> |
603 |
<TD> |
|
604 |
<span CLASS="font12bold">Variable Detail</span> |
<ul class="parameters"> |
605 |
<A HREF="#top" CLASS="links">^TOP</A> |
<li> |
606 |
</TD> |
<span class="var-type">string</span> |
607 |
</TR> |
<span class="var-name">$table</span><span class="var-description">: - the table to count from</span> </li> |
608 |
</TABLE> |
<li> |
609 |
|
<span class="var-type">string</span> |
610 |
|
<span class="var-name">$where_clause</span><span class="var-description">: - a where clause</span> </li> |
611 |
<A NAME='$_db_options'><!-- --></A><H3>$_db_options</H3> |
</ul> |
612 |
<b>Data type:</b> mixed<br> |
|
613 |
<!-- ========== Info from phpDoc block ========= --> |
|
614 |
this holds all of the options |
<hr class="separator" /> |
615 |
that make up the sql query |
<div class="notes">Redefined in descendants as:</div> |
616 |
<BR> |
<ul class="redefinitions"> |
617 |
|
<li> |
618 |
|
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodcount">ADODBSQLDataListSource::count()</a> |
619 |
<UL> |
: find the number of rows to be returned from a query from a table and where clause |
620 |
|
</li> |
621 |
</UL> |
<li> |
622 |
|
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodcount">PEARSQLDataListSource::count()</a> |
623 |
<HR> |
: find the number of rows to be returned from a query from a table and where clause |
624 |
|
</li> |
625 |
<A NAME='$_query'><!-- --></A><H3>$_query</H3> |
<li> |
626 |
<b>Data type:</b> mixed<br> |
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodcount">PGSQLDataListSource::count()</a> |
627 |
<!-- ========== Info from phpDoc block ========= --> |
: find the number of rows to be returned from a query from a table and where clause |
628 |
The entire query built by |
</li> |
629 |
<BR> |
</ul> |
630 |
build_query() |
</div> |
631 |
|
<a name="methoddo_prequery" id="do_prequery"><!-- --></a> |
632 |
<UL> |
<div class="oddrow"> |
633 |
|
|
634 |
</UL> |
<div class="method-header"> |
635 |
|
<span class="method-title">do_prequery</span> (line <span class="line-number">403</span>) |
636 |
<HR> |
</div> |
637 |
|
|
638 |
|
<!-- ========== Info from phpDoc block ========= --> |
639 |
<hr> |
|
640 |
<!-- ============ FUNCTION DETAIL =========== --> |
<div class="method-signature"> |
641 |
|
<span class="method-result">void</span> |
642 |
<A NAME='function_detail'></A> |
<span class="method-name"> |
643 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
do_prequery |
644 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</span> |
645 |
<TD> |
() |
646 |
<span class="font12bold">Method Detail</span> |
</div> |
647 |
<A HREF="#top" CLASS="links">^TOP</A> |
|
648 |
</TD> |
|
649 |
</TR> |
<hr class="separator" /> |
650 |
</TABLE> |
<div class="notes">Redefinition of:</div> |
651 |
<BR> |
<dl> |
652 |
|
<dt><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></dt> |
653 |
<DIV CLASS="function"> |
<dd>This is a method that should be defined by the child class to do any pre-query type of things.</dd> |
654 |
<A NAME='advanced_search_where_clause'><!-- --></A> |
</dl> |
655 |
<SPAN CLASS="font12bold">advanced_search_where_clause</SPAN> |
|
656 |
<BR> |
</div> |
657 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methoddo_query" id="do_query"><!-- --></a> |
658 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="evenrow"> |
659 |
<span class="font10bold" style="color: #0000FF">advanced_search_where_clause ( )</SPAN> |
|
660 |
<BR> |
<div class="method-header"> |
661 |
|
<span class="method-title">do_query</span> (line <span class="line-number">460</span>) |
662 |
<BR> |
</div> |
663 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
664 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
665 |
This function is responsible for |
<p class="short-description">Do the query to the DB and pull in all of the records locally.</p> |
666 |
building the portion of the where clause |
<ul class="tags"> |
667 |
for doing an advanced search. |
<li><span class="field">return:</span> - the query passed/failed.</li> |
668 |
<BR> |
</ul> |
669 |
NOTE: the child class MUST override this |
|
670 |
method |
<div class="method-signature"> |
671 |
<DL> |
<span class="method-result">boolean</span> |
672 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
673 |
|
do_query |
674 |
|
</span> |
675 |
<DT class="font10bold">Function Info:</DT> |
() |
676 |
|
</div> |
677 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - portion of the where clause</DD> |
|
678 |
|
|
679 |
</DL> |
<hr class="separator" /> |
680 |
|
<div class="notes">Redefinition of:</div> |
681 |
</DIV> |
<dl> |
682 |
<BR> |
<dt><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></dt> |
683 |
|
<dd>This is the function that does the data fetching, and sorting if needed.</dd> |
684 |
<DIV CLASS="function"> |
</dl> |
685 |
<A NAME='build_groupby_clause'><!-- --></A> |
|
686 |
<SPAN CLASS="font12bold">build_groupby_clause</SPAN> |
<hr class="separator" /> |
687 |
<BR> |
<div class="notes">Redefined in descendants as:</div> |
688 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<ul class="redefinitions"> |
689 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<li> |
690 |
<span class="font10bold" style="color: #0000FF">build_groupby_clause ( )</SPAN> |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methoddo_query">ADODBSQLDataListSource::do_query()</a> |
691 |
<BR> |
: This is the function that does the data fetching, and sorting if needed. |
692 |
|
</li> |
693 |
<BR> |
<li> |
694 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query">PEARSQLDataListSource::do_query()</a> |
695 |
<!-- ========== Info from phpDoc block ========= --> |
: This is the function that does the data fetching, and sorting if needed. |
696 |
this builds the groupby clause of the query |
</li> |
697 |
<BR> |
<li> |
698 |
|
<a href="../phpHtmlLib/PGSQLDataListSource.html#methoddo_query">PGSQLDataListSource::do_query()</a> |
699 |
<DL> |
</li> |
700 |
<DT class="font10bold">Function Parameters:</DT> |
</ul> |
701 |
|
</div> |
702 |
|
<a name="methodget_count_column" id="get_count_column"><!-- --></a> |
703 |
<DT class="font10bold">Function Info:</DT> |
<div class="oddrow"> |
704 |
|
|
705 |
</DL> |
<div class="method-header"> |
706 |
|
<span class="method-title">get_count_column</span> (line <span class="line-number">146</span>) |
707 |
</DIV> |
</div> |
708 |
<BR> |
|
709 |
|
<!-- ========== Info from phpDoc block ========= --> |
710 |
<DIV CLASS="function"> |
<p class="short-description">this returns the current count column</p> |
711 |
<A NAME='build_limit_clause'><!-- --></A> |
|
712 |
<SPAN CLASS="font12bold">build_limit_clause</SPAN> |
<div class="method-signature"> |
713 |
<BR> |
<span class="method-result">string</span> |
714 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"> |
715 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
get_count_column |
716 |
<span class="font10bold" style="color: #0000FF">build_limit_clause ( $offset, $limit )</SPAN> |
</span> |
717 |
<BR> |
() |
718 |
Overridden in child class(es) as: <a href="../phpHtmlLib/PEARSQLDataListSource.html#build_limit_clause">PEARSQLDataListSource::build_limit_clause()</a>, <a href="../phpHtmlLib/ADODBSQLDataListSource.html#build_limit_clause">ADODBSQLDataListSource::build_limit_clause()</a><br> |
</div> |
719 |
<BR> |
|
720 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
721 |
<!-- ========== Info from phpDoc block ========= --> |
|
722 |
This function builds the limit |
</div> |
723 |
<BR> |
<a name="methodget_db_tables" id="get_db_tables"><!-- --></a> |
724 |
clause portion of a DB query. |
<div class="evenrow"> |
725 |
This is specific to the particular |
|
726 |
DB implementation. |
<div class="method-header"> |
727 |
<DL> |
<span class="method-title">get_db_tables</span> (line <span class="line-number">109</span>) |
728 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
729 |
|
|
730 |
|
<!-- ========== Info from phpDoc block ========= --> |
731 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">returns the table(s) used in the query</p> |
732 |
|
|
733 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the limit portion of |
<div class="method-signature"> |
734 |
the query.</DD> |
<span class="method-result">string</span> |
735 |
|
<span class="method-name"> |
736 |
</DL> |
get_db_tables |
737 |
|
</span> |
738 |
</DIV> |
() |
739 |
<BR> |
</div> |
740 |
|
|
741 |
<DIV CLASS="function"> |
|
742 |
<A NAME='build_order_clause'><!-- --></A> |
|
743 |
<SPAN CLASS="font12bold">build_order_clause</SPAN> |
</div> |
744 |
<BR> |
<a name="methodget_db_values" id="get_db_values"><!-- --></a> |
745 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="oddrow"> |
746 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
747 |
<span class="font10bold" style="color: #0000FF">build_order_clause ( )</SPAN> |
<div class="method-header"> |
748 |
<BR> |
<span class="method-title">get_db_values</span> (line <span class="line-number">90</span>) |
749 |
|
</div> |
750 |
<BR> |
|
751 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
752 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">This function returns the values we need to search for in the sql query</p> |
753 |
This builds the db query ORDER BY |
|
754 |
clause used to sort the data from the DB. |
<div class="method-signature"> |
755 |
<BR> |
<span class="method-result">string</span> |
756 |
|
<span class="method-name"> |
757 |
<DL> |
get_db_values |
758 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
759 |
|
() |
760 |
|
</div> |
761 |
<DT class="font10bold">Function Info:</DT> |
|
762 |
|
|
763 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the order by clause</DD> |
|
764 |
|
</div> |
765 |
</DL> |
<a name="methodget_default_order_case_sensitive" id="get_default_order_case_sensitive"><!-- --></a> |
766 |
|
<div class="evenrow"> |
767 |
</DIV> |
|
768 |
<BR> |
<div class="method-header"> |
769 |
|
<span class="method-title">get_default_order_case_sensitive</span> (line <span class="line-number">523</span>) |
770 |
<DIV CLASS="function"> |
</div> |
771 |
<A NAME='build_query'><!-- --></A> |
|
772 |
<SPAN CLASS="font12bold">build_query</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
773 |
<BR> |
<p class="short-description">This function is used to get the flag for the ability to sort/order by case sensitive or not.</p> |
774 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
775 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<div class="method-signature"> |
776 |
<span class="font10bold" style="color: #0000FF">build_query ( [$limit_flag = TRUE] )</SPAN> |
<span class="method-result">none</span> |
777 |
<BR> |
<span class="method-name"> |
778 |
|
get_default_order_case_sensitive |
779 |
<BR> |
</span> |
780 |
<SPAN CLASS="font10bold">Description : </SPAN> |
(<span class="var-type">boolean</span> <span class="var-name">0</span>) |
781 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
782 |
build the entire DB query |
|
783 |
<BR> |
<ul class="parameters"> |
784 |
|
<li> |
785 |
<DL> |
<span class="var-type">boolean</span> |
786 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-name">0</span><span class="var-description">: - TRUE = case sensitive by default</span> </li> |
787 |
|
</ul> |
788 |
<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">$limit_flag</SPAN></SPAN> - build the limit clause or not/</DD> |
|
789 |
|
|
790 |
|
</div> |
791 |
<DT class="font10bold">Function Info:</DT> |
<a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a> |
792 |
|
<div class="oddrow"> |
793 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the full query string to the DB.</DD> |
|
794 |
|
<div class="method-header"> |
795 |
</DL> |
<span class="method-title">get_next_data_row</span> (line <span class="line-number">474</span>) |
796 |
|
</div> |
797 |
</DIV> |
|
798 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
799 |
|
<p class="short-description">This function gets the next data row from the query()</p> |
800 |
<DIV CLASS="function"> |
|
801 |
<A NAME='build_search_clause'><!-- --></A> |
<div class="method-signature"> |
802 |
<SPAN CLASS="font12bold">build_search_clause</SPAN> |
<span class="method-result">array()</span> |
803 |
<BR> |
<span class="method-name"> |
804 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
get_next_data_row |
805 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</span> |
806 |
<span class="font10bold" style="color: #0000FF">build_search_clause ( )</SPAN> |
() |
807 |
<BR> |
</div> |
808 |
|
|
809 |
<BR> |
|
810 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<hr class="separator" /> |
811 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="notes">Redefinition of:</div> |
812 |
This method builds the where clause. |
<dl> |
813 |
<BR> |
<dt><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></dt> |
814 |
|
<dd>This function gets the next data row from the query()</dd> |
815 |
<DL> |
</dl> |
816 |
<DT class="font10bold">Function Parameters:</DT> |
|
817 |
|
<hr class="separator" /> |
818 |
|
<div class="notes">Redefined in descendants as:</div> |
819 |
<DT class="font10bold">Function Info:</DT> |
<ul class="redefinitions"> |
820 |
|
<li> |
821 |
</DL> |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodget_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a> |
822 |
|
: This function gets the next data row from the query() |
823 |
</DIV> |
</li> |
824 |
<BR> |
<li> |
825 |
|
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row">PEARSQLDataListSource::get_next_data_row()</a> |
826 |
<DIV CLASS="function"> |
: This function gets the next data row from the query() |
827 |
<A NAME='build_where_clause'><!-- --></A> |
</li> |
828 |
<SPAN CLASS="font12bold">build_where_clause</SPAN> |
<li> |
829 |
<BR> |
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodget_next_data_row">PGSQLDataListSource::get_next_data_row()</a> |
830 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
: This function gets the next data row from the query() |
831 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</li> |
832 |
<span class="font10bold" style="color: #0000FF">build_where_clause ( )</SPAN> |
</ul> |
833 |
<BR> |
</div> |
834 |
|
<a name="methodjoin_clauses" id="join_clauses"><!-- --></a> |
835 |
<BR> |
<div class="evenrow"> |
836 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
837 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
838 |
This builds the where clause for |
<span class="method-title">join_clauses</span> (line <span class="line-number">156</span>) |
839 |
the query |
</div> |
840 |
<BR> |
|
841 |
|
<!-- ========== Info from phpDoc block ========= --> |
842 |
<DL> |
|
843 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-signature"> |
844 |
|
<span class="method-result">void</span> |
845 |
|
<span class="method-name"> |
846 |
<DT class="font10bold">Function Info:</DT> |
join_clauses |
847 |
|
</span> |
848 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the where clause.</DD> |
() |
849 |
|
</div> |
850 |
</DL> |
|
851 |
|
|
852 |
</DIV> |
|
853 |
<BR> |
</div> |
854 |
|
<a name="methodsearch_value_filter" id="search_value_filter"><!-- --></a> |
855 |
<DIV CLASS="function"> |
<div class="oddrow"> |
856 |
<A NAME='count'><!-- --></A> |
|
857 |
<SPAN CLASS="font12bold">count</SPAN> |
<div class="method-header"> |
858 |
<BR> |
<span class="method-title">search_value_filter</span> (line <span class="line-number">250</span>) |
859 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
860 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
|
861 |
<span class="font10bold" style="color: #0000FF">count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
862 |
<BR> |
<p class="short-description">This function does the variable cleaning that is required to use a search value in a sql query</p> |
863 |
Overridden in child class(es) as: <a href="../phpHtmlLib/PEARSQLDataListSource.html#count">PEARSQLDataListSource::count()</a>, <a href="../phpHtmlLib/ADODBSQLDataListSource.html#count">ADODBSQLDataListSource::count()</a><br> |
<ul class="tags"> |
864 |
<BR> |
<li><span class="field">return:</span> - the "cleaned" string</li> |
865 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</ul> |
866 |
<!-- ========== Info from phpDoc block ========= --> |
|
867 |
find the number of rows to be returned |
<div class="method-signature"> |
868 |
from a query from a table and where clause |
<span class="method-result">string</span> |
869 |
<BR> |
<span class="method-name"> |
870 |
|
search_value_filter |
871 |
<DL> |
</span> |
872 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
873 |
|
</div> |
874 |
<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">$table</SPAN></SPAN> - the table to count from</DD> |
|
875 |
|
<ul class="parameters"> |
876 |
<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">$where_clause</SPAN></SPAN> - a where clause</DD> |
<li> |
877 |
|
<span class="var-type">string</span> |
878 |
|
<span class="var-name">$value</span><span class="var-description">: - the origina string from the user</span> </li> |
879 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
880 |
|
|
881 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the # of rows</DD> |
|
882 |
|
</div> |
883 |
</DL> |
<a name="methodsetup_db_options" id="setup_db_options"><!-- --></a> |
884 |
|
<div class="evenrow"> |
885 |
</DIV> |
|
886 |
<BR> |
<div class="method-header"> |
887 |
|
<span class="method-title">setup_db_options</span> (line <span class="line-number">65</span>) |
888 |
<DIV CLASS="function"> |
</div> |
889 |
<A NAME='do_prequery'><!-- --></A> |
|
890 |
<SPAN CLASS="font12bold">do_prequery</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
891 |
<BR> |
<p class="short-description">Set which DB options to use for this list.</p> |
892 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
893 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-signature"> |
894 |
<span class="font10bold" style="color: #0000FF">do_prequery ( )</SPAN> |
<span class="method-result">void</span> |
895 |
<BR> |
<span class="method-name"> |
896 |
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_prequery">DataListSource::do_prequery()</a> |
setup_db_options |
897 |
<BR> |
</span> |
898 |
<SPAN CLASS="font10bold">Description : </SPAN> |
(<span class="var-type">string</span> <span class="var-name">$values</span>, <span class="var-type">string</span> <span class="var-name">$tables</span>, [<span class="var-type">string</span> <span class="var-name">$where_clause</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$groupby_clause</span> = <span class="var-default">''</span>]) |
899 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
900 |
|
|
901 |
<BR> |
<ul class="parameters"> |
902 |
|
<li> |
903 |
<DL> |
<span class="var-type">string</span> |
904 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-name">$values</span><span class="var-description">: - $values - the values you want to select from the db table(s)</span> </li> |
905 |
|
<li> |
906 |
|
<span class="var-type">string</span> |
907 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-name">$tables</span><span class="var-description">: - $tables - The tables you want to select on.</span> </li> |
908 |
|
<li> |
909 |
</DL> |
<span class="var-type">string</span> |
910 |
|
<span class="var-name">$where_clause</span><span class="var-description">: - $where_clause - portion of the where clause. This expects name=value pairs only.</span> </li> |
911 |
</DIV> |
<li> |
912 |
<BR> |
<span class="var-type">string</span> |
913 |
|
<span class="var-name">$groupby_clause</span><span class="var-description">: - $groupby_clause - the groupby portion of the query. same format as where_clause</span> </li> |
914 |
<DIV CLASS="function"> |
</ul> |
915 |
<A NAME='do_query'><!-- --></A> |
|
916 |
<SPAN CLASS="font12bold">do_query</SPAN> |
|
917 |
<BR> |
</div> |
918 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodsetup_order" id="setup_order"><!-- --></a> |
919 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="oddrow"> |
920 |
<span class="font10bold" style="color: #0000FF">do_query ( )</SPAN> |
|
921 |
<BR> |
<div class="method-header"> |
922 |
Overridden in child class(es) as: <a href="../phpHtmlLib/PEARSQLDataListSource.html#do_query">PEARSQLDataListSource::do_query()</a>, <a href="../phpHtmlLib/ADODBSQLDataListSource.html#do_query">ADODBSQLDataListSource::do_query()</a><br><span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#do_query">DataListSource::do_query()</a> |
<span class="method-title">setup_order</span> (line <span class="line-number">316</span>) |
923 |
<BR> |
</div> |
924 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
925 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
926 |
Do the query to the DB and pull in all of |
<p class="short-description">This function builds the orderby clause for the DB query.</p> |
927 |
the records locally. |
|
928 |
<BR> |
<div class="method-signature"> |
929 |
|
<span class="method-result">string.</span> |
930 |
<DL> |
<span class="method-name"> |
931 |
<DT class="font10bold">Function Parameters:</DT> |
setup_order |
932 |
|
</span> |
933 |
|
(<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">boolean</span> <span class="var-name">$icase_sort</span> = <span class="var-default">FALSE</span>]) |
934 |
<DT class="font10bold">Function Info:</DT> |
</div> |
935 |
|
|
936 |
</DL> |
<ul class="parameters"> |
937 |
|
<li> |
938 |
</DIV> |
<span class="var-type">string</span> |
939 |
<BR> |
<span class="var-name">$orderby</span><span class="var-description">: - DB table field to order by</span> </li> |
940 |
|
<li> |
941 |
<DIV CLASS="function"> |
<span class="var-type">string</span> |
942 |
<A NAME='get_count_column'><!-- --></A> |
<span class="var-name">$reverseorder</span><span class="var-description">: - order assension value.</span> </li> |
943 |
<SPAN CLASS="font12bold">get_count_column</SPAN> |
<li> |
944 |
<BR> |
<span class="var-type">boolean</span> |
945 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-name">$icase_sort</span><span class="var-description">: - case insensitive sort?</span> </li> |
946 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
</ul> |
947 |
<span class="font10bold" style="color: #0000FF">get_count_column ( )</SPAN> |
|
948 |
<BR> |
|
949 |
|
</div> |
950 |
<BR> |
<a name="methodset_count_column" id="set_count_column"><!-- --></a> |
951 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="evenrow"> |
952 |
<!-- ========== Info from phpDoc block ========= --> |
|
953 |
this returns the current count column |
<div class="method-header"> |
954 |
<BR> |
<span class="method-title">set_count_column</span> (line <span class="line-number">137</span>) |
955 |
|
</div> |
956 |
<DL> |
|
957 |
<DT class="font10bold">Function Parameters:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
958 |
|
<p class="short-description">This function changes the counted column.</p> |
959 |
|
<p class="description"><p>By default, we use count(1) But sometime you need count(distinct KEY) for example</p></p> |
960 |
<DT class="font10bold">Function Info:</DT> |
|
961 |
|
<div class="method-signature"> |
962 |
</DL> |
<span class="method-result">void</span> |
963 |
|
<span class="method-name"> |
964 |
</DIV> |
set_count_column |
965 |
<BR> |
</span> |
966 |
|
(<span class="var-type">mixed</span> <span class="var-name">$var</span>) |
967 |
<DIV CLASS="function"> |
</div> |
968 |
<A NAME='get_count_column'><!-- --></A> |
|
969 |
<SPAN CLASS="font12bold">get_count_column</SPAN> |
|
970 |
<BR> |
|
971 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
972 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodset_db_groupby_clause" id="set_db_groupby_clause"><!-- --></a> |
973 |
<span class="font10bold" style="color: #0000FF">get_count_column ( )</SPAN> |
<div class="oddrow"> |
974 |
<BR> |
|
975 |
|
<div class="method-header"> |
976 |
<BR> |
<span class="method-title">set_db_groupby_clause</span> (line <span class="line-number">127</span>) |
977 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
978 |
<!-- ========== Info from phpDoc block ========= --> |
|
979 |
this gets the count column |
<!-- ========== Info from phpDoc block ========= --> |
980 |
<BR> |
<p class="short-description">Sets the groupby clause for the query</p> |
981 |
|
|
982 |
<DL> |
<div class="method-signature"> |
983 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">void</span> |
984 |
|
<span class="method-name"> |
985 |
|
set_db_groupby_clause |
986 |
<DT class="font10bold">Function Info:</DT> |
</span> |
987 |
|
(<span class="var-type">string</span> <span class="var-name">$clause</span>) |
988 |
</DL> |
</div> |
989 |
|
|
990 |
</DIV> |
<ul class="parameters"> |
991 |
<BR> |
<li> |
992 |
|
<span class="var-type">string</span> |
993 |
<DIV CLASS="function"> |
<span class="var-name">$clause</span><span class="var-description">: name value pairs</span> </li> |
994 |
<A NAME='get_db_tables'><!-- --></A> |
</ul> |
995 |
<SPAN CLASS="font12bold">get_db_tables</SPAN> |
|
996 |
<BR> |
|
997 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
998 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodset_db_tables" id="set_db_tables"><!-- --></a> |
999 |
<span class="font10bold" style="color: #0000FF">get_db_tables ( )</SPAN> |
<div class="evenrow"> |
1000 |
<BR> |
|
1001 |
|
<div class="method-header"> |
1002 |
<BR> |
<span class="method-title">set_db_tables</span> (line <span class="line-number">100</span>) |
1003 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1004 |
<!-- ========== Info from phpDoc block ========= --> |
|
1005 |
returns the table(s) used in the query |
<!-- ========== Info from phpDoc block ========= --> |
1006 |
<BR> |
<p class="short-description">Set the tables from the DB you want to select on.</p> |
1007 |
|
|
1008 |
<DL> |
<div class="method-signature"> |
1009 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">void</span> |
1010 |
|
<span class="method-name"> |
1011 |
|
set_db_tables |
1012 |
<DT class="font10bold">Function Info:</DT> |
</span> |
1013 |
|
(<span class="var-type">string</span> <span class="var-name">$tables</span>) |
1014 |
</DL> |
</div> |
1015 |
|
|
1016 |
</DIV> |
<ul class="parameters"> |
1017 |
<BR> |
<li> |
1018 |
|
<span class="var-type">string</span> |
1019 |
<DIV CLASS="function"> |
<span class="var-name">$tables</span><span class="var-description">: - $tables</span> </li> |
1020 |
<A NAME='get_db_values'><!-- --></A> |
</ul> |
1021 |
<SPAN CLASS="font12bold">get_db_values</SPAN> |
|
1022 |
<BR> |
|
1023 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
1024 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<a name="methodset_db_values" id="set_db_values"><!-- --></a> |
1025 |
<span class="font10bold" style="color: #0000FF">get_db_values ( )</SPAN> |
<div class="oddrow"> |
1026 |
<BR> |
|
1027 |
|
<div class="method-header"> |
1028 |
<BR> |
<span class="method-title">set_db_values</span> (line <span class="line-number">79</span>) |
1029 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
1030 |
<!-- ========== Info from phpDoc block ========= --> |
|
1031 |
This function returns the |
<!-- ========== Info from phpDoc block ========= --> |
1032 |
<BR> |
<p class="short-description">Set the values we want to select from the db.</p> |
1033 |
values we need to search for |
|
1034 |
in the sql query |
<div class="method-signature"> |
1035 |
<DL> |
<span class="method-result">void</span> |
1036 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-name"> |
1037 |
|
set_db_values |
1038 |
|
</span> |
1039 |
<DT class="font10bold">Function Info:</DT> |
(<span class="var-type">string</span> <span class="var-name">$values</span>) |
1040 |
|
</div> |
1041 |
</DL> |
|
1042 |
|
<ul class="parameters"> |
1043 |
</DIV> |
<li> |
1044 |
<BR> |
<span class="var-type">string</span> |
1045 |
|
<span class="var-name">$values</span><span class="var-description">: - $values</span> </li> |
1046 |
<DIV CLASS="function"> |
</ul> |
1047 |
<A NAME='get_next_data_row'><!-- --></A> |
|
1048 |
<SPAN CLASS="font12bold">get_next_data_row</SPAN> |
|
1049 |
<BR> |
</div> |
1050 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<a name="methodset_db_where_clause" id="set_db_where_clause"><!-- --></a> |
1051 |
<span class="font10bold" style="color: #FF0000">array()</SPAN> |
<div class="evenrow"> |
1052 |
<span class="font10bold" style="color: #0000FF">get_next_data_row ( )</SPAN> |
|
1053 |
<BR> |
<div class="method-header"> |
1054 |
Overridden in child class(es) as: <a href="../phpHtmlLib/PEARSQLDataListSource.html#get_next_data_row">PEARSQLDataListSource::get_next_data_row()</a>, <a href="../phpHtmlLib/ADODBSQLDataListSource.html#get_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a><br><span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataListSource.html#get_next_data_row">DataListSource::get_next_data_row()</a> |
<span class="method-title">set_db_where_clause</span> (line <span class="line-number">118</span>) |
1055 |
<BR> |
</div> |
1056 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1057 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
1058 |
This function gets the next data row |
<p class="short-description">Set the user portion of the where clause.</p> |
1059 |
from the query() |
|
1060 |
<BR> |
<div class="method-signature"> |
1061 |
|
<span class="method-result">void</span> |
1062 |
<DL> |
<span class="method-name"> |
1063 |
<DT class="font10bold">Function Parameters:</DT> |
set_db_where_clause |
1064 |
|
</span> |
1065 |
|
(<span class="var-type">string</span> <span class="var-name">$where_clause</span>) |
1066 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1067 |
|
|
1068 |
</DL> |
<ul class="parameters"> |
1069 |
|
<li> |
1070 |
</DIV> |
<span class="var-type">string</span> |
1071 |
<BR> |
<span class="var-name">$where_clause</span><span class="var-description">: - name value pairs</span> </li> |
1072 |
|
</ul> |
1073 |
<DIV CLASS="function"> |
|
1074 |
<A NAME='join_clauses'><!-- --></A> |
|
1075 |
<SPAN CLASS="font12bold">join_clauses</SPAN> |
</div> |
1076 |
<BR> |
<a name="methodset_default_order_case_sensitive" id="set_default_order_case_sensitive"><!-- --></a> |
1077 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="oddrow"> |
1078 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
1079 |
<span class="font10bold" style="color: #0000FF">join_clauses ( )</SPAN> |
<div class="method-header"> |
1080 |
<BR> |
<span class="method-title">set_default_order_case_sensitive</span> (line <span class="line-number">512</span>) |
1081 |
|
</div> |
1082 |
<BR> |
|
1083 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
1084 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">This function is used to set the flag for the ability to sort/order by case sensitive or not.</p> |
1085 |
|
|
1086 |
<BR> |
<div class="method-signature"> |
1087 |
|
<span class="method-result">none</span> |
1088 |
<DL> |
<span class="method-name"> |
1089 |
<DT class="font10bold">Function Parameters:</DT> |
set_default_order_case_sensitive |
1090 |
|
</span> |
1091 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1092 |
<DT class="font10bold">Function Info:</DT> |
</div> |
1093 |
|
|
1094 |
</DL> |
<ul class="parameters"> |
1095 |
|
<li> |
1096 |
</DIV> |
<span class="var-type">boolean</span> |
1097 |
<BR> |
<span class="var-name">$flag</span><span class="var-description">: - TRUE = case sensitive by default</span> </li> |
1098 |
|
</ul> |
1099 |
<DIV CLASS="function"> |
|
1100 |
<A NAME='search_value_filter'><!-- --></A> |
|
1101 |
<SPAN CLASS="font12bold">search_value_filter</SPAN> |
</div> |
1102 |
<BR> |
<a name="methodsimple_search_where_clause" id="simple_search_where_clause"><!-- --></a> |
1103 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<div class="evenrow"> |
1104 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
1105 |
<span class="font10bold" style="color: #0000FF">search_value_filter ( $value )</SPAN> |
<div class="method-header"> |
1106 |
<BR> |
<span class="method-title">simple_search_where_clause</span> (line <span class="line-number">190</span>) |
1107 |
|
</div> |
1108 |
<BR> |
|
1109 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
1110 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">this builds the search clause</p> |
1111 |
This function does the variable cleaning |
|
1112 |
<BR> |
<div class="method-signature"> |
1113 |
that is required to use a search value |
<span class="method-result">string</span> |
1114 |
in a sql query |
<span class="method-name"> |
1115 |
<DL> |
simple_search_where_clause |
1116 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
1117 |
|
() |
1118 |
<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">$value</SPAN></SPAN> - the origina string from the user</DD> |
</div> |
1119 |
|
|
1120 |
|
|
1121 |
<DT class="font10bold">Function Info:</DT> |
|
1122 |
|
</div> |
1123 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the "cleaned" string</DD> |
<a name="methodsql_varchar_filter" id="sql_varchar_filter"><!-- --></a> |
1124 |
|
<div class="oddrow"> |
1125 |
</DL> |
|
1126 |
|
<div class="method-header"> |
1127 |
</DIV> |
<span class="method-title">sql_varchar_filter</span> (line <span class="line-number">263</span>) |
1128 |
<BR> |
</div> |
1129 |
|
|
1130 |
<DIV CLASS="function"> |
<!-- ========== Info from phpDoc block ========= --> |
1131 |
<A NAME='setup_db_options'><!-- --></A> |
<p class="short-description">Clean up the string so it can work in a db</p> |
1132 |
<SPAN CLASS="font12bold">setup_db_options</SPAN> |
|
1133 |
<BR> |
<div class="method-signature"> |
1134 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-result">string</span> |
1135 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="method-name"> |
1136 |
<span class="font10bold" style="color: #0000FF">setup_db_options ( $values, $tables, [$where_clause = ''], [$groupby_clause = ''] )</SPAN> |
sql_varchar_filter |
1137 |
<BR> |
</span> |
1138 |
|
(<span class="var-type">string</span> <span class="var-name">$value</span>) |
1139 |
<BR> |
</div> |
1140 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
1141 |
<!-- ========== Info from phpDoc block ========= --> |
<ul class="parameters"> |
1142 |
Set which DB options |
<li> |
1143 |
to use for this list. |
<span class="var-type">string</span> |
1144 |
<BR> |
<span class="var-name">$value</span> </li> |
1145 |
|
</ul> |
1146 |
<DL> |
|
1147 |
<DT class="font10bold">Function Parameters:</DT> |
|
1148 |
|
</div> |
1149 |
<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">$values</SPAN></SPAN> - - the values you |
<h4>Inherited Methods</h4> |
1150 |
want to select |
<a name='inherited_methods'><!-- --></a> |
1151 |
from the db table(s)</DD> |
<!-- =========== Summary =========== --> |
1152 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p> |
1153 |
<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">$tables</SPAN></SPAN> - - The tables you want |
<blockquote> |
1154 |
to select on.</DD> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br> |
1155 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br> |
1156 |
<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">$where_clause</SPAN></SPAN> - - portion of the where |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br> |
1157 |
clause. |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br> |
1158 |
This expects name=value |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br> |
1159 |
pairs only.</DD> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br> |
1160 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br> |
1161 |
<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">$groupby_clause</SPAN></SPAN> - - the groupby portion of the |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br> |
1162 |
query. same format as where_clause</DD> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br> |
1163 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br> |
1164 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br> |
1165 |
<DT class="font10bold">Function Info:</DT> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br> |
1166 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br> |
1167 |
</DL> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br> |
1168 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_secondary_orderby">DataListSource::get_secondary_orderby()</a></span><br> |
1169 |
</DIV> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br> |
1170 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br> |
1171 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br> |
1172 |
<DIV CLASS="function"> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br> |
1173 |
<A NAME='setup_order'><!-- --></A> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br> |
1174 |
<SPAN CLASS="font12bold">setup_order</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br> |
1175 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br> |
1176 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br> |
1177 |
<span class="font10bold" style="color: #FF0000">string.</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br> |
1178 |
<span class="font10bold" style="color: #0000FF">setup_order ( $orderby, $reverseorder )</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br> |
1179 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br> |
1180 |
|
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br> |
1181 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_secondary_orderby">DataListSource::set_secondary_orderby()</a></span><br> |
1182 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br> |
1183 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br> |
1184 |
This function builds the orderby clause |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br> |
1185 |
for the DB query. |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br> |
1186 |
<BR> |
</blockquote> |
1187 |
|
|
1188 |
<DL> |
</div> |
1189 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
1190 |
|
|
1191 |
<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> - DB table field to order by</DD> |
|
1192 |
|
<p class="notes" id="credit"> |
1193 |
<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 assension value.</DD> |
Documentation generated on Thu, 1 Apr 2004 09:39:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
1194 |
|
</p> |
1195 |
|
</div></body> |
1196 |
<DT class="font10bold">Function Info:</DT> |
</html> |
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_count_column'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_count_column</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_count_column ( $var )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function changes the counted column. |
|
|
<BR> |
|
|
By default, we use count(1) |
|
|
But sometime you need count(distinct KEY) for example |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_db_groupby_clause'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_db_groupby_clause</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_db_groupby_clause ( $clause )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Sets the groupby clause for the query |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$clause</SPAN></SPAN> name value pairs</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_db_tables'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_db_tables</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_db_tables ( $tables )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Set the tables from the DB you |
|
|
want to select on. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$tables</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_db_values'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_db_values</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_db_values ( $values )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Set the values we want to select |
|
|
from the db. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$values</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_db_where_clause'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_db_where_clause</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_db_where_clause ( $where_clause )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Set the user portion of the where |
|
|
clause. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$where_clause</SPAN></SPAN> - name value pairs</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='simple_search_where_clause'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">simple_search_where_clause</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">simple_search_where_clause ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
this builds the search clause |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='sql_varchar_filter'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">sql_varchar_filter</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">sql_varchar_filter ( $value )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Clean up the string so it can work in a db |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> </DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
|
|
|
<hr> |
|
|
</HTML> |
|