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 FEName</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 FEName</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-vars">Vars</a> |
20 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 |
|
22 |
</div> |
23 |
<div class="info-box-body"> |
24 |
<!-- ========== Info from phpDoc block ========= --> |
25 |
<p class="short-description">This is the Name FormElement which builds a text input field, and validates against the is_name() method.</p> |
26 |
<ul class="tags"> |
27 |
<li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li> |
28 |
<li><span class="field">author:</span> <p>Suren Markossian <<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>></p></li> |
29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
30 |
</ul> |
31 |
<p class="notes"> |
32 |
Located in <a class="field" href="_form_form_elements_FEText_inc.html">Program_Root/form/form_elements/FEText.inc</a> (line <span class="field">84</span>) |
33 |
</p> |
34 |
|
35 |
|
36 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
37 |
| |
38 |
--<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a> |
39 |
| |
40 |
--FEName</pre> |
41 |
|
42 |
</div> |
43 |
</div> |
44 |
|
45 |
|
46 |
|
47 |
<a name="sec-method-summary"></a> |
48 |
<div class="info-box"> |
49 |
<div class="info-box-title">Method Summary</span></div> |
50 |
<div class="nav-bar"> |
51 |
<a href="#sec-description">Description</a> | |
52 |
<a href="#sec-vars">Vars</a> |
53 |
|
54 |
| |
55 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
56 |
</div> |
57 |
<div class="info-box-body"> |
58 |
<div class="method-summary"> |
59 |
|
60 |
<div class="method-definition"> |
61 |
<span class="method-result">void</span> |
62 |
<a href="#validate" title="details" class="method-name">validate</a> |
63 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
64 |
</div> |
65 |
</div> |
66 |
</div> |
67 |
</div> |
68 |
|
69 |
<a name="sec-vars"></a> |
70 |
<div class="info-box"> |
71 |
<div class="info-box-title">Variables</div> |
72 |
<div class="nav-bar"> |
73 |
<a href="#sec-description">Description</a> | |
74 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
75 |
|
76 |
|
77 |
| |
78 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
79 |
|
80 |
</div> |
81 |
<div class="info-box-body"> |
82 |
<h4>Inherited Variables</h4> |
83 |
<A NAME='inherited_vars'><!-- --></A> |
84 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
85 |
<blockquote> |
86 |
<span class="var-title"> |
87 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
88 |
</span> |
89 |
<span class="var-title"> |
90 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
91 |
</span> |
92 |
<span class="var-title"> |
93 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
94 |
</span> |
95 |
<span class="var-title"> |
96 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
97 |
</span> |
98 |
<span class="var-title"> |
99 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
100 |
</span> |
101 |
<span class="var-title"> |
102 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
103 |
</span> |
104 |
<span class="var-title"> |
105 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
106 |
</span> |
107 |
<span class="var-title"> |
108 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
109 |
</span> |
110 |
<span class="var-title"> |
111 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
112 |
</span> |
113 |
<span class="var-title"> |
114 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
115 |
</span> |
116 |
<span class="var-title"> |
117 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
118 |
</span> |
119 |
<span class="var-title"> |
120 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
121 |
</span> |
122 |
</blockquote> |
123 |
|
124 |
</div> |
125 |
</div> |
126 |
|
127 |
<a name="sec-methods"></a> |
128 |
<div class="info-box"> |
129 |
<div class="info-box-title">Methods</div> |
130 |
<div class="nav-bar"> |
131 |
<a href="#sec-description">Description</a> | |
132 |
<a href="#sec-vars">Vars</a> |
133 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
134 |
|
135 |
</div> |
136 |
<div class="info-box-body"> |
137 |
<A NAME='method_detail'></A> |
138 |
<a name="methodvalidate" id="validate"><!-- --></a> |
139 |
<div class="oddrow"> |
140 |
|
141 |
<div class="method-header"> |
142 |
<span class="method-title">validate</span> (line <span class="line-number">93</span>) |
143 |
</div> |
144 |
|
145 |
<!-- ========== Info from phpDoc block ========= --> |
146 |
<p class="short-description">This method validates the data for this Form Element.</p> |
147 |
<p class="description"><p>It validates as is_name().</p></p> |
148 |
|
149 |
<div class="method-signature"> |
150 |
<span class="method-result">void</span> |
151 |
<span class="method-name"> |
152 |
validate |
153 |
</span> |
154 |
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
155 |
</div> |
156 |
|
157 |
<ul class="parameters"> |
158 |
<li> |
159 |
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> |
160 |
<span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object.</p></span> </li> |
161 |
</ul> |
162 |
|
163 |
<hr class="separator" /> |
164 |
<div class="notes">Redefinition of:</div> |
165 |
<dl> |
166 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt> |
167 |
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd> |
168 |
</dl> |
169 |
|
170 |
</div> |
171 |
<h4>Inherited Methods</h4> |
172 |
<a name='inherited_methods'><!-- --></a> |
173 |
<!-- =========== Summary =========== --> |
174 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p> |
175 |
<blockquote> |
176 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br> |
177 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br> |
178 |
</blockquote> |
179 |
<!-- =========== Summary =========== --> |
180 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
181 |
<blockquote> |
182 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
183 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
184 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
185 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
186 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
187 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
188 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
189 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
190 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
191 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
192 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
193 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
194 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
195 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
196 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
197 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
198 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
199 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
200 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
201 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
202 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
203 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
204 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
205 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
206 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
207 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
208 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
209 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
210 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
211 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
212 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
213 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
214 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
215 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
216 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
217 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
218 |
</blockquote> |
219 |
|
220 |
</div> |
221 |
</div> |
222 |
|
223 |
<p class="notes" id="credit"> |
224 |
Documention generated on Thu, 31 Jul 2003 18:32:37 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
225 |
</p> |
226 |
</div></body> |
227 |
</html> |