/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ArrayDataListSource.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ArrayDataListSource.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations)
Wed Sep 24 13:11:45 2003 UTC (21 years ago) by jonen
Branch: MAIN
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

1 <?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 ArrayDataListSource</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 ArrayDataListSource</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
22 </div>
23 <div class="info-box-body">
24 <!-- ========== Info from phpDoc block ========= -->
25 <p class="short-description">This DataListSource child class gets the data from an external array</p>
26 <p class="description"><p>The array is a 2D array and each sub-array is a set of elements for each row in the list</p></p>
27 <ul class="tags">
28 <li><span class="field">author:</span> <p>Suren Markossian &lt;<a href="mailto:suren_markossian@yahoo.com">mailto:suren_markossian@yahoo.com</a>&gt;</p></li>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_widgets_data_list_ArrayDataListSource_inc.html">Program_Root/widgets/data_list/ArrayDataListSource.inc</a> (line <span class="field">26</span>)
32 </p>
33
34
35 <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
36 |
37 --ArrayDataListSource</pre>
38
39 </div>
40 </div>
41
42
43 <a name="sec-var-summary"></a>
44 <div class="info-box">
45 <div class="info-box-title">Variable Summary</span></div>
46 <div class="nav-bar">
47 <a href="#sec-description">Description</a> |
48 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
49 |
50 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
51
52 </div>
53 <div class="info-box-body">
54 <div class="var-summary">
55 <div class="var-title">
56 <span class="var-type">mixed</span>
57 <a href="#$_prequery_filter_flag" title="details" class="var-name">$_prequery_filter_flag</a>
58 </div>
59 </div>
60 </div>
61 </div>
62
63 <a name="sec-method-summary"></a>
64 <div class="info-box">
65 <div class="info-box-title">Method Summary</span></div>
66 <div class="nav-bar">
67 <a href="#sec-description">Description</a> |
68 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
69
70 |
71 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
72 </div>
73 <div class="info-box-body">
74 <div class="method-summary">
75
76 <div class="method-definition">
77 <span class="method-result">void</span>
78 <a href="#ArrayDataListSource" title="details" class="method-name">ArrayDataListSource</a>
79 (<span class="var-type">array</span>&nbsp;<span class="var-name">&$data</span>)
80 </div>
81
82 <div class="method-definition">
83 <span class="method-result">void</span>
84 <a href="#cmp" title="details" class="method-name">cmp</a>
85 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data1</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$data2</span>)
86 </div>
87
88 <div class="method-definition">
89 <span class="method-result">void</span>
90 <a href="#do_prequery" title="details" class="method-name">do_prequery</a>
91 ()
92 </div>
93
94 <div class="method-definition">
95 <span class="method-result">void</span>
96 <a href="#do_query" title="details" class="method-name">do_query</a>
97 ()
98 </div>
99
100 <div class="method-definition">
101 <span class="method-result">int</span>
102 <a href="#get_data_index" title="details" class="method-name">get_data_index</a>
103 ()
104 </div>
105
106 <div class="method-definition">
107 <span class="method-result">void</span>
108 <a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a>
109 ()
110 </div>
111
112 <div class="method-definition">
113 <span class="method-result">boolean</span>
114 <a href="#prequery_row_filter" title="details" class="method-name">prequery_row_filter</a>
115 (<span class="var-type">array</span>&nbsp;<span class="var-name">&$row_data</span>)
116 </div>
117
118 <div class="method-definition">
119 <span class="method-result">void</span>
120 <a href="#set_prequery_filter_flag" title="details" class="method-name">set_prequery_filter_flag</a>
121 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
122 </div>
123
124 <div class="method-definition">
125 <span class="method-result">void</span>
126 <a href="#sort" title="details" class="method-name">sort</a>
127 ()
128 </div>
129
130 <div class="method-definition">
131 <span class="method-result">void</span>
132 <a href="#_prequery_filter" title="details" class="method-name">_prequery_filter</a>
133 ()
134 </div>
135 </div>
136 </div>
137 </div>
138
139 <a name="sec-vars"></a>
140 <div class="info-box">
141 <div class="info-box-title">Variables</div>
142 <div class="nav-bar">
143 <a href="#sec-description">Description</a> |
144 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
145
146
147 |
148 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
149
150 </div>
151 <div class="info-box-body">
152 <a name="var$_prequery_filter_flag" id="$_prequery_filter_flag"><!-- --></A>
153 <div class="oddrow">
154
155 <div class="var-header">
156 <span class="var-title">
157 <span class="var-type">mixed</span>
158 <span class="var-name">$_prequery_filter_flag</span>
159 = <span class="var-default"> FALSE</span> (line <span class="line-number">33</span>)
160 </span>
161 </div>
162
163 <!-- ========== Info from phpDoc block ========= -->
164 <p class="short-description">If true the prequery filter will be</p>
165 <p class="description"><p>run on the data array</p></p>
166
167
168
169
170
171 </div>
172 <h4>Inherited Variables</h4>
173 <A NAME='inherited_vars'><!-- --></A>
174 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
175 <blockquote>
176 <span class="var-title">
177 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br>
178 </span>
179 <span class="var-title">
180 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br>
181 </span>
182 <span class="var-title">
183 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br>
184 </span>
185 <span class="var-title">
186 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br>
187 </span>
188 <span class="var-title">
189 <span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br>
190 </span>
191 </blockquote>
192
193 </div>
194 </div>
195
196 <a name="sec-methods"></a>
197 <div class="info-box">
198 <div class="info-box-title">Methods</div>
199 <div class="nav-bar">
200 <a href="#sec-description">Description</a> |
201 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
202 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
203
204 </div>
205 <div class="info-box-body">
206 <A NAME='method_detail'></A>
207 <a name="methodArrayDataListSource" id="ArrayDataListSource"><!-- --></a>
208 <div class="evenrow">
209
210 <div class="method-header">
211 <span class="method-title">Constructor ArrayDataListSource</span> (line <span class="line-number">40</span>)
212 </div>
213
214 <!-- ========== Info from phpDoc block ========= -->
215 <p class="short-description">The constructor.</p>
216
217 <div class="method-signature">
218 <span class="method-result">void</span>
219 <span class="method-name">
220 ArrayDataListSource
221 </span>
222 (<span class="var-type">array</span>&nbsp;<span class="var-name">&$data</span>)
223 </div>
224
225 <ul class="parameters">
226 <li>
227 <span class="var-type">array</span>
228 <span class="var-name">&$data</span><span class="var-description">: <p>data - an array of array elements for each row</p></span> </li>
229 </ul>
230
231
232 </div>
233 <a name="methodcmp" id="cmp"><!-- --></a>
234 <div class="oddrow">
235
236 <div class="method-header">
237 <span class="method-title">cmp</span> (line <span class="line-number">169</span>)
238 </div>
239
240 <!-- ========== Info from phpDoc block ========= -->
241
242 <div class="method-signature">
243 <span class="method-result">void</span>
244 <span class="method-name">
245 cmp
246 </span>
247 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data1</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$data2</span>)
248 </div>
249
250
251
252 </div>
253 <a name="methoddo_prequery" id="do_prequery"><!-- --></a>
254 <div class="evenrow">
255
256 <div class="method-header">
257 <span class="method-title">do_prequery</span> (line <span class="line-number">72</span>)
258 </div>
259
260 <!-- ========== Info from phpDoc block ========= -->
261 <p class="short-description">This is a method that should be defined by the child class to do any pre-query type of things.</p>
262 <p class="description"><p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p></p>
263
264 <div class="method-signature">
265 <span class="method-result">void</span>
266 <span class="method-name">
267 do_prequery
268 </span>
269 ()
270 </div>
271
272
273 <hr class="separator" />
274 <div class="notes">Redefinition of:</div>
275 <dl>
276 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></dt>
277 <dd>This is a method that should be defined by the child class to do any pre-query type of things.</dd>
278 </dl>
279
280 </div>
281 <a name="methoddo_query" id="do_query"><!-- --></a>
282 <div class="oddrow">
283
284 <div class="method-header">
285 <span class="method-title">do_query</span> (line <span class="line-number">48</span>)
286 </div>
287
288 <!-- ========== Info from phpDoc block ========= -->
289 <p class="short-description">This function does the query</p>
290 <p class="description"><p>and search/sort</p></p>
291
292 <div class="method-signature">
293 <span class="method-result">void</span>
294 <span class="method-name">
295 do_query
296 </span>
297 ()
298 </div>
299
300
301 <hr class="separator" />
302 <div class="notes">Redefinition of:</div>
303 <dl>
304 <dt><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></dt>
305 <dd>This is the function that does the data fetching, and sorting if needed.</dd>
306 </dl>
307
308 </div>
309 <a name="methodget_data_index" id="get_data_index"><!-- --></a>
310 <div class="evenrow">
311
312 <div class="method-header">
313 <span class="method-title">get_data_index</span> (line <span class="line-number">153</span>)
314 </div>
315
316 <!-- ========== Info from phpDoc block ========= -->
317 <p class="short-description">This function returns the data_index value and increments it</p>
318
319 <div class="method-signature">
320 <span class="method-result">int</span>
321 <span class="method-name">
322 get_data_index
323 </span>
324 ()
325 </div>
326
327
328 <hr class="separator" />
329 <div class="notes">Redefinition of:</div>
330 <dl>
331 <dt><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></dt>
332 <dd>This function returns the data_index value and increments it</dd>
333 </dl>
334
335 </div>
336 <a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a>
337 <div class="oddrow">
338
339 <div class="method-header">
340 <span class="method-title">get_next_data_row</span> (line <span class="line-number">81</span>)
341 </div>
342
343 <!-- ========== Info from phpDoc block ========= -->
344 <p class="short-description">This function returns the next row of valid data.</p>
345
346 <div class="method-signature">
347 <span class="method-result">void</span>
348 <span class="method-name">
349 get_next_data_row
350 </span>
351 ()
352 </div>
353
354
355 <hr class="separator" />
356 <div class="notes">Redefinition of:</div>
357 <dl>
358 <dt><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></dt>
359 <dd>This function gets the next data row from the query()</dd>
360 </dl>
361
362 </div>
363 <a name="methodprequery_row_filter" id="prequery_row_filter"><!-- --></a>
364 <div class="evenrow">
365
366 <div class="method-header">
367 <span class="method-title">prequery_row_filter</span> (line <span class="line-number">111</span>)
368 </div>
369
370 <!-- ========== Info from phpDoc block ========= -->
371 <p class="short-description">This is used to perform pre-query filtering Gives us a chance to run the next row through a filter before any processing has been done</p>
372 <ul class="tags">
373 <li><span class="field">return:</span> <p>- TRUE = allow the row. FALSE = drop it.</p></li>
374 </ul>
375
376 <div class="method-signature">
377 <span class="method-result">boolean</span>
378 <span class="method-name">
379 prequery_row_filter
380 </span>
381 (<span class="var-type">array</span>&nbsp;<span class="var-name">&$row_data</span>)
382 </div>
383
384 <ul class="parameters">
385 <li>
386 <span class="var-type">array</span>
387 <span class="var-name">&$row_data</span><span class="var-description">: <p>- the row to run through the filter</p></span> </li>
388 </ul>
389
390
391 </div>
392 <a name="methodset_prequery_filter_flag" id="set_prequery_filter_flag"><!-- --></a>
393 <div class="oddrow">
394
395 <div class="method-header">
396 <span class="method-title">set_prequery_filter_flag</span> (line <span class="line-number">142</span>)
397 </div>
398
399 <!-- ========== Info from phpDoc block ========= -->
400 <p class="short-description">Sets the pre-query filter flag If true, a filter will be run on the data array before any processing is done</p>
401
402 <div class="method-signature">
403 <span class="method-result">void</span>
404 <span class="method-name">
405 set_prequery_filter_flag
406 </span>
407 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
408 </div>
409
410 <ul class="parameters">
411 <li>
412 <span class="var-type">bool</span>
413 <span class="var-name">$flag</span><span class="var-description">: <p>flag</p></span> </li>
414 </ul>
415
416
417 </div>
418 <a name="methodsort" id="sort"><!-- --></a>
419 <div class="evenrow">
420
421 <div class="method-header">
422 <span class="method-title">sort</span> (line <span class="line-number">159</span>)
423 </div>
424
425 <!-- ========== Info from phpDoc block ========= -->
426
427 <div class="method-signature">
428 <span class="method-result">void</span>
429 <span class="method-name">
430 sort
431 </span>
432 ()
433 </div>
434
435
436 <hr class="separator" />
437 <div class="notes">Redefinition of:</div>
438 <dl>
439 <dt><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></dt>
440 <dd>A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database.</dd>
441 </dl>
442
443 </div>
444 <a name="method_prequery_filter" id="_prequery_filter"><!-- --></a>
445 <div class="oddrow">
446
447 <div class="method-header">
448 <span class="method-title">_prequery_filter</span> (line <span class="line-number">123</span>)
449 </div>
450
451 <!-- ========== Info from phpDoc block ========= -->
452 <p class="short-description">This is called to allow rebuilding the data array to remove elements that have to be filtered</p>
453 <p class="description"><p>This is done on pre-processing phase and used for simple and advanced searches</p></p>
454
455 <div class="method-signature">
456 <span class="method-result">void</span>
457 <span class="method-name">
458 _prequery_filter
459 </span>
460 ()
461 </div>
462
463
464
465 </div>
466 <h4>Inherited Methods</h4>
467 <a name='inherited_methods'><!-- --></a>
468 <!-- =========== Summary =========== -->
469 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p>
470 <blockquote>
471 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br>
472 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br>
473 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br>
474 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br>
475 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br>
476 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br>
477 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br>
478 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br>
479 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br>
480 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br>
481 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br>
482 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br>
483 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br>
484 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br>
485 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br>
486 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br>
487 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br>
488 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br>
489 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br>
490 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br>
491 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br>
492 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br>
493 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br>
494 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br>
495 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br>
496 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br>
497 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br>
498 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br>
499 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br>
500 <span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br>
501 </blockquote>
502
503 </div>
504 </div>
505
506 <p class="notes" id="credit">
507 Documention generated on Thu, 31 Jul 2003 18:32:18 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
508 </p>
509 </div></body>
510 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed