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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations)
Sat Feb 22 21:05:21 2003 UTC (21 years, 7 months ago) by jonen
Branch: MAIN
File MIME type: text/html
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)

1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:46 -0800' -->
6 <TITLE>Docs For Class FEEmailMany</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>
8 </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 FEEmailMany">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 <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 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 </TD>
24 </TR>
25 </TABLE>
26 <BR>
27 <!-- Start of Class Data -->
28 <H2>
29 Class FEEmailMany
30 </H2> (line <span class="linenumber">151</span>)
31 <pre>
32 <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
33 |
34 --<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a>
35 |
36 --FEEmailMany</pre>
37 <p>
38 <b><i>Located in File: Program_Root/form/form_elements/FEText.inc</i></b><br>
39 </p>
40 <hr>
41 This is the EmailMany FormElement which builds a text input field. This allows for multiple email addresses in 1 text input field seperated by commas.
42 <br />
43 <p>It validatest he data as is_manyemails()</p>
44 <UL>
45 <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>
46 <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>
47 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
48 </UL>
49 <hr>
50 <!-- =========== VAR SUMMARY =========== -->
51 <A NAME='var_summary'><!-- --></A>
52 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
53 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
54 <TD>
55 <span CLASS="font12bold">Class Variable Summary</span>
56 <A HREF="#top" CLASS="links">^TOP</A>
57 </TD>
58 </TR>
59
60 </TABLE>
61 <hr>
62 <!-- =========== VAR INHERITED SUMMARY =========== -->
63 <A NAME='var_inherited_summary'><!-- --></A>
64 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
65 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
66 <TD>
67 <span CLASS="font12bold">Inherited Class Variable Summary</span>
68 <A HREF="#top" CLASS="links">^TOP</A>
69 </TD>
70 </TR>
71
72 <!-- =========== Summary =========== -->
73 <TR BGCOLOR='white'>
74 <TD>
75 <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
76 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
77 <tr CLASS="tableheadingcolor">
78 <th>Variable</th>
79 <th>Default Value</th>
80 <th>Description</th>
81 </tr>
82 <tr>
83 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>
84 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
85 <td CLASS="font10">Holds additional attributes for</td>
86 </tr>
87 <tr>
88 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>
89 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
90 <td CLASS="font10">Holds the name of the element</td>
91 </tr>
92 <tr>
93 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>
94 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
95 <td CLASS="font10">Holds the error message text</td>
96 </tr>
97 <tr>
98 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>
99 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
100 <td CLASS="font10">Holds the state of the last validation</td>
101 </tr>
102 <tr>
103 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>
104 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
105 <td CLASS="font10">Indicates a disabled element</td>
106 </tr>
107 <tr>
108 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>
109 <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
110 <td CLASS="font10">Indicates whether this elements</td>
111 </tr>
112 <tr>
113 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>
114 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
115 <td CLASS="font10">Holds the elements label text</td>
116 </tr>
117 <tr>
118 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>
119 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
120 <td CLASS="font10">Holds additional style attributes for</td>
121 </tr>
122 <tr>
123 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>
124 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
125 <td CLASS="font10">Holds the elements initial value</td>
126 </tr>
127 </table>
128 <BR>
129 </TD>
130 </TR>
131 </TABLE>
132
133 <hr>
134 <!-- =========== METHOD SUMMARY =========== -->
135 <A NAME='method_summary'><!-- --></A>
136 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
137 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
138 <TD>
139 <span class="font12bold">Method Summary</span>
140 <A HREF="#top" CLASS="links">^TOP</A>
141 </TD>
142 </TR>
143
144 <!-- =========== Summary =========== -->
145 <TR BGCOLOR='white' CLASS='TableRowColor'>
146 <TD>
147 <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEEmailMany.html#methodvalidate'>void validate ( )</A></B></CODE>
148 <BR>
149 <blockquote> This method validates the data for this Form Element. </blockquote>
150 </TD>
151 </TR>
152 </TABLE>
153 <!-- =========== INHERITED METHOD SUMMARY =========== -->
154 <A NAME='functions_inherited'><!-- --></A>
155 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
156 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
157 <TD>
158 <span CLASS="font12bold">Inherited Method Summary</span>
159 <A HREF="#top" CLASS="links">^TOP</A>
160 </TD>
161 </TR>
162
163 <!-- =========== Summary =========== -->
164 <TR BGCOLOR='white' CLASS='TableRowColor'>
165 <TD>
166 <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span>
167 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
168 <tr CLASS="tableheadingcolor">
169 <th>Function</th>
170 <th>Description</th>
171 </tr>
172 <tr>
173 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></td>
174 <td CLASS="font10">The constructor</td>
175 <tr>
176 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></td>
177 <td CLASS="font10">This function builds and returns the form element object</td>
178 </table>
179 <br>
180 </TD>
181 </TR>
182 <!-- =========== Summary =========== -->
183 <TR BGCOLOR='white' CLASS='TableRowColor'>
184 <TD>
185 <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
186 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
187 <tr CLASS="tableheadingcolor">
188 <th>Function</th>
189 <th>Description</th>
190 </tr>
191 <tr>
192 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>
193 <td CLASS="font10">The constructor</td>
194 <tr>
195 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>
196 <td CLASS="font10">This function creates element name</td>
197 <tr>
198 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>
199 <td CLASS="font10">return a single attribute</td>
200 <tr>
201 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>
202 <td CLASS="font10">This function builds and returns the form element object</td>
203 <tr>
204 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>
205 <td CLASS="font10">Returns the element name to be used in the form</td>
206 <tr>
207 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>
208 <td CLASS="font10">Returns the current error message if any</td>
209 <tr>
210 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>
211 <td CLASS="font10">This returns the initial value of the element</td>
212 <tr>
213 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>
214 <td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td>
215 <tr>
216 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>
217 <td CLASS="font10">This function will return the elements label text</td>
218 <tr>
219 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>
220 <td CLASS="font10">This function return the symbol used to denote a required field</td>
221 <tr>
222 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>
223 <td CLASS="font10">This function will return the elements value</td>
224 <tr>
225 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>
226 <td CLASS="font10">This provides a method</td>
227 <tr>
228 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>
229 <td CLASS="font10">Returns the current error state</td>
230 <tr>
231 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>
232 <td CLASS="font10">Returns the elements disabled state</td>
233 <tr>
234 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>
235 <td CLASS="font10">Returns whether this elements final value cannot be empty</td>
236 <tr>
237 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>
238 <td CLASS="font10">This function return the javaScript code for an onBlur event</td>
239 <tr>
240 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>
241 <td CLASS="font10">This function return the javaScript code for an onClick event</td>
242 <tr>
243 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>
244 <td CLASS="font10">This function return the javaScript code for an onFocus event</td>
245 <tr>
246 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>
247 <td CLASS="font10">This function return the javaScript code for an onSubmit event</td>
248 <tr>
249 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>
250 <td CLASS="font10">add a single attribute (name="value")</td>
251 <tr>
252 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>
253 <td CLASS="font10">Sets the disabled element flag</td>
254 <tr>
255 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>
256 <td CLASS="font10">Defines error message text and sets the error flag to true</td>
257 <tr>
258 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>
259 <td CLASS="font10">This function will set the label for the element</td>
260 <tr>
261 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>
262 <td CLASS="font10">This function set the elements required state</td>
263 <tr>
264 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>
265 <td CLASS="font10">Sets elements css attribute</td>
266 <tr>
267 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>
268 <td CLASS="font10">Sets elements title text</td>
269 <tr>
270 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>
271 <td CLASS="font10">This function will set the initial value for the element</td>
272 <tr>
273 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>
274 <td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td>
275 <tr>
276 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>
277 <td CLASS="font10">This function builds the element form attributes</td>
278 <tr>
279 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>
280 <td CLASS="font10">This function builds the complete javaScript events code for the element</td>
281 <tr>
282 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>
283 <td CLASS="font10">This function checks if the validation</td>
284 </table>
285 <br>
286 </TD>
287 </TR>
288 </TABLE>
289 <hr>
290 <!-- ============ VARIABLE DETAIL =========== -->
291
292 <A NAME='variable_detail'></A>
293 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
294 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
295 <TD>
296 <span CLASS="font12bold">Variable Detail</span>
297 <A HREF="#top" CLASS="links">^TOP</A>
298 </TD>
299 </TR>
300 </TABLE>
301
302 <hr>
303 <!-- ============ METHOD DETAIL =========== -->
304
305 <A NAME='method_detail'></A>
306 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
307 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
308 <TD>
309 <span class="font12bold">Method Detail</span>
310 <A HREF="#top" CLASS="links">^TOP</A>
311 </TD>
312 </TR>
313 </TABLE>
314 <BR>
315 <DIV CLASS="function">
316 <A NAME='methodvalidate'><!-- --></A>
317 <SPAN CLASS="font12bold">validate</SPAN> (line <span class="linenumber">159</span>)
318 <BR>
319 <SPAN CLASS="font10bold">Usage : </SPAN>
320 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
321 <span class="font10bold" style="color: #0000FF">validate(
322 )</SPAN>
323 <BR>
324
325 <BR>
326 <SPAN CLASS="font10bold">Description : </SPAN>
327 This method validates the data for this Form Element.
328 <br />
329 <p>It validates as is_manyemails().</p>
330 <DL>
331
332 <DT class="font10bold">Function Info:</DT>
333 </DL>
334 </DIV>
335 <BR>
336 <div id="credit">
337 <hr>
338 Documention generated on Thu, 20 Feb 2003 16:22:46 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
339 </div>
340 </body>
341 </html>

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