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

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FEPassword.html

Parent Directory Parent Directory | Revision Log Revision Log

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