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