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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu May 6 16:57:07 2004 UTC (20 years, 8 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
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 FERegEx</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 FERegEx</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 RegEx FormElement which builds a text input field, and validates against the is_regex() method.</p>
27 <ul class="tags">
28 <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
29 <li><span class="field">author:</span> Culley Harrelson &lt;<a href="mailto:culley@fastmail.fm">culley@fastmail.fm</a>&gt;</li>
30 </ul>
31 <p class="notes">
32 Located in <a class="field" href="_form_form_elements_FEText_inc.html">/form/form_elements/FEText.inc</a> (line <span class="field">507</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 --FERegEx</pre>
41
42 </div>
43 </div>
44
45
46
47 <a name="sec-var-summary"></a>
48 <div class="info-box">
49 <div class="info-box-title">Variable Summary</span></div>
50 <div class="nav-bar">
51 <a href="#sec-description">Description</a> |
52 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
53 |
54 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
55
56 </div>
57 <div class="info-box-body">
58 <div class="var-summary">
59 <div class="var-title">
60 <span class="var-type">mixed</span>
61 <a href="#$_error_message" title="details" class="var-name">$_error_message</a>
62 </div>
63 <div class="var-title">
64 <span class="var-type">mixed</span>
65 <a href="#$_regex" title="details" class="var-name">$_regex</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">FERegEx</span>
86 <a href="#FERegEx" title="details" class="method-name">FERegEx</a>
87 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">required</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type">width</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">maxlength</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>], <span class="var-type">regex</span>&nbsp;<span class="var-name">$regex</span>, <span class="var-type">error_message</span>&nbsp;<span class="var-name">$error_message</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>&nbsp;<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$_error_message" id="$_error_message"><!-- --></A>
113 <div class="oddrow">
114
115 <div class="var-header">
116 <span class="var-title">
117 <span class="var-type">mixed</span>
118 <span class="var-name">$_error_message</span>
119 (line <span class="line-number">510</span>)
120 </span>
121 </div>
122
123 <!-- ========== Info from phpDoc block ========= -->
124
125
126 <hr class="separator" />
127 <div class="notes">Redefinition of:</div>
128 <dl>
129 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></dt>
130 <dd>Holds the error message text</dd>
131 </dl>
132
133
134
135 </div>
136 <a name="var$_regex" id="$_regex"><!-- --></A>
137 <div class="evenrow">
138
139 <div class="var-header">
140 <span class="var-title">
141 <span class="var-type">mixed</span>
142 <span class="var-name">$_regex</span>
143 (line <span class="line-number">509</span>)
144 </span>
145 </div>
146
147 <!-- ========== Info from phpDoc block ========= -->
148
149
150
151
152
153 </div>
154
155 <h4>Inherited Variables</h4>
156 <A NAME='inherited_vars'><!-- --></A>
157 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
158 <blockquote>
159 <span class="var-title">
160 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
161 </span>
162 <span class="var-title">
163 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
164 </span>
165 <span class="var-title">
166 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
167 </span>
168 <span class="var-title">
169 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
170 </span>
171 <span class="var-title">
172 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
173 </span>
174 <span class="var-title">
175 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
176 </span>
177 <span class="var-title">
178 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
179 </span>
180 <span class="var-title">
181 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
182 </span>
183 <span class="var-title">
184 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
185 </span>
186 <span class="var-title">
187 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
188 </span>
189 <span class="var-title">
190 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
191 </span>
192 <span class="var-title">
193 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
194 </span>
195 <span class="var-title">
196 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
197 </span>
198 <span class="var-title">
199 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
200 </span>
201 </blockquote>
202
203 </div>
204 </div>
205
206 <a name="sec-methods"></a>
207 <div class="info-box">
208 <div class="info-box-title">Methods</div>
209 <div class="nav-bar">
210 <a href="#sec-description">Description</a> |
211 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
212 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
213
214 </div>
215 <div class="info-box-body">
216 <A NAME='method_detail'></A>
217 <a name="methodFERegEx" id="FERegEx"><!-- --></a>
218 <div class="oddrow">
219
220 <div class="method-header">
221 <span class="method-title">Constructor FERegEx</span> (line <span class="line-number">522</span>)
222 </div>
223
224 <!-- ========== Info from phpDoc block ========= -->
225 <p class="short-description">The constructor</p>
226
227 <div class="method-signature">
228 <span class="method-result">FERegEx</span>
229 <span class="method-name">
230 FERegEx
231 </span>
232 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">required</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type">width</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">maxlength</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>], <span class="var-type">regex</span>&nbsp;<span class="var-name">$regex</span>, <span class="var-type">error_message</span>&nbsp;<span class="var-name">$error_message</span>)
233 </div>
234
235 <ul class="parameters">
236 <li>
237 <span class="var-type">label</span>
238 <span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li>
239 <li>
240 <span class="var-type">required</span>
241 <span class="var-name">$required</span><span class="var-description">: bool- is this a required element</span> </li>
242 <li>
243 <span class="var-type">width</span>
244 <span class="var-name">$width</span><span class="var-description">: int - element width in characters, pixels (px), percentage (%) or elements (em)</span> </li>
245 <li>
246 <span class="var-type">maxlength</span>
247 <span class="var-name">$maxlength</span><span class="var-description">: int- maximum number of chars allowed to type in</span> </li>
248 <li>
249 <span class="var-type">regex</span>
250 <span class="var-name">$regex</span><span class="var-description">: string - a valid regular expression i.e. '/[a-z]+$/i'</span> </li>
251 <li>
252 <span class="var-type">error_message</span>
253 <span class="var-name">$error_message</span><span class="var-description">: string - error message for failure to match the regex</span> </li>
254 </ul>
255
256
257 </div>
258 <a name="methodvalidate" id="validate"><!-- --></a>
259 <div class="evenrow">
260
261 <div class="method-header">
262 <span class="method-title">validate</span> (line <span class="line-number">535</span>)
263 </div>
264
265 <!-- ========== Info from phpDoc block ========= -->
266 <p class="short-description">This method validates the data for this Form Element.</p>
267 <p class="description"><p>It validates as is_regex().</p></p>
268
269 <div class="method-signature">
270 <span class="method-result">void</span>
271 <span class="method-name">
272 validate
273 </span>
274 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
275 </div>
276
277 <ul class="parameters">
278 <li>
279 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
280 <span class="var-name">&$_FormValidation</span><span class="var-description">: object.</span> </li>
281 </ul>
282
283 <hr class="separator" />
284 <div class="notes">Redefinition of:</div>
285 <dl>
286 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
287 <dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
288 </dl>
289
290 </div>
291 <h4>Inherited Methods</h4>
292 <a name='inherited_methods'><!-- --></a>
293 <!-- =========== Summary =========== -->
294 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p>
295 <blockquote>
296 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br>
297 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br>
298 </blockquote>
299 <!-- =========== Summary =========== -->
300 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
301 <blockquote>
302 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
303 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
304 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
305 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
306 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
307 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
308 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
309 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
310 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
311 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
312 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
313 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
314 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
315 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
316 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
317 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
318 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
319 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
320 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
321 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
322 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
323 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
324 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
325 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
326 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
327 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
328 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
329 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
330 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
331 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
332 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
333 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
334 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
335 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
336 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
337 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
338 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
339 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
340 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
341 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
342 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
343 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
344 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
345 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
346 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
347 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
348 </blockquote>
349
350 </div>
351 </div>
352
353
354 <p class="notes" id="credit">
355 Documentation generated on Thu, 1 Apr 2004 09:38:40 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
356 </p>
357 </div></body>
358 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed