/[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.3 - (hide annotations)
Thu May 6 16:26:14 2004 UTC (20 years, 4 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +342 -294 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
1 jonen 1.3 <?xml version="1.0" encoding="iso-8859-1"?>
2     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3     <html xmlns="http://www.w3.org/1999/xhtml">
4     <head>
5     <!-- template designed by Marco Von Ballmoos -->
6     <title>Docs For Class FEPassword</title>
7     <link rel="stylesheet" href="../../media/stylesheet.css" />
8     <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9     </head>
10     <body>
11     <div class="page-body">
12     <h2 class="class-name">Class FEPassword</h2>
13    
14     <a name="sec-description"></a>
15     <div class="info-box">
16     <div class="info-box-title">Description</div>
17     <div class="nav-bar">
18     <span class="disabled">Description</span> |
19     <a href="#sec-descendents">Descendents</a>
20     | <a href="#sec-vars">Vars</a>
21     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22    
23     </div>
24     <div class="info-box-body">
25     <!-- ========== Info from phpDoc block ========= -->
26     <p class="short-description">This is the Password FormElement which builds a input field of type=&quot;password&quot;. It validates the data as is_password().</p>
27     <p class="description"><p>NOTE: this is used in conjunction with the FEConfirmPassword object to ensure the user's input is what they wanted.</p></p>
28     <ul class="tags">
29     <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
30     <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
31     <li><span class="field">author:</span> Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>&gt;</li>
32     </ul>
33     <p class="notes">
34     Located in <a class="field" href="_form_form_elements_FEPassword_inc.html">/form/form_elements/FEPassword.inc</a> (line <span class="field">33</span>)
35     </p>
36    
37    
38 jonen 1.2 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
39 jonen 1.1 |
40     --<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a>
41     |
42 jonen 1.3 --FEPassword</pre>
43    
44     </div>
45     </div>
46    
47     <a name="sec-descendents"></a>
48     <div class="info-box">
49     <div class="info-box-title">Direct descendents</div>
50     <div class="nav-bar">
51     <a href="#sec-description">Description</a> |
52     <span class="disabled">Descendents</span>
53     | <a href="#sec-vars">Vars</a>
54     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
55    
56     </div>
57     <div class="info-box-body">
58     <table cellpadding="2" cellspacing="0" class="class-table">
59     <tr>
60     <th class="class-table-header">Class</th>
61     <th class="class-table-header">Description</th>
62     </tr>
63     <tr>
64     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html">FEConfirmPassword</a></td>
65     <td>
66     This is the ConfirmPassword FormElement which builds a input field of type=&quot;password&quot;. It requires the caller to add a FEPassword object to this class to have something to compare during validation time.
67     </td>
68     </tr>
69     </table>
70     </div>
71     </div>
72    
73    
74    
75     <a name="sec-method-summary"></a>
76     <div class="info-box">
77     <div class="info-box-title">Method Summary</span></div>
78     <div class="nav-bar">
79     <a href="#sec-description">Description</a> |
80     <a href="#sec-descendents">Descendents</a> |
81     <a href="#sec-vars">Vars</a>
82    
83     |
84     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
85     </div>
86     <div class="info-box-body">
87     <div class="method-summary">
88    
89     <div class="method-definition">
90     <span class="method-result">object</span>
91     <a href="#get_element" title="details" class="method-name">get_element</a>
92     ()
93     </div>
94    
95     <div class="method-definition">
96     <span class="method-result">string</span>
97     <a href="#get_element_text" title="details" class="method-name">get_element_text</a>
98     ()
99     </div>
100    
101     <div class="method-definition">
102     <span class="method-result">void</span>
103     <a href="#validate" title="details" class="method-name">validate</a>
104     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
105     </div>
106     </div>
107     </div>
108     </div>
109    
110     <a name="sec-vars"></a>
111     <div class="info-box">
112     <div class="info-box-title">Variables</div>
113     <div class="nav-bar">
114     <a href="#sec-description">Description</a> |
115     <a href="#sec-descendents">Descendents</a> |
116     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
117    
118    
119     |
120     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
121    
122     </div>
123     <div class="info-box-body">
124     <h4>Inherited Variables</h4>
125     <A NAME='inherited_vars'><!-- --></A>
126     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
127     <blockquote>
128     <span class="var-title">
129     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
130     </span>
131     <span class="var-title">
132     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
133     </span>
134     <span class="var-title">
135     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
136     </span>
137     <span class="var-title">
138     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
139     </span>
140     <span class="var-title">
141     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
142     </span>
143     <span class="var-title">
144     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
145     </span>
146     <span class="var-title">
147     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
148     </span>
149     <span class="var-title">
150     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
151     </span>
152     <span class="var-title">
153     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
154     </span>
155     <span class="var-title">
156     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
157     </span>
158     <span class="var-title">
159     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
160     </span>
161     <span class="var-title">
162     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
163     </span>
164     <span class="var-title">
165     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
166     </span>
167     <span class="var-title">
168     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
169     </span>
170     <span class="var-title">
171     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
172     </span>
173     </blockquote>
174    
175     </div>
176     </div>
177    
178     <a name="sec-methods"></a>
179     <div class="info-box">
180     <div class="info-box-title">Methods</div>
181     <div class="nav-bar">
182     <a href="#sec-description">Description</a> |
183     <a href="#sec-descendents">Descendents</a> |
184     <a href="#sec-vars">Vars</a>
185     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
186    
187     </div>
188     <div class="info-box-body">
189     <A NAME='method_detail'></A>
190     <a name="methodget_element" id="get_element"><!-- --></a>
191     <div class="oddrow">
192    
193     <div class="method-header">
194     <span class="method-title">get_element</span> (line <span class="line-number">41</span>)
195     </div>
196    
197     <!-- ========== Info from phpDoc block ========= -->
198     <p class="short-description">This function builds and returns the form element object</p>
199    
200     <div class="method-signature">
201     <span class="method-result">object</span>
202     <span class="method-name">
203     get_element
204     </span>
205     ()
206     </div>
207    
208    
209     <hr class="separator" />
210     <div class="notes">Redefinition of:</div>
211     <dl>
212     <dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt>
213     <dd>This function builds and returns the form element object</dd>
214     </dl>
215    
216     </div>
217     <a name="methodget_element_text" id="get_element_text"><!-- --></a>
218     <div class="evenrow">
219    
220     <div class="method-header">
221     <span class="method-title">get_element_text</span> (line <span class="line-number">55</span>)
222     </div>
223    
224     <!-- ========== Info from phpDoc block ========= -->
225     <p class="short-description">return a string to the user for the confirmation page</p>
226    
227     <div class="method-signature">
228     <span class="method-result">string</span>
229     <span class="method-name">
230     get_element_text
231     </span>
232     ()
233     </div>
234    
235    
236    
237     </div>
238     <a name="methodvalidate" id="validate"><!-- --></a>
239     <div class="oddrow">
240    
241     <div class="method-header">
242     <span class="method-title">validate</span> (line <span class="line-number">71</span>)
243     </div>
244    
245     <!-- ========== Info from phpDoc block ========= -->
246     <p class="short-description">This function performs the actual validation It is called only if the validation is required by this element</p>
247     <p class="description"><p>This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p></p>
248    
249     <div class="method-signature">
250     <span class="method-result">void</span>
251     <span class="method-name">
252     validate
253     </span>
254     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
255     </div>
256    
257     <ul class="parameters">
258     <li>
259     <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
260     <span class="var-name">&$_FormValidation</span><span class="var-description">: object</span> </li>
261     </ul>
262    
263     <hr class="separator" />
264     <div class="notes">Redefinition of:</div>
265     <dl>
266     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
267     <dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
268     </dl>
269    
270     <hr class="separator" />
271     <div class="notes">Redefined in descendants as:</div>
272     <ul class="redefinitions">
273     <li>
274     <a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html#methodvalidate">FEConfirmPassword::validate()</a>
275     : This function performs the actual validation It is called only if the validation is required by this element
276     </li>
277     </ul>
278     </div>
279     <h4>Inherited Methods</h4>
280     <a name='inherited_methods'><!-- --></a>
281     <!-- =========== Summary =========== -->
282     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p>
283     <blockquote>
284     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br>
285     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br>
286     </blockquote>
287     <!-- =========== Summary =========== -->
288     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
289     <blockquote>
290     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
291     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
292     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
293     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
294     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
295     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
296     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
297     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
298     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
299     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
300     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
301     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
302     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
303     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
304     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
305     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
306     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
307     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
308     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
309     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
310     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
311     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
312     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
313     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
314     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
315     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
316     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
317     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
318     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
319     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
320     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
321     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
322     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
323     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
324     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
325     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
326     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
327     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
328     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
329     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
330     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
331     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
332     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
333     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
334     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
335     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
336     </blockquote>
337    
338     </div>
339     </div>
340    
341    
342     <p class="notes" id="credit">
343     Documentation generated on Thu, 1 Apr 2004 09:38:34 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
344     </p>
345     </div></body>
346     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed