| 1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
| 2 |
<!--NewPage--> |
| 3 |
<HTML> |
| 4 |
<HEAD> |
| 5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> |
| 6 |
<TITLE>Docs for page DataList.inc</TITLE> |
| 7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
| 8 |
</HEAD> |
| 9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
| 10 |
|
| 11 |
|
| 12 |
<!-- Links --> |
| 13 |
<a NAME="top"></A> |
| 14 |
<table WIDTH="100%" class="links"> |
| 15 |
<TR> |
| 16 |
<TD class="font10"> |
| 17 |
Links: |
| 18 |
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
| 19 |
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
| 20 |
<A HREF="#globals_summary" class="links" title="Global Variable Summary">Globals</A> |
| 21 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
| 22 |
<A HREF="#functions_summary" class="links" title="Function Summary">Functions</A> |
| 23 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
| 24 |
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
| 25 |
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
| 26 |
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
| 27 |
</TD> |
| 28 |
</TR> |
| 29 |
</TABLE> |
| 30 |
<BR> |
| 31 |
|
| 32 |
<h2>File: Program_Root/widgets/data_list/DataList.inc</h2> |
| 33 |
<!-- ========== Info from phpDoc block ========= --> |
| 34 |
|
| 35 |
<BR> |
| 36 |
|
| 37 |
|
| 38 |
<UL> |
| 39 |
|
| 40 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
| 41 |
|
| 42 |
</UL> |
| 43 |
|
| 44 |
<br> |
| 45 |
<!-- =========== Used Classes =========== --> |
| 46 |
<A NAME='classes_summary'><!-- --></A> |
| 47 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 48 |
<TR CLASS='TableHeadingColor'> |
| 49 |
<TD> |
| 50 |
<span class="font12bold">Classes defined in this file</span> |
| 51 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 52 |
</TD> |
| 53 |
</TR> |
| 54 |
</TABLE> |
| 55 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 56 |
<THEAD> |
| 57 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
| 58 |
</THEAD> |
| 59 |
<TBODY> |
| 60 |
|
| 61 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 62 |
<TD><a href="../phpHtmlLib/DataList.html">DataList</a></TD> |
| 63 |
<TD>used to build a widget that shows lists of |
| 64 |
data from any source via the DataListSource |
| 65 |
object. It fetches/builds/gets its data |
| 66 |
from the DataListSource object, which can |
| 67 |
be written to support any data source |
| 68 |
(MySQL, Oracle, comma delimited file, xml, etc.) |
| 69 |
|
| 70 |
This base class MUST be extended by a child to |
| 71 |
actually render the list. The job of the DataList |
| 72 |
class is to provide the basic API and abstraction |
| 73 |
mechanism to handling searching, showing, sorting |
| 74 |
lists of data. |
| 75 |
|
| 76 |
Each column of data is associated with a title and a |
| 77 |
name. The title is what is shown to the user for that |
| 78 |
column. The name is the mapping between the column and |
| 79 |
the DataListSource. Each column can be marked |
| 80 |
as sortable and searchable. If a column is sortable, |
| 81 |
the title is a link that can be clicked on to sort. |
| 82 |
The sorting is done in the DataListSource object ( |
| 83 |
via the sql query, or sort() functions depending on the |
| 84 |
data source itself) |
| 85 |
|
| 86 |
The DataList object will build the title, the search block |
| 87 |
(if any), the datalist controls (the links/imges for |
| 88 |
first, prev, next, last, all). Then the data columns/labels. |
| 89 |
Then it will fetch each of the rows of data to display |
| 90 |
from the DataListSource. |
| 91 |
|
| 92 |
The logic of the output calls follows in the order: |
| 93 |
|
| 94 |
title |
| 95 |
search table/block |
| 96 |
datalist controls (first, prev, next, last, all) |
| 97 |
data columns/labels |
| 98 |
data rows x through y |
| 99 |
|
| 100 |
|
| 101 |
REQUIREMENTS: |
| 102 |
You must use/define a DataListSource object. |
| 103 |
You MUST override/extend the following methods: |
| 104 |
|
| 105 |
* get_data_source() - used to set the DataListSource |
| 106 |
by this class. |
| 107 |
* user_setup() - used to set the columns to show and any |
| 108 |
options used by the DataList class and |
| 109 |
DataListSource object. |
| 110 |
|
| 111 |
|
| 112 |
UI ABSTRACTION METHODS |
| 113 |
These methods allow for some level of abstraction for |
| 114 |
the layout/look/feel of the actual list of data. |
| 115 |
|
| 116 |
|
| 117 |
* gui_init() - the function gives the child class a chance |
| 118 |
to do any building of the objects that will |
| 119 |
hold the search area, column headers and the |
| 120 |
rows of data. |
| 121 |
|
| 122 |
* child_build_column_header() - This method is responsible |
| 123 |
for building and inserting |
| 124 |
the column header title into |
| 125 |
the UI object. |
| 126 |
|
| 127 |
* child_add_row_cell() - This function is responsible for adding |
| 128 |
the cell in the current row. The method |
| 129 |
is responsible for keeping track of the |
| 130 |
location in its UI object for the current |
| 131 |
row. |
| 132 |
|
| 133 |
* child_get_gui() - This method returns the entire UI in 1 object |
| 134 |
or container. At this point the entire UI |
| 135 |
has been constructed, the entire list of data |
| 136 |
has been walked and inserted.</TD> |
| 137 |
</TR> |
| 138 |
|
| 139 |
</TBODY> |
| 140 |
</TABLE> |
| 141 |
<br> |
| 142 |
<br> |
| 143 |
<!-- =========== Includes SUMMARY =========== --> |
| 144 |
<A NAME='includes_summary'><!-- --></A> |
| 145 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 146 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 147 |
<TD> |
| 148 |
<span CLASS="font12bold">Include Statements Summary</span> |
| 149 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 150 |
</TD> |
| 151 |
</TR> |
| 152 |
</TABLE> |
| 153 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 154 |
<THEAD> |
| 155 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
| 156 |
</THEAD> |
| 157 |
<TBODY> |
| 158 |
|
| 159 |
</TBODY> |
| 160 |
</TABLE> |
| 161 |
<br> |
| 162 |
|
| 163 |
<br> |
| 164 |
<!-- =========== CONSTANT SUMMARY =========== --> |
| 165 |
<A NAME='global_summary'><!-- --></A> |
| 166 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 167 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 168 |
<TD> |
| 169 |
<FONT SIZE='+2'><B>Global Variable Summary</B></FONT> |
| 170 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 171 |
</TD> |
| 172 |
</TR> |
| 173 |
</TABLE> |
| 174 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 175 |
<THEAD> |
| 176 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
| 177 |
</THEAD> |
| 178 |
<TBODY> |
| 179 |
|
| 180 |
</TBODY> |
| 181 |
</TABLE> |
| 182 |
<br> |
| 183 |
|
| 184 |
|
| 185 |
<br> |
| 186 |
<!-- =========== CONSTANT SUMMARY =========== --> |
| 187 |
<A NAME='constant_summary'><!-- --></A> |
| 188 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 189 |
<TR CLASS='TableHeadingColor'> |
| 190 |
<TD> |
| 191 |
<span CLASS="font12bold">Constant Summary</span> |
| 192 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 193 |
</TD> |
| 194 |
</TR> |
| 195 |
</TABLE> |
| 196 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 197 |
<THEAD> |
| 198 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
| 199 |
</THEAD> |
| 200 |
<TBODY> |
| 201 |
|
| 202 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 203 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#NOT_SEARCHABLE'>NOT_SEARCHABLE</A></TD> |
| 204 |
<TD>FALSE</TD> |
| 205 |
<TD></TD> |
| 206 |
</TR> |
| 207 |
|
| 208 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 209 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#NOT_SORTABLE'>NOT_SORTABLE</A></TD> |
| 210 |
<TD>FALSE</TD> |
| 211 |
<TD></TD> |
| 212 |
</TR> |
| 213 |
|
| 214 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 215 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCHABLE'>SEARCHABLE</A></TD> |
| 216 |
<TD>TRUE</TD> |
| 217 |
<TD></TD> |
| 218 |
</TR> |
| 219 |
|
| 220 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 221 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCH_ALL'>SEARCH_ALL</A></TD> |
| 222 |
<TD>15</TD> |
| 223 |
<TD></TD> |
| 224 |
</TR> |
| 225 |
|
| 226 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 227 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCH_BEGINS_WITH'>SEARCH_BEGINS_WITH</A></TD> |
| 228 |
<TD>1</TD> |
| 229 |
<TD></TD> |
| 230 |
</TR> |
| 231 |
|
| 232 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 233 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCH_CONTAINS'>SEARCH_CONTAINS</A></TD> |
| 234 |
<TD>2</TD> |
| 235 |
<TD></TD> |
| 236 |
</TR> |
| 237 |
|
| 238 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 239 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCH_ENDS_WITH'>SEARCH_ENDS_WITH</A></TD> |
| 240 |
<TD>8</TD> |
| 241 |
<TD></TD> |
| 242 |
</TR> |
| 243 |
|
| 244 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 245 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SEARCH_EXACT'>SEARCH_EXACT</A></TD> |
| 246 |
<TD>4</TD> |
| 247 |
<TD></TD> |
| 248 |
</TR> |
| 249 |
|
| 250 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 251 |
<TD><A HREF='_widgets_data_list_DataList_inc.html#SORTABLE'>SORTABLE</A></TD> |
| 252 |
<TD>TRUE</TD> |
| 253 |
<TD>This is the base class for managing a list |
| 254 |
of data points.</TD> |
| 255 |
</TR> |
| 256 |
|
| 257 |
</TBODY> |
| 258 |
</TABLE> |
| 259 |
<br> |
| 260 |
|
| 261 |
<br> |
| 262 |
<!-- =========== Function SUMMARY =========== --> |
| 263 |
<A NAME='Function_summary'><!-- --></A> |
| 264 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
| 265 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 266 |
<TD> |
| 267 |
<span class="font12bold">Function Summary</span> |
| 268 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 269 |
</TD> |
| 270 |
</TR> |
| 271 |
|
| 272 |
|
| 273 |
</TABLE> |
| 274 |
|
| 275 |
<br> |
| 276 |
<!-- ============ Includes DETAIL =========== --> |
| 277 |
|
| 278 |
<A NAME='includes_detail'></A> |
| 279 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 280 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 281 |
<TD> |
| 282 |
<span CLASS="font12bold">Include Statements Detail</span> |
| 283 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 284 |
</TD> |
| 285 |
</TR> |
| 286 |
</TABLE> |
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
<br> |
| 291 |
<!-- ============ GLOBALS DETAIL =========== --> |
| 292 |
|
| 293 |
<A NAME='global_detail'></A> |
| 294 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 295 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 296 |
<TD> |
| 297 |
<span CLASS="font12bold">Global Variable Detail</span> |
| 298 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 299 |
</TD> |
| 300 |
</TR> |
| 301 |
</TABLE> |
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
<br> |
| 306 |
<!-- ============ CONSTANT DETAIL =========== --> |
| 307 |
|
| 308 |
<A NAME='constant_detail'></A> |
| 309 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 310 |
<TR CLASS='TableHeadingColor'> |
| 311 |
<TD> |
| 312 |
<span CLASS="font12bold">Constant Detail</span> |
| 313 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 314 |
</TD> |
| 315 |
</TR> |
| 316 |
</TABLE> |
| 317 |
|
| 318 |
|
| 319 |
<DIV CLASS="function"> |
| 320 |
<A NAME='NOT_SEARCHABLE'><!-- --></A> |
| 321 |
<span class="font10bold">Constant Name : </span>NOT_SEARCHABLE |
| 322 |
<BR> |
| 323 |
<span class="font10bold">Value : </span>FALSE |
| 324 |
|
| 325 |
<DIV STYLE="padding-left: 10px"> |
| 326 |
<!-- ========== Info from phpDoc block ========= --> |
| 327 |
|
| 328 |
<BR> |
| 329 |
|
| 330 |
|
| 331 |
<UL> |
| 332 |
|
| 333 |
</UL> |
| 334 |
|
| 335 |
</DIV> |
| 336 |
</DIV> |
| 337 |
<br> |
| 338 |
|
| 339 |
<DIV CLASS="function"> |
| 340 |
<A NAME='NOT_SORTABLE'><!-- --></A> |
| 341 |
<span class="font10bold">Constant Name : </span>NOT_SORTABLE |
| 342 |
<BR> |
| 343 |
<span class="font10bold">Value : </span>FALSE |
| 344 |
|
| 345 |
<DIV STYLE="padding-left: 10px"> |
| 346 |
<!-- ========== Info from phpDoc block ========= --> |
| 347 |
|
| 348 |
<BR> |
| 349 |
|
| 350 |
|
| 351 |
<UL> |
| 352 |
|
| 353 |
</UL> |
| 354 |
|
| 355 |
</DIV> |
| 356 |
</DIV> |
| 357 |
<br> |
| 358 |
|
| 359 |
<DIV CLASS="function"> |
| 360 |
<A NAME='SEARCHABLE'><!-- --></A> |
| 361 |
<span class="font10bold">Constant Name : </span>SEARCHABLE |
| 362 |
<BR> |
| 363 |
<span class="font10bold">Value : </span>TRUE |
| 364 |
|
| 365 |
<DIV STYLE="padding-left: 10px"> |
| 366 |
<!-- ========== Info from phpDoc block ========= --> |
| 367 |
|
| 368 |
<BR> |
| 369 |
|
| 370 |
|
| 371 |
<UL> |
| 372 |
|
| 373 |
</UL> |
| 374 |
|
| 375 |
</DIV> |
| 376 |
</DIV> |
| 377 |
<br> |
| 378 |
|
| 379 |
<DIV CLASS="function"> |
| 380 |
<A NAME='SEARCH_ALL'><!-- --></A> |
| 381 |
<span class="font10bold">Constant Name : </span>SEARCH_ALL |
| 382 |
<BR> |
| 383 |
<span class="font10bold">Value : </span>15 |
| 384 |
|
| 385 |
<DIV STYLE="padding-left: 10px"> |
| 386 |
<!-- ========== Info from phpDoc block ========= --> |
| 387 |
|
| 388 |
<BR> |
| 389 |
|
| 390 |
|
| 391 |
<UL> |
| 392 |
|
| 393 |
</UL> |
| 394 |
|
| 395 |
</DIV> |
| 396 |
</DIV> |
| 397 |
<br> |
| 398 |
|
| 399 |
<DIV CLASS="function"> |
| 400 |
<A NAME='SEARCH_BEGINS_WITH'><!-- --></A> |
| 401 |
<span class="font10bold">Constant Name : </span>SEARCH_BEGINS_WITH |
| 402 |
<BR> |
| 403 |
<span class="font10bold">Value : </span>1 |
| 404 |
|
| 405 |
<DIV STYLE="padding-left: 10px"> |
| 406 |
<!-- ========== Info from phpDoc block ========= --> |
| 407 |
|
| 408 |
<BR> |
| 409 |
|
| 410 |
|
| 411 |
<UL> |
| 412 |
|
| 413 |
</UL> |
| 414 |
|
| 415 |
</DIV> |
| 416 |
</DIV> |
| 417 |
<br> |
| 418 |
|
| 419 |
<DIV CLASS="function"> |
| 420 |
<A NAME='SEARCH_CONTAINS'><!-- --></A> |
| 421 |
<span class="font10bold">Constant Name : </span>SEARCH_CONTAINS |
| 422 |
<BR> |
| 423 |
<span class="font10bold">Value : </span>2 |
| 424 |
|
| 425 |
<DIV STYLE="padding-left: 10px"> |
| 426 |
<!-- ========== Info from phpDoc block ========= --> |
| 427 |
|
| 428 |
<BR> |
| 429 |
|
| 430 |
|
| 431 |
<UL> |
| 432 |
|
| 433 |
</UL> |
| 434 |
|
| 435 |
</DIV> |
| 436 |
</DIV> |
| 437 |
<br> |
| 438 |
|
| 439 |
<DIV CLASS="function"> |
| 440 |
<A NAME='SEARCH_ENDS_WITH'><!-- --></A> |
| 441 |
<span class="font10bold">Constant Name : </span>SEARCH_ENDS_WITH |
| 442 |
<BR> |
| 443 |
<span class="font10bold">Value : </span>8 |
| 444 |
|
| 445 |
<DIV STYLE="padding-left: 10px"> |
| 446 |
<!-- ========== Info from phpDoc block ========= --> |
| 447 |
|
| 448 |
<BR> |
| 449 |
|
| 450 |
|
| 451 |
<UL> |
| 452 |
|
| 453 |
</UL> |
| 454 |
|
| 455 |
</DIV> |
| 456 |
</DIV> |
| 457 |
<br> |
| 458 |
|
| 459 |
<DIV CLASS="function"> |
| 460 |
<A NAME='SEARCH_EXACT'><!-- --></A> |
| 461 |
<span class="font10bold">Constant Name : </span>SEARCH_EXACT |
| 462 |
<BR> |
| 463 |
<span class="font10bold">Value : </span>4 |
| 464 |
|
| 465 |
<DIV STYLE="padding-left: 10px"> |
| 466 |
<!-- ========== Info from phpDoc block ========= --> |
| 467 |
|
| 468 |
<BR> |
| 469 |
|
| 470 |
|
| 471 |
<UL> |
| 472 |
|
| 473 |
</UL> |
| 474 |
|
| 475 |
</DIV> |
| 476 |
</DIV> |
| 477 |
<br> |
| 478 |
|
| 479 |
<DIV CLASS="function"> |
| 480 |
<A NAME='SORTABLE'><!-- --></A> |
| 481 |
<span class="font10bold">Constant Name : </span>SORTABLE |
| 482 |
<BR> |
| 483 |
<span class="font10bold">Value : </span>TRUE |
| 484 |
|
| 485 |
<DIV STYLE="padding-left: 10px"> |
| 486 |
<!-- ========== Info from phpDoc block ========= --> |
| 487 |
This is the base class for managing a list |
| 488 |
of data points. |
| 489 |
<BR> |
| 490 |
|
| 491 |
|
| 492 |
<UL> |
| 493 |
|
| 494 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
| 495 |
|
| 496 |
</UL> |
| 497 |
|
| 498 |
</DIV> |
| 499 |
</DIV> |
| 500 |
<br> |
| 501 |
|
| 502 |
|
| 503 |
<br> |
| 504 |
<!-- ============ FUNCTION DETAIL =========== --> |
| 505 |
|
| 506 |
<A NAME='function_detail'></A> |
| 507 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 508 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 509 |
<TD> |
| 510 |
<span class="font12bold">Function Detail</span> |
| 511 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 512 |
</TD> |
| 513 |
</TR> |
| 514 |
</TABLE> |
| 515 |
<BR> |
| 516 |
|
| 517 |
|
| 518 |
<br> |
| 519 |
</HTML> |
Parent Directory
| 
Revision Log
