Docs For Class FEPassword

## Class FEPassword

Description

This is the Password FormElement which builds a input field of type="password". It validates the data as is_password().

NOTE: this is used in conjunction with the FEConfirmPassword object to ensure the user's input is what they wanted.

- copyright: LGPL - See LICENCE
- author: Walter A. Boring IV <waboring@newsblob.com>
- author: Suren Markossian <suren@bcsweb.com>

Located in /form/form_elements/FEPassword.inc (line 33)

    FormElement
       |
       --FEText
          |
          --FEPassword

Direct descendents

Class | Description
--- | ---
FEConfirmPassword | 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.

Method Summary
object get_element ()
string get_value_text ()
void validate (FormValidation &$_FormValidation)
Variables

#### Inherited Variables

Inherited from FormElement

> FormElement::$onBlurJS
> FormElement::$onChangeJS
> FormElement::$onClickJS
> FormElement::$onFocusJS
> FormElement::$onSubmitJS
> FormElement::$_attributes
> FormElement::$_element_name
> FormElement::$_errors
> FormElement::$_error_message
> FormElement::$_form_name
> FormElement::$_has_error
> FormElement::$_has_form_on_submit
> FormElement::$_is_disabled
> FormElement::$_is_readonly
> FormElement::$_is_required
> FormElement::$_label_colon_flag
> FormElement::$_label_text
> FormElement::$_required_field_marker
> FormElement::$_slave_elements
> FormElement::$_stripslashes
> FormElement::$_style_attributes
> FormElement::$_validation_enabled
> FormElement::$_value

Methods
get_element (line 41)

This function builds and returns the form element object

object get_element ()

Redefinition of:

FEText::get_element()
  This function builds and returns the form element object

get_value_text (line 55)

return a string to the user for the confirmation page

string get_value_text ()

Redefinition of:

FormElement::get_value_text()
  This provides a method

validate (line 71)

This function performs the actual validation It is called only if the validation is required by this element

This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation

void validate (FormValidation &$_FormValidation)

- FormValidation &$_FormValidation: object

Redefinition of:

FormElement::validate()
  This function performs the actual validation It is called only if the validation is required by this element

Redefined in descendants as:

- FEConfirmPassword::validate() : This function performs the actual validation It is called only if the validation is required by this element

#### Inherited Methods

Inherited From FEText

> FEText::FEText()
> FEText::get_element()

Inherited From FormElement

> FormElement::FormElement()
> FormElement::build_id_name()
> FormElement::create_element_name()
> FormElement::enable_validation()
> FormElement::form_tag_onsubmit()
> FormElement::get_attribute()
> FormElement::get_confirm_element()
> FormElement::get_element()
> FormElement::get_element_name()
> FormElement::get_errors()
> FormElement::get_error_message()
> FormElement::get_form_element()
> FormElement::get_init_value()
> FormElement::get_label()
> FormElement::get_label_text()
> FormElement::get_required_symbol()
> FormElement::get_slave_elements()
> FormElement::get_tabindex()
> FormElement::get_value()
> FormElement::get_value_text()
> FormElement::has_error()
> FormElement::is_disabled()
> FormElement::is_readonly()
> FormElement::is_required()
> FormElement::javascript()
> FormElement::onBlur()
> FormElement::onChange()
> FormElement::onClick()
> FormElement::onFocus()
> FormElement::onSubmit()
> FormElement::set_attribute()
> FormElement::set_colon_flag()
> FormElement::set_data_all_slaves()
> FormElement::set_disabled()
> FormElement::set_element_name()
> FormElement::set_error_message()
> FormElement::set_form_name()
> FormElement::set_label_text()
> FormElement::set_onBlur()
> FormElement::set_onChange()
> FormElement::set_onClick()
> FormElement::set_onFocus()
> FormElement::set_onSubmit()
> FormElement::set_readonly()
> FormElement::set_required()
> FormElement::set_required_symbol()
> FormElement::set_slave_data()
> FormElement::set_slave_elements()
> FormElement::set_stripslashes()
> FormElement::set_style_attribute()
> FormElement::set_tabindex()
> FormElement::set_title()
> FormElement::set_value()
> FormElement::validate()
> FormElement::_build_element_attributes()
> FormElement::_build_javascript()
> FormElement::_do_validation()
> FormElement::_sanitize_string()

Documentation generated on Thu, 1 Sep 2005 17:05:50 -0700 by phpDocumentor 1.3.0RC3