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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:22 2003 UTC (21 years, 10 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5     <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:04 -0800' -->
6     <TITLE>Docs For Class FEError</TITLE>
7     <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>
8     </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from FEError">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19     <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21     <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22     <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23     </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class FEError
30     </H2> (line <span class="linenumber">56</span>)
31     <pre>
32     <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
33     |
34     --FEError</pre>
35     <p>
36     <b><i>Located in File: Program_Root/form/form_elements/misc.inc</i></b><br>
37     </p>
38     <hr>
39     This is a way of providing an Error to the FormProcessor.
40     <br />
41     <p>It can be used at any time during FormContent to create a specialized error field and message.</p>
42     <UL>
43     <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>
44     <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>
45     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
46     </UL>
47     <hr>
48     <!-- =========== VAR SUMMARY =========== -->
49     <A NAME='var_summary'><!-- --></A>
50     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
51     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
52     <TD>
53     <span CLASS="font12bold">Class Variable Summary</span>
54     <A HREF="#top" CLASS="links">^TOP</A>
55     </TD>
56     </TR>
57    
58     </TABLE>
59     <hr>
60     <!-- =========== VAR INHERITED SUMMARY =========== -->
61     <A NAME='var_inherited_summary'><!-- --></A>
62     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
63     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
64     <TD>
65     <span CLASS="font12bold">Inherited Class Variable Summary</span>
66     <A HREF="#top" CLASS="links">^TOP</A>
67     </TD>
68     </TR>
69    
70     <!-- =========== Summary =========== -->
71     <TR BGCOLOR='white'>
72     <TD>
73     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
74     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
75     <tr CLASS="tableheadingcolor">
76     <th>Variable</th>
77     <th>Default Value</th>
78     <th>Description</th>
79     </tr>
80     <tr>
81     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>
82     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
83     <td CLASS="font10">Holds additional attributes for</td>
84     </tr>
85     <tr>
86     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>
87     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
88     <td CLASS="font10">Holds the name of the element</td>
89     </tr>
90     <tr>
91     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>
92     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
93     <td CLASS="font10">Holds the error message text</td>
94     </tr>
95     <tr>
96     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>
97     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
98     <td CLASS="font10">Holds the state of the last validation</td>
99     </tr>
100     <tr>
101     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>
102     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
103     <td CLASS="font10">Indicates a disabled element</td>
104     </tr>
105     <tr>
106     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>
107     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
108     <td CLASS="font10">Indicates whether this elements</td>
109     </tr>
110     <tr>
111     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>
112     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
113     <td CLASS="font10">Holds the elements label text</td>
114     </tr>
115     <tr>
116     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>
117     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
118     <td CLASS="font10">Holds additional style attributes for</td>
119     </tr>
120     <tr>
121     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>
122     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
123     <td CLASS="font10">Holds the elements initial value</td>
124     </tr>
125     </table>
126     <BR>
127     </TD>
128     </TR>
129     </TABLE>
130    
131     <hr>
132     <!-- =========== METHOD SUMMARY =========== -->
133     <A NAME='method_summary'><!-- --></A>
134     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
135     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
136     <TD>
137     <span class="font12bold">Method Summary</span>
138     <A HREF="#top" CLASS="links">^TOP</A>
139     </TD>
140     </TR>
141    
142     <!-- =========== Summary =========== -->
143     <TR BGCOLOR='white' CLASS='TableRowColor'>
144     <TD>
145     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEError.html#methodFEError'>void constructor FEError ( $label, $message )</A></B></CODE>
146     <BR>
147     <blockquote> The constructor </blockquote>
148     </TD>
149     </TR>
150     </TABLE>
151     <!-- =========== INHERITED METHOD SUMMARY =========== -->
152     <A NAME='functions_inherited'><!-- --></A>
153     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
154     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
155     <TD>
156     <span CLASS="font12bold">Inherited Method Summary</span>
157     <A HREF="#top" CLASS="links">^TOP</A>
158     </TD>
159     </TR>
160    
161     <!-- =========== Summary =========== -->
162     <TR BGCOLOR='white' CLASS='TableRowColor'>
163     <TD>
164     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
165     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
166     <tr CLASS="tableheadingcolor">
167     <th>Function</th>
168     <th>Description</th>
169     </tr>
170     <tr>
171     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>
172     <td CLASS="font10">The constructor</td>
173     <tr>
174     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>
175     <td CLASS="font10">This function creates element name</td>
176     <tr>
177     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>
178     <td CLASS="font10">return a single attribute</td>
179     <tr>
180     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>
181     <td CLASS="font10">This function builds and returns the form element object</td>
182     <tr>
183     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>
184     <td CLASS="font10">Returns the element name to be used in the form</td>
185     <tr>
186     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>
187     <td CLASS="font10">Returns the current error message if any</td>
188     <tr>
189     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>
190     <td CLASS="font10">This returns the initial value of the element</td>
191     <tr>
192     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>
193     <td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td>
194     <tr>
195     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>
196     <td CLASS="font10">This function will return the elements label text</td>
197     <tr>
198     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>
199     <td CLASS="font10">This function return the symbol used to denote a required field</td>
200     <tr>
201     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>
202     <td CLASS="font10">This function will return the elements value</td>
203     <tr>
204     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>
205     <td CLASS="font10">This provides a method</td>
206     <tr>
207     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>
208     <td CLASS="font10">Returns the current error state</td>
209     <tr>
210     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>
211     <td CLASS="font10">Returns the elements disabled state</td>
212     <tr>
213     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>
214     <td CLASS="font10">Returns whether this elements final value cannot be empty</td>
215     <tr>
216     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>
217     <td CLASS="font10">This function return the javaScript code for an onBlur event</td>
218     <tr>
219     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>
220     <td CLASS="font10">This function return the javaScript code for an onClick event</td>
221     <tr>
222     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>
223     <td CLASS="font10">This function return the javaScript code for an onFocus event</td>
224     <tr>
225     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>
226     <td CLASS="font10">This function return the javaScript code for an onSubmit event</td>
227     <tr>
228     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>
229     <td CLASS="font10">add a single attribute (name="value")</td>
230     <tr>
231     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>
232     <td CLASS="font10">Sets the disabled element flag</td>
233     <tr>
234     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>
235     <td CLASS="font10">Defines error message text and sets the error flag to true</td>
236     <tr>
237     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>
238     <td CLASS="font10">This function will set the label for the element</td>
239     <tr>
240     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>
241     <td CLASS="font10">This function set the elements required state</td>
242     <tr>
243     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>
244     <td CLASS="font10">Sets elements css attribute</td>
245     <tr>
246     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>
247     <td CLASS="font10">Sets elements title text</td>
248     <tr>
249     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>
250     <td CLASS="font10">This function will set the initial value for the element</td>
251     <tr>
252     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>
253     <td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td>
254     <tr>
255     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>
256     <td CLASS="font10">This function builds the element form attributes</td>
257     <tr>
258     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>
259     <td CLASS="font10">This function builds the complete javaScript events code for the element</td>
260     <tr>
261     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>
262     <td CLASS="font10">This function checks if the validation</td>
263     </table>
264     <br>
265     </TD>
266     </TR>
267     </TABLE>
268     <hr>
269     <!-- ============ VARIABLE DETAIL =========== -->
270    
271     <A NAME='variable_detail'></A>
272     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
273     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
274     <TD>
275     <span CLASS="font12bold">Variable Detail</span>
276     <A HREF="#top" CLASS="links">^TOP</A>
277     </TD>
278     </TR>
279     </TABLE>
280    
281     <hr>
282     <!-- ============ METHOD DETAIL =========== -->
283    
284     <A NAME='method_detail'></A>
285     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
286     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
287     <TD>
288     <span class="font12bold">Method Detail</span>
289     <A HREF="#top" CLASS="links">^TOP</A>
290     </TD>
291     </TR>
292     </TABLE>
293     <BR>
294     <DIV CLASS="function">
295     <A NAME='methodFEError'><!-- --></A>
296     <SPAN CLASS="font12bold">Constructor FEError</SPAN> (line <span class="linenumber">64</span>)
297     <BR>
298     <SPAN CLASS="font10bold">Usage : </SPAN>
299     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
300     <span class="font10bold" style="color: #0000FF">FEError(
301     string
302     $label, string
303     $message)</SPAN>
304     <BR>
305    
306     <BR>
307     <SPAN CLASS="font10bold">Description : </SPAN>
308     The constructor
309     <br />
310    
311     <DL>
312     <DT class="font10bold">Function Parameters:</DT>
313     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$label</SPAN></SPAN> the error label</DD>
314     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$message</SPAN></SPAN> the error message</DD>
315    
316     <DT class="font10bold">Function Info:</DT>
317     </DL>
318     </DIV>
319     <BR>
320     <div id="credit">
321     <hr>
322     Documention generated on Thu, 20 Feb 2003 16:23:04 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
323     </div>
324     </body>
325     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed