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

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

Parent Directory Parent Directory | Revision Log Revision Log

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