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 FEConfirmPassword</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 FEConfirmPassword</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-var-summary">Vars</a> (<a href="#sec-vars">details</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 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.</p> |
27 |
<p class="description"><p>It first validates that the value is_password(), and then makes sure it matches exactly what the value is in the FEPassword.</p><p>USE: after u create the FEConfirmPassword, you MUST call password() method which adds a reference to the FEPassword object, so it can validate against.</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 <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
31 |
<li><span class="field">author:</span> Suren Markossian <<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>></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">101</span>) |
35 |
</p> |
36 |
|
37 |
|
38 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
39 |
| |
40 |
--<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a> |
41 |
| |
42 |
--<a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a> |
43 |
| |
44 |
--FEConfirmPassword</pre> |
45 |
|
46 |
</div> |
47 |
</div> |
48 |
|
49 |
|
50 |
|
51 |
<a name="sec-var-summary"></a> |
52 |
<div class="info-box"> |
53 |
<div class="info-box-title">Variable Summary</span></div> |
54 |
<div class="nav-bar"> |
55 |
<a href="#sec-description">Description</a> | |
56 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
57 |
| |
58 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
59 |
|
60 |
</div> |
61 |
<div class="info-box-body"> |
62 |
<div class="var-summary"> |
63 |
<div class="var-title"> |
64 |
<span class="var-type">mixed</span> |
65 |
<a href="#$_fepassword" title="details" class="var-name">$_fepassword</a> |
66 |
</div> |
67 |
</div> |
68 |
</div> |
69 |
</div> |
70 |
|
71 |
<a name="sec-method-summary"></a> |
72 |
<div class="info-box"> |
73 |
<div class="info-box-title">Method Summary</span></div> |
74 |
<div class="nav-bar"> |
75 |
<a href="#sec-description">Description</a> | |
76 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
77 |
|
78 |
| |
79 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
80 |
</div> |
81 |
<div class="info-box-body"> |
82 |
<div class="method-summary"> |
83 |
|
84 |
<div class="method-definition"> |
85 |
<span class="method-result">void</span> |
86 |
<a href="#password" title="details" class="method-name">password</a> |
87 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></span> <span class="var-name">&$fepassword</span>) |
88 |
</div> |
89 |
|
90 |
<div class="method-definition"> |
91 |
<span class="method-result">void</span> |
92 |
<a href="#validate" title="details" class="method-name">validate</a> |
93 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
94 |
</div> |
95 |
</div> |
96 |
</div> |
97 |
</div> |
98 |
|
99 |
<a name="sec-vars"></a> |
100 |
<div class="info-box"> |
101 |
<div class="info-box-title">Variables</div> |
102 |
<div class="nav-bar"> |
103 |
<a href="#sec-description">Description</a> | |
104 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
105 |
|
106 |
|
107 |
| |
108 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
109 |
|
110 |
</div> |
111 |
<div class="info-box-body"> |
112 |
<a name="var$_fepassword" id="$_fepassword"><!-- --></A> |
113 |
<div class="evenrow"> |
114 |
|
115 |
<div class="var-header"> |
116 |
<span class="var-title"> |
117 |
<span class="var-type">mixed</span> |
118 |
<span class="var-name">$_fepassword</span> |
119 |
= <span class="var-default"> NULL</span> (line <span class="line-number">107</span>) |
120 |
</span> |
121 |
</div> |
122 |
|
123 |
<!-- ========== Info from phpDoc block ========= --> |
124 |
<p class="short-description">This holds the FEPassword we are</p> |
125 |
<p class="description"><p>trying to confirm</p></p> |
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
</div> |
132 |
|
133 |
<h4>Inherited Variables</h4> |
134 |
<A NAME='inherited_vars'><!-- --></A> |
135 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
136 |
<blockquote> |
137 |
<span class="var-title"> |
138 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
139 |
</span> |
140 |
<span class="var-title"> |
141 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
142 |
</span> |
143 |
<span class="var-title"> |
144 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
145 |
</span> |
146 |
<span class="var-title"> |
147 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
148 |
</span> |
149 |
<span class="var-title"> |
150 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
151 |
</span> |
152 |
<span class="var-title"> |
153 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
154 |
</span> |
155 |
<span class="var-title"> |
156 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br> |
157 |
</span> |
158 |
<span class="var-title"> |
159 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
160 |
</span> |
161 |
<span class="var-title"> |
162 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
163 |
</span> |
164 |
<span class="var-title"> |
165 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
166 |
</span> |
167 |
<span class="var-title"> |
168 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br> |
169 |
</span> |
170 |
<span class="var-title"> |
171 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br> |
172 |
</span> |
173 |
<span class="var-title"> |
174 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
175 |
</span> |
176 |
<span class="var-title"> |
177 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
178 |
</span> |
179 |
<span class="var-title"> |
180 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
181 |
</span> |
182 |
</blockquote> |
183 |
|
184 |
</div> |
185 |
</div> |
186 |
|
187 |
<a name="sec-methods"></a> |
188 |
<div class="info-box"> |
189 |
<div class="info-box-title">Methods</div> |
190 |
<div class="nav-bar"> |
191 |
<a href="#sec-description">Description</a> | |
192 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
193 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
194 |
|
195 |
</div> |
196 |
<div class="info-box-body"> |
197 |
<A NAME='method_detail'></A> |
198 |
<a name="methodpassword" id="password"><!-- --></a> |
199 |
<div class="oddrow"> |
200 |
|
201 |
<div class="method-header"> |
202 |
<span class="method-title">password</span> (line <span class="line-number">116</span>) |
203 |
</div> |
204 |
|
205 |
<!-- ========== Info from phpDoc block ========= --> |
206 |
<p class="short-description">use this function to add the FEPassword object that we want to confirm.</p> |
207 |
|
208 |
<div class="method-signature"> |
209 |
<span class="method-result">void</span> |
210 |
<span class="method-name"> |
211 |
password |
212 |
</span> |
213 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></span> <span class="var-name">&$fepassword</span>) |
214 |
</div> |
215 |
|
216 |
<ul class="parameters"> |
217 |
<li> |
218 |
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></span> |
219 |
<span class="var-name">&$fepassword</span><span class="var-description">: object</span> </li> |
220 |
</ul> |
221 |
|
222 |
|
223 |
</div> |
224 |
<a name="methodvalidate" id="validate"><!-- --></a> |
225 |
<div class="evenrow"> |
226 |
|
227 |
<div class="method-header"> |
228 |
<span class="method-title">validate</span> (line <span class="line-number">132</span>) |
229 |
</div> |
230 |
|
231 |
<!-- ========== Info from phpDoc block ========= --> |
232 |
<p class="short-description">This function performs the actual validation It is called only if the validation is required by this element</p> |
233 |
<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> |
234 |
|
235 |
<div class="method-signature"> |
236 |
<span class="method-result">void</span> |
237 |
<span class="method-name"> |
238 |
validate |
239 |
</span> |
240 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
241 |
</div> |
242 |
|
243 |
<ul class="parameters"> |
244 |
<li> |
245 |
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> |
246 |
<span class="var-name">&$_FormValidation</span><span class="var-description">: object</span> </li> |
247 |
</ul> |
248 |
|
249 |
<hr class="separator" /> |
250 |
<div class="notes">Redefinition of:</div> |
251 |
<dl> |
252 |
<dt><a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodvalidate">FEPassword::validate()</a></dt> |
253 |
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd> |
254 |
</dl> |
255 |
|
256 |
</div> |
257 |
<h4>Inherited Methods</h4> |
258 |
<a name='inherited_methods'><!-- --></a> |
259 |
<!-- =========== Summary =========== --> |
260 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></span></p> |
261 |
<blockquote> |
262 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a></span><br> |
263 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element_text">FEPassword::get_element_text()</a></span><br> |
264 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodvalidate">FEPassword::validate()</a></span><br> |
265 |
</blockquote> |
266 |
<!-- =========== Summary =========== --> |
267 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p> |
268 |
<blockquote> |
269 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br> |
270 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br> |
271 |
</blockquote> |
272 |
<!-- =========== Summary =========== --> |
273 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
274 |
<blockquote> |
275 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
276 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
277 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br> |
278 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
279 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br> |
280 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
281 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
282 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
283 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
284 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
285 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
286 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
287 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
288 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br> |
289 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br> |
290 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
291 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
292 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
293 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
294 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
295 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
296 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
297 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
298 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
299 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
300 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
301 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
302 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br> |
303 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
304 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br> |
305 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
306 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
307 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
308 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
309 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br> |
310 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br> |
311 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br> |
312 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
313 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
314 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br> |
315 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
316 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
317 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
318 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
319 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
320 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
321 |
</blockquote> |
322 |
|
323 |
</div> |
324 |
</div> |
325 |
|
326 |
|
327 |
<p class="notes" id="credit"> |
328 |
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> |
329 |
</p> |
330 |
</div></body> |
331 |
</html> |