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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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