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