/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/widget-examples/pearmysqllist.html
ViewVC logotype

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/widget-examples/pearmysqllist.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Feb 22 21:06:54 2003 UTC (21 years, 7 months ago) by jonen
Branch: MAIN
Changes since 1.1: +102 -162 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.2 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 jonen 1.1 <!--NewPage-->
3     <HTML>
4     <HEAD>
5 jonen 1.2 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:54 -0800' -->
6 jonen 1.1 <TITLE>Docs For Class pearmysqllist</TITLE>
7 jonen 1.2 <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>
8 jonen 1.1 </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from pearmysqllist">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 jonen 1.2 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 jonen 1.1 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 jonen 1.2 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 jonen 1.1 </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class pearmysqllist
30 jonen 1.2 </H2> (line <span class="linenumber">52</span>)
31 jonen 1.1 <pre>
32 jonen 1.2 DefaultGUIDataList
33 jonen 1.1 |
34     --pearmysqllist</pre>
35 jonen 1.2 <SPAN class="type">Classes extended from pearmysqllist:</SPAN>
36     <dl>
37     <dt><a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html">adodbmysqllist</a></dt>
38     <dd>This is a subclass of the pear mysql list object.</dd>
39     </dl>
40     </p>
41 jonen 1.1 <p>
42     <b><i>Located in File: Program_Root/examples/widget6.php</i></b><br>
43     </p>
44     <hr>
45 jonen 1.2 This is an example that shows how to use a PEAR db object as the source for the data to show.
46     <br />
47 jonen 1.1
48     <UL>
49 jonen 1.2 <LI><b>version</b> - <CODE>2.0</CODE></LI>
50     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
51     </UL>
52 jonen 1.1 <hr>
53     <!-- =========== VAR SUMMARY =========== -->
54     <A NAME='var_summary'><!-- --></A>
55     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
56     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
57     <TD>
58     <span CLASS="font12bold">Class Variable Summary</span>
59     <A HREF="#top" CLASS="links">^TOP</A>
60     </TD>
61     </TR>
62    
63 jonen 1.2 <!-- =========== Summary =========== -->
64 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
65     <TD>
66 jonen 1.2 <CODE><B><A HREF="../../phpHtmlLib/widget-examples/pearmysqllist.html#var$_default_rows_per_page">$_default_rows_per_page</A></B></CODE>
67 jonen 1.1 <BR>
68     <blockquote> </blockquote>
69 jonen 1.2 <blockquote> Default Value: <CODE>->&nbsp;20<-</CODE> </blockquote>
70 jonen 1.1 </TD>
71     </TR>
72 jonen 1.2 </TABLE>
73 jonen 1.1 <hr>
74     <!-- =========== VAR INHERITED SUMMARY =========== -->
75     <A NAME='var_inherited_summary'><!-- --></A>
76     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
77 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
78 jonen 1.1 <TD>
79     <span CLASS="font12bold">Inherited Class Variable Summary</span>
80     <A HREF="#top" CLASS="links">^TOP</A>
81     </TD>
82     </TR>
83    
84 jonen 1.2 </TABLE>
85 jonen 1.1
86     <hr>
87 jonen 1.2 <!-- =========== METHOD SUMMARY =========== -->
88     <A NAME='method_summary'><!-- --></A>
89 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
90     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
91     <TD>
92     <span class="font12bold">Method Summary</span>
93     <A HREF="#top" CLASS="links">^TOP</A>
94     </TD>
95     </TR>
96    
97 jonen 1.2 <!-- =========== Summary =========== -->
98 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
99     <TD>
100 jonen 1.2 <CODE><B><A HREF='../../phpHtmlLib/widget-examples/pearmysqllist.html#methodbuild_column_item'>mixed build_column_item ( $row_data, $col_name )</A></B></CODE>
101 jonen 1.1 <BR>
102 jonen 1.2 <blockquote> This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DataListSource. </blockquote>
103 jonen 1.1 </TD>
104     </TR>
105 jonen 1.2 <!-- =========== Summary =========== -->
106 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
107     <TD>
108 jonen 1.2 <CODE><B><A HREF='../../phpHtmlLib/widget-examples/pearmysqllist.html#methodget_data_source'>void get_data_source ( )</A></B></CODE>
109 jonen 1.1 <BR>
110 jonen 1.2 <blockquote> This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object. </blockquote>
111 jonen 1.1 </TD>
112     </TR>
113 jonen 1.2 <!-- =========== Summary =========== -->
114 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
115     <TD>
116 jonen 1.2 <CODE><B><A HREF='../../phpHtmlLib/widget-examples/pearmysqllist.html#methoduser_setup'>void user_setup ( )</A></B></CODE>
117 jonen 1.1 <BR>
118 jonen 1.2 <blockquote> This method is used to setup the options for the DataList object's display. </blockquote>
119     </TD>
120     </TR>
121     </TABLE>
122     <!-- =========== INHERITED METHOD SUMMARY =========== -->
123     <A NAME='functions_inherited'><!-- --></A>
124     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
125     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
126     <TD>
127     <span CLASS="font12bold">Inherited Method Summary</span>
128     <A HREF="#top" CLASS="links">^TOP</A>
129 jonen 1.1 </TD>
130     </TR>
131    
132 jonen 1.2 </TABLE>
133 jonen 1.1 <hr>
134     <!-- ============ VARIABLE DETAIL =========== -->
135    
136     <A NAME='variable_detail'></A>
137     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
138     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
139     <TD>
140     <span CLASS="font12bold">Variable Detail</span>
141     <A HREF="#top" CLASS="links">^TOP</A>
142     </TD>
143     </TR>
144     </TABLE>
145    
146 jonen 1.2 <A NAME='var$_default_rows_per_page'><!-- --></A><H3>$_default_rows_per_page</H3> (line <span class="linenumber">54</span>)<br />
147 jonen 1.1 <b>Data type:</b> mixed<br>
148 jonen 1.2 <br />
149 jonen 1.1
150     <UL>
151 jonen 1.2 </UL>
152 jonen 1.1 <HR>
153     <hr>
154 jonen 1.2 <!-- ============ METHOD DETAIL =========== -->
155 jonen 1.1
156 jonen 1.2 <A NAME='method_detail'></A>
157 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
158     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
159     <TD>
160     <span class="font12bold">Method Detail</span>
161     <A HREF="#top" CLASS="links">^TOP</A>
162     </TD>
163     </TR>
164     </TABLE>
165     <BR>
166     <DIV CLASS="function">
167 jonen 1.2 <A NAME='methodbuild_column_item'><!-- --></A>
168     <SPAN CLASS="font12bold">build_column_item</SPAN> (line <span class="linenumber">130</span>)
169 jonen 1.1 <BR>
170 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
171 jonen 1.1 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
172 jonen 1.2 <span class="font10bold" style="color: #0000FF">build_column_item(
173     array
174     $row_data, string
175     $col_name)</SPAN>
176 jonen 1.1 <BR>
177    
178     <BR>
179     <SPAN CLASS="font10bold">Description : </SPAN>
180 jonen 1.2 This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DataListSource.
181     <br />
182     <p>NOTE: this function is can be overridden so that you can return whatever you want for any given column.</p>
183 jonen 1.1 <DL>
184 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
185     <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> - $row_data - the entire data for the row</DD>
186     <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> - $col_name - the name of the column header for this row to render.</DD>
187    
188     <DT class="font10bold">Function Info:</DT>
189     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either a HTMLTag object, or raw text.</DD>
190     </DL>
191 jonen 1.1 </DIV>
192     <BR>
193     <DIV CLASS="function">
194 jonen 1.2 <A NAME='methodget_data_source'><!-- --></A>
195     <SPAN CLASS="font12bold">get_data_source</SPAN> (line <span class="linenumber">64</span>)
196 jonen 1.1 <BR>
197 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
198 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
199 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_data_source(
200     )</SPAN>
201 jonen 1.1 <BR>
202 jonen 1.2 <p>Overridden in child classes as:<br />
203     <dl>
204     <dt><a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html#methodget_data_source">adodbmysqllist::get_data_source()</a></dt>
205     <dd>This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</dd>
206     </dl>
207     </p>
208    
209 jonen 1.1 <BR>
210     <SPAN CLASS="font10bold">Description : </SPAN>
211 jonen 1.2 This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.
212     <br />
213    
214 jonen 1.1 <DL>
215    
216 jonen 1.2 <DT class="font10bold">Function Info:</DT>
217     </DL>
218 jonen 1.1 </DIV>
219     <BR>
220     <DIV CLASS="function">
221 jonen 1.2 <A NAME='methoduser_setup'><!-- --></A>
222     <SPAN CLASS="font12bold">user_setup</SPAN> (line <span class="linenumber">97</span>)
223 jonen 1.1 <BR>
224 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
225 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
226 jonen 1.2 <span class="font10bold" style="color: #0000FF">user_setup(
227     )</SPAN>
228 jonen 1.1 <BR>
229    
230     <BR>
231     <SPAN CLASS="font10bold">Description : </SPAN>
232 jonen 1.2 This method is used to setup the options for the DataList object's display.
233     <br />
234     <p>Which columns to show, their respective source column name, width, etc. etc.</p><p>The constructor automatically calls this function.</p>
235 jonen 1.1 <DL>
236    
237 jonen 1.2 <DT class="font10bold">Function Info:</DT>
238     </DL>
239 jonen 1.1 </DIV>
240     <BR>
241 jonen 1.2 <div id="credit">
242     <hr>
243     Documention generated on Thu, 20 Feb 2003 16:23:54 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
244     </div>
245     </body>
246     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed