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

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

Parent Directory Parent Directory | Revision Log Revision Log

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