| 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:40 -0800' --> |
| 6 |
<TITLE>Docs For Class pearmysqllist</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="#children_summary" class="links" title="Classes extended from pearmysqllist">Child Classes</A> |
| 19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
| 20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| 21 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
| 22 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
| 23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
| 24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
| 25 |
</TD> |
| 26 |
</TR> |
| 27 |
</TABLE> |
| 28 |
<BR> |
| 29 |
|
| 30 |
<!-- Start of Class Data --> |
| 31 |
<H2> |
| 32 |
Class pearmysqllist |
| 33 |
</H2> |
| 34 |
|
| 35 |
<pre> |
| 36 |
<pre>DefaultGUIDataList |
| 37 |
| |
| 38 |
--pearmysqllist</pre> |
| 39 |
</pre> |
| 40 |
|
| 41 |
<A NAME="children_summary"</A> |
| 42 |
<H3> |
| 43 |
Classes extended from pearmysqllist: <A HREF="#top" CLASS="links">^TOP</A> |
| 44 |
</H3> |
| 45 |
<a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html">adodbmysqllist</a> |
| 46 |
<p> |
| 47 |
<b><i>Located in File: Program_Root/examples/widget6.php</i></b><br> |
| 48 |
</p> |
| 49 |
<hr> |
| 50 |
<!-- ========== Info from phpDoc block ========= --> |
| 51 |
This is an example that shows how to use a PEAR db object |
| 52 |
as the source for the data to show. |
| 53 |
<BR> |
| 54 |
|
| 55 |
|
| 56 |
<UL> |
| 57 |
|
| 58 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
| 59 |
|
| 60 |
<LI><b>Sub-Package</b> - <CODE>widget-examples</CODE></LI> |
| 61 |
|
| 62 |
<LI><b>Version</b> - <CODE>2.0</CODE></LI> |
| 63 |
|
| 64 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
| 65 |
|
| 66 |
</UL> |
| 67 |
|
| 68 |
<hr> |
| 69 |
<!-- =========== VAR SUMMARY =========== --> |
| 70 |
<A NAME='var_summary'><!-- --></A> |
| 71 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 72 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 73 |
<TD> |
| 74 |
<span CLASS="font12bold">Class Variable Summary</span> |
| 75 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 76 |
</TD> |
| 77 |
</TR> |
| 78 |
|
| 79 |
|
| 80 |
<!-- =========== Summary =========== --> |
| 81 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 82 |
<TD> |
| 83 |
<CODE><B><A HREF='pearmysqllist.html#$_default_rows_per_page'>$_default_rows_per_page</A></B></CODE> |
| 84 |
<BR> |
| 85 |
<blockquote> </blockquote> |
| 86 |
<blockquote> Default Value: <CODE>->20<-</CODE> </blockquote> |
| 87 |
</TD> |
| 88 |
</TR> |
| 89 |
|
| 90 |
</TABLE> |
| 91 |
|
| 92 |
<hr> |
| 93 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
| 94 |
<A NAME='var_inherited_summary'><!-- --></A> |
| 95 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 96 |
<TR CLASS='TableHeadingColor'> |
| 97 |
<TD> |
| 98 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
| 99 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 100 |
</TD> |
| 101 |
</TR> |
| 102 |
|
| 103 |
|
| 104 |
</TABLE> |
| 105 |
|
| 106 |
<hr> |
| 107 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
| 108 |
<A NAME='functions_inherited'><!-- --></A> |
| 109 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 110 |
<TR CLASS='TableHeadingColor'> |
| 111 |
<TD> |
| 112 |
<span CLASS="font12bold">Inherited Method Summary</span> |
| 113 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 114 |
</TD> |
| 115 |
</TR> |
| 116 |
|
| 117 |
|
| 118 |
</TABLE> |
| 119 |
|
| 120 |
<hr> |
| 121 |
<!-- should have constructor at some point --> |
| 122 |
<!-- =========== Method SUMMARY =========== --> |
| 123 |
<A NAME='Method_summary'><!-- --></A> |
| 124 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
| 125 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 126 |
<TD> |
| 127 |
<span class="font12bold">Method Summary</span> |
| 128 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 129 |
</TD> |
| 130 |
</TR> |
| 131 |
|
| 132 |
|
| 133 |
<!-- =========== Summary =========== --> |
| 134 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 135 |
<TD> |
| 136 |
<CODE><B><A HREF='pearmysqllist.html#build_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE> |
| 137 |
<BR> |
| 138 |
<blockquote> This is the basic function for letting us </blockquote> |
| 139 |
</TD> |
| 140 |
</TR> |
| 141 |
|
| 142 |
<!-- =========== Summary =========== --> |
| 143 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 144 |
<TD> |
| 145 |
<CODE><B><A HREF='pearmysqllist.html#get_data_source'>void get_data_source ( )</A></B></CODE> |
| 146 |
<BR> |
| 147 |
<blockquote> This function is called automatically by |
| 148 |
the DataList constructor. </blockquote> |
| 149 |
</TD> |
| 150 |
</TR> |
| 151 |
|
| 152 |
<!-- =========== Summary =========== --> |
| 153 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 154 |
<TD> |
| 155 |
<CODE><B><A HREF='pearmysqllist.html#user_setup'>void user_setup ( )</A></B></CODE> |
| 156 |
<BR> |
| 157 |
<blockquote> This method is used to setup the options |
| 158 |
for the DataList object's display. </blockquote> |
| 159 |
</TD> |
| 160 |
</TR> |
| 161 |
|
| 162 |
</TABLE> |
| 163 |
|
| 164 |
<hr> |
| 165 |
<!-- ============ VARIABLE DETAIL =========== --> |
| 166 |
|
| 167 |
<A NAME='variable_detail'></A> |
| 168 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 169 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 170 |
<TD> |
| 171 |
<span CLASS="font12bold">Variable Detail</span> |
| 172 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 173 |
</TD> |
| 174 |
</TR> |
| 175 |
</TABLE> |
| 176 |
|
| 177 |
|
| 178 |
<A NAME='$_default_rows_per_page'><!-- --></A><H3>$_default_rows_per_page</H3> |
| 179 |
<b>Data type:</b> mixed<br> |
| 180 |
<!-- ========== Info from phpDoc block ========= --> |
| 181 |
|
| 182 |
<BR> |
| 183 |
|
| 184 |
|
| 185 |
<UL> |
| 186 |
|
| 187 |
</UL> |
| 188 |
|
| 189 |
<HR> |
| 190 |
|
| 191 |
|
| 192 |
<hr> |
| 193 |
<!-- ============ FUNCTION DETAIL =========== --> |
| 194 |
|
| 195 |
<A NAME='function_detail'></A> |
| 196 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 197 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 198 |
<TD> |
| 199 |
<span class="font12bold">Method Detail</span> |
| 200 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 201 |
</TD> |
| 202 |
</TR> |
| 203 |
</TABLE> |
| 204 |
<BR> |
| 205 |
|
| 206 |
<DIV CLASS="function"> |
| 207 |
<A NAME='build_column_item'><!-- --></A> |
| 208 |
<SPAN CLASS="font12bold">build_column_item</SPAN> |
| 209 |
<BR> |
| 210 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 211 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
| 212 |
<span class="font10bold" style="color: #0000FF">build_column_item ( $row_data, $col_name )</SPAN> |
| 213 |
<BR> |
| 214 |
|
| 215 |
<BR> |
| 216 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 217 |
<!-- ========== Info from phpDoc block ========= --> |
| 218 |
This is the basic function for letting us |
| 219 |
<BR> |
| 220 |
do a mapping between the column name in |
| 221 |
the header, to the value found in the DataListSource. |
| 222 |
|
| 223 |
NOTE: this function is can be overridden |
| 224 |
so that you can return whatever you want for |
| 225 |
any given column. |
| 226 |
<DL> |
| 227 |
<DT class="font10bold">Function Parameters:</DT> |
| 228 |
|
| 229 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$row_data</SPAN></SPAN> - - the entire data for the row</DD> |
| 230 |
|
| 231 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$col_name</SPAN></SPAN> - - the name of the column header |
| 232 |
for this row to render.</DD> |
| 233 |
|
| 234 |
|
| 235 |
<DT class="font10bold">Function Info:</DT> |
| 236 |
|
| 237 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either a HTMLTag object, or raw text.</DD> |
| 238 |
|
| 239 |
</DL> |
| 240 |
|
| 241 |
</DIV> |
| 242 |
<BR> |
| 243 |
|
| 244 |
<DIV CLASS="function"> |
| 245 |
<A NAME='get_data_source'><!-- --></A> |
| 246 |
<SPAN CLASS="font12bold">get_data_source</SPAN> |
| 247 |
<BR> |
| 248 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 249 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
| 250 |
<span class="font10bold" style="color: #0000FF">get_data_source ( )</SPAN> |
| 251 |
<BR> |
| 252 |
Overridden in child class(es) as: <a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html#get_data_source">adodbmysqllist::get_data_source()</a><br> |
| 253 |
<BR> |
| 254 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 255 |
<!-- ========== Info from phpDoc block ========= --> |
| 256 |
This function is called automatically by |
| 257 |
the DataList constructor. |
| 258 |
<BR> |
| 259 |
It must be |
| 260 |
extended by the child class to actually |
| 261 |
set the DataListSource object. |
| 262 |
<DL> |
| 263 |
<DT class="font10bold">Function Parameters:</DT> |
| 264 |
|
| 265 |
|
| 266 |
<DT class="font10bold">Function Info:</DT> |
| 267 |
|
| 268 |
</DL> |
| 269 |
|
| 270 |
</DIV> |
| 271 |
<BR> |
| 272 |
|
| 273 |
<DIV CLASS="function"> |
| 274 |
<A NAME='user_setup'><!-- --></A> |
| 275 |
<SPAN CLASS="font12bold">user_setup</SPAN> |
| 276 |
<BR> |
| 277 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 278 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
| 279 |
<span class="font10bold" style="color: #0000FF">user_setup ( )</SPAN> |
| 280 |
<BR> |
| 281 |
|
| 282 |
<BR> |
| 283 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 284 |
<!-- ========== Info from phpDoc block ========= --> |
| 285 |
This method is used to setup the options |
| 286 |
for the DataList object's display. |
| 287 |
<BR> |
| 288 |
Which columns to show, their respective |
| 289 |
source column name, width, etc. etc. |
| 290 |
|
| 291 |
The constructor automatically calls |
| 292 |
this function. |
| 293 |
<DL> |
| 294 |
<DT class="font10bold">Function Parameters:</DT> |
| 295 |
|
| 296 |
|
| 297 |
<DT class="font10bold">Function Info:</DT> |
| 298 |
|
| 299 |
</DL> |
| 300 |
|
| 301 |
</DIV> |
| 302 |
<BR> |
| 303 |
|
| 304 |
|
| 305 |
<hr> |
| 306 |
</HTML> |
Parent Directory
| 
Revision Log
