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

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FEPassword.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by jonen, Sat Feb 22 21:05:28 2003 UTC revision 1.2 by jonen, Sat Sep 20 00:36:44 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:44 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class FEPassword</TITLE>                          <title>Docs For Class FEPassword</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>                          <link rel="stylesheet" href="../../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10  <!-- Links -->                  <body>
11  <a NAME="top"></A>                          <div class="page-body">                
12  <table WIDTH="100%" class="links">  <h2 class="class-name">Class FEPassword</h2>
13   <TR>  
14     <TD class="font10">  <a name="sec-description"></a>
15        Links:  <div class="info-box">
16        <A HREF="#children_summary" class="links" title="Classes extended from FEPassword">Child Classes</A>          <div class="info-box-title">Description</div>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>          <div class="nav-bar">
18        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>                                                          <a href="#sec-descendents">Descendents</a>
20        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>                          |                                                                                       <a href="#sec-vars">Vars</a>
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>                                                  
23     </TD>                          </div>
24   </TR>          <div class="info-box-body">
25  </TABLE>                  <!-- ========== Info from phpDoc block ========= -->
26  <BR>  <p class="short-description">This is the Password FormElement which builds a  input field of type=&quot;password&quot;.  It validates  the data as is_password().</p>
27  <!-- Start of Class Data -->  <p class="description"><p>NOTE: this is used in conjunction with the        FEConfirmPassword object to ensure the        user's input is what they wanted.</p></p>
28  <H2>          <ul class="tags">
29          Class FEPassword                                  <li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li>
30  </H2> (line <span class="linenumber">33</span>)                                  <li><span class="field">author:</span> <p>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</p></li>
31  <pre>                                  <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
32  <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>                          </ul>
33                    <p class="notes">
34                            Located in <a class="field" href="_form_form_elements_FEPassword_inc.html">Program_Root/form/form_elements/FEPassword.inc</a> (line <span class="field">33</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>     --<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a>
41        |        |
42        --FEPassword</pre>        --FEPassword</pre>
43  <SPAN class="type">Classes extended from FEPassword:</SPAN>          
44                  <dl>                          </div>
45          <dt><a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html">FEConfirmPassword</a></dt>  </div>
46                  <dd>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.</dd>  
47          </dl>          <a name="sec-descendents"></a>
48          </p>          <div class="info-box">
49  <p>                  <div class="info-box-title">Direct descendents</div>
50          <b><i>Located in File: Program_Root/form/form_elements/FEPassword.inc</i></b><br>                  <div class="nav-bar">
51  </p>                          <a href="#sec-description">Description</a> |
52  <hr>                          <span class="disabled">Descendents</span>
53  This is the Password FormElement which builds a  input field of type="password".  It validates  the data as is_password().                          |                                                                                               <a href="#sec-vars">Vars</a>
54  <br />                                                                  |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
55  <p>NOTE: this is used in conjunction with the        FEConfirmPassword object to ensure the        user's input is what they wanted.</p>                                                          
56  <UL>                                          </div>
57                  <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>                  <div class="info-box-body">
58                  <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>                          <table cellpadding="2" cellspacing="0" class="class-table">
59                  <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>                                  <tr>
60          </UL>                                          <th class="class-table-header">Class</th>
61  <hr>                                          <th class="class-table-header">Description</th>
 <!-- =========== VAR SUMMARY =========== -->  
 <A NAME='var_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
 <hr>  
 <!-- =========== VAR INHERITED SUMMARY =========== -->  
 <A NAME='var_inherited_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>  
             <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                         <tr CLASS="tableheadingcolor">  
                                 <th>Variable</th>  
                                 <th>Default Value</th>  
                                 <th>Description</th>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>  
                                 <td CLASS="font10">Holds additional attributes for</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the name of the element</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the error message text</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>  
                                 <td CLASS="font10">Holds the state of the last validation</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>  
                                 <td CLASS="font10">Indicates a disabled element</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>  
                                 <td CLASS="font10">Indicates whether this elements</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the elements label text</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>  
                                 <td CLASS="font10">Holds additional style attributes for</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the elements initial value</td>  
                         </tr>  
                                                         </table>  
             <BR>  
         </TD>  
         </TR>  
         </TABLE>  
   
 <hr>  
 <!-- =========== METHOD SUMMARY =========== -->  
 <A NAME='method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element'>object get_element (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function builds and returns the  form element object </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEPassword.html#methodvalidate'>void validate (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function performs the actual validation  It is called only if the validation is required by  this element </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
62                                  </tr>                                  </tr>
63                                                                  <tr>                                                                  <tr>
64                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html">FEConfirmPassword</a></td>
65                                          <td CLASS="font10">The constructor</td>                                          <td>
66                                                                  <tr>                                                                                          This is the ConfirmPassword FormElement which builds a  input field of type=&quot;password&quot;.  It requires the caller  to add a FEPassword object to this class to have something  to compare during validation time.
67                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></td>                                                                                  </td>
                                         <td CLASS="font10">This function builds and returns the  form element object</td>  
                                                         </table>  
             <br>                          
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
68                                  </tr>                                  </tr>
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>  
                                         <td CLASS="font10">The constructor</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>  
                                         <td CLASS="font10">This function creates element name</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>  
                                         <td CLASS="font10">return a single attribute</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>  
                                         <td CLASS="font10">This function builds and returns the  form element object</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>  
                                         <td CLASS="font10">Returns the element name  to be used in the form</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>  
                                         <td CLASS="font10">Returns the current error message  if any</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>  
                                         <td CLASS="font10">This returns the initial value of  the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>  
                                         <td CLASS="font10">This function builds and returns a  label object based on the label text  and error conditions</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>  
                                         <td CLASS="font10">This function will return the  elements label text</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>  
                                         <td CLASS="font10">This function return the symbol used to  denote a required field</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>  
                                         <td CLASS="font10">This function will return the  elements value</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>  
                                         <td CLASS="font10">This provides a method</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>  
                                         <td CLASS="font10">Returns the current error state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>  
                                         <td CLASS="font10">Returns the elements disabled  state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>  
                                         <td CLASS="font10">Returns whether this elements  final value cannot be empty</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onBlur event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onClick event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onFocus event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onSubmit event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>  
                                         <td CLASS="font10">add a single attribute (name="value")</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>  
                                         <td CLASS="font10">Sets the disabled element flag</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>  
                                         <td CLASS="font10">Defines error message text and  sets the error flag to true</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>  
                                         <td CLASS="font10">This function will set the  label for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>  
                                         <td CLASS="font10">This function set the elements  required state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>  
                                         <td CLASS="font10">Sets elements css attribute</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>  
                                         <td CLASS="font10">Sets elements title text</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>  
                                         <td CLASS="font10">This function will set the  initial value for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>  
                                         <td CLASS="font10">This function performs the actual validation  It is called only if the validation is required by  this element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>  
                                         <td CLASS="font10">This function builds the element form attributes</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>  
                                         <td CLASS="font10">This function builds the complete javaScript events code  for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>  
                                         <td CLASS="font10">This function checks if the validation</td>  
69                                                          </table>                                                          </table>
70              <br>                                          </div>
71                  </TD>          </div>
         </TR>  
         </TABLE>  
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
 <hr>  
 <!-- ============ METHOD DETAIL =========== -->  
   
 <A NAME='method_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_element'><!-- --></A>  
 <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">41</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_element(  
 )</SPAN>  
 <BR>  
   
 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a> This function builds and returns the  form element object  
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function builds and returns the  form element object  
 <br />  
72    
 <DL>  
73    
74          <DT class="font10bold">Function Info:</DT>          <a name="sec-method-summary"></a>
75          </DL>          <div class="info-box">
76  </DIV>                  <div class="info-box-title">Method Summary</span></div>
77  <BR>                  <div class="nav-bar">
78  <DIV CLASS="function">                          <a href="#sec-description">Description</a> |
79  <A NAME='methodvalidate'><!-- --></A>                                                          <a href="#sec-descendents">Descendents</a> |
80  <SPAN CLASS="font12bold">validate</SPAN> (line <span class="linenumber">59</span>)                                                                                                                          <a href="#sec-vars">Vars</a>
81  <BR>                                  
82  <SPAN CLASS="font10bold">Usage : </SPAN>                                  |
83  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
84  <span class="font10bold" style="color: #0000FF">validate(                  </div>
85  )</SPAN>                  <div class="info-box-body">                    
86  <BR>                          <div class="method-summary">
87          <p>Overridden in child classes as:<br />                                                                  
88                                    <div class="method-definition">
89                                                                                            <span class="method-result">object</span>
90                                                                                    <a href="#get_element" title="details" class="method-name">get_element</a>
91                                                                                    ()
92                                                                            </div>
93                                                                    
94                                    <div class="method-definition">
95                                                                                            <span class="method-result">void</span>
96                                                                                    <a href="#validate" title="details" class="method-name">validate</a>
97                                                                                            (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
98                                                                            </div>
99                                                            </div>
100                    </div>
101            </div>          
102    
103            <a name="sec-vars"></a>
104            <div class="info-box">
105                    <div class="info-box-title">Variables</div>
106                    <div class="nav-bar">
107                            <a href="#sec-description">Description</a> |
108                                                            <a href="#sec-descendents">Descendents</a> |
109                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
110                                                    
111                            
112                                                            |
113                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
114                                                            
115                                            </div>
116                    <div class="info-box-body">
117                                                                                    <h4>Inherited Variables</h4>
118                                    <A NAME='inherited_vars'><!-- --></A>
119                                                                            <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
120                                            <blockquote>
121                                                                                                            <span class="var-title">
122                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
123                                                            </span>
124                                                                                                            <span class="var-title">
125                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
126                                                            </span>
127                                                                                                            <span class="var-title">
128                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
129                                                            </span>
130                                                                                                            <span class="var-title">
131                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
132                                                            </span>
133                                                                                                            <span class="var-title">
134                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
135                                                            </span>
136                                                                                                            <span class="var-title">
137                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
138                                                            </span>
139                                                                                                            <span class="var-title">
140                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
141                                                            </span>
142                                                                                                            <span class="var-title">
143                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
144                                                            </span>
145                                                                                                            <span class="var-title">
146                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
147                                                            </span>
148                                                                                                            <span class="var-title">
149                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
150                                                            </span>
151                                                                                                            <span class="var-title">
152                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
153                                                            </span>
154                                                                                                            <span class="var-title">
155                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
156                                                            </span>
157                                                                                            </blockquote>
158                                                                                    
159                    </div>
160            </div>
161            
162            <a name="sec-methods"></a>
163            <div class="info-box">
164                    <div class="info-box-title">Methods</div>
165                    <div class="nav-bar">
166                            <a href="#sec-description">Description</a> |
167                                                            <a href="#sec-descendents">Descendents</a> |
168                                                                                                                            <a href="#sec-vars">Vars</a>
169                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
170                                                    
171                    </div>
172                    <div class="info-box-body">
173                            <A NAME='method_detail'></A>
174    <a name="methodget_element" id="get_element"><!-- --></a>
175    <div class="oddrow">
176            
177            <div class="method-header">
178                    <span class="method-title">get_element</span> (line <span class="line-number">41</span>)
179            </div>
180            
181            <!-- ========== Info from phpDoc block ========= -->
182    <p class="short-description">This function builds and returns the  form element object</p>
183            
184            <div class="method-signature">
185                    <span class="method-result">object</span>
186                    <span class="method-name">
187                            get_element
188                    </span>
189                                    ()
190                            </div>
191            
192                    
193                            <hr class="separator" />
194                    <div class="notes">Redefinition of:</div>
195                  <dl>                  <dl>
196          <dt><a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html#methodvalidate">FEConfirmPassword::validate()</a></dt>                          <dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt>
197                  <dd>This function performs the actual validation  It is called only if the validation is required by  this element</dd>                                                  <dd>This function builds and returns the  form element object</dd>
198          </dl>                                          </dl>
199          </p>                  
200            </div>
201  <BR>  <a name="methodvalidate" id="validate"><!-- --></a>
202  <SPAN CLASS="font10bold">Description : </SPAN>  <div class="evenrow">
203  This function performs the actual validation  It is called only if the validation is required by  this element          
204  <br />          <div class="method-header">
205  <p>This function is responsible for performing complete  validation and setting the appropriate error message  in case of a failed validation</p>                  <span class="method-title">validate</span> (line <span class="line-number">60</span>)
206  <DL>          </div>
207            
208          <DT class="font10bold">Function Info:</DT>          <!-- ========== Info from phpDoc block ========= -->
209          </DL>  <p class="short-description">This function performs the actual validation  It is called only if the validation is required by  this element</p>
210  </DIV>  <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>
211  <BR>          
212          <div id="credit">          <div class="method-signature">
213                  <hr>                  <span class="method-result">void</span>
214                  Documention generated on Thu, 20 Feb 2003 16:22:44 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>                  <span class="method-name">
215                            validate
216                    </span>
217                                            (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
218                            </div>
219            
220                            <ul class="parameters">
221                                            <li>
222                                    <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
223                                    <span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object</p></span>                     </li>
224                                    </ul>
225                    
226                            <hr class="separator" />
227                    <div class="notes">Redefinition of:</div>
228                    <dl>
229                            <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
230                                                    <dd>This function performs the actual validation  It is called only if the validation is required by  this element</dd>
231                                            </dl>
232                    
233                            <hr class="separator" />
234                    <div class="notes">Redefined in descendants as:</div>
235                    <ul class="redefinitions">
236                                            <li>
237                                    <a href="../../phpHtmlLib/FormProcessing/FEConfirmPassword.html#methodvalidate">FEConfirmPassword::validate()</a>
238                                                                    : This function performs the actual validation  It is called only if the validation is required by  this element
239                                                            </li>
240                                    </ul>
241            </div>
242                                                            <h4>Inherited Methods</h4>
243                                    <a name='inherited_methods'><!-- --></a>        
244                                                                            <!-- =========== Summary =========== -->
245                                            <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p>
246                                            <blockquote>
247                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br>
248                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br>
249                                                                                            </blockquote>
250                                                                            <!-- =========== Summary =========== -->
251                                            <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
252                                            <blockquote>
253                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
254                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
255                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
256                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
257                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
258                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
259                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
260                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
261                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
262                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
263                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
264                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
265                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
266                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
267                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
268                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
269                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
270                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
271                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
272                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
273                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
274                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
275                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
276                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
277                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
278                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
279                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
280                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
281                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
282                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
283                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
284                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
285                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
286                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
287                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
288                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
289                                                                                            </blockquote>
290                                                                                    
291                    </div>
292          </div>          </div>
293  </body>          
294            <p class="notes" id="credit">
295                    Documention generated on Thu, 31 Jul 2003 18:32:34 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
296            </p>
297            </div></body>
298  </html>  </html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed