Docs For Class FENumberInRange

Description

This is the Number Range FormElement which builds a text input field.

It validates as is_within_rage().

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

Located in /form/form_elements/FENumbers.inc (line 126)

FormElement
   |
   --FEText
      |
      --FENumberInRange

Variable Summary

mixed $_label_flag

mixed $_max

mixed $_min

mixed $_range_text

Method Summary

FENumberInRange FENumberInRange (label $label, [bool $required = TRUE], [int $width = NULL], [int $maxlength = NULL], [int $min = 0], [int $max = 100], [boolean $label_flag = TRUE])

object SPANtag get_label ([FormContent $form_content = NULL], [string $label = ''], [ $indent_flag = TRUE])

string get_range_string ([ $include_range = TRUE])

void validate (FormValidation &$_FormValidation)

Variables

mixed $_label_flag = TRUE (line 140)

Add the range to the label automatically?

mixed $_max = 100 (line 135)

The maximum #

mixed $_min = 0 (line 131)

The minimum #

mixed $_range_text = "Range" (line 145)

The 'Range' text

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

Constructor FENumberInRange (line 159)

The constructor

FENumberInRange FENumberInRange (label $label, [bool $required = TRUE], [int $width = NULL], [int $maxlength = NULL], [int $min = 0], [int $max = 100], [boolean $label_flag = TRUE])

label $label: string - text label for the element
bool $required: required - is this a required element
int $width: required - element width in characters, pixels (px), percentage (%) or elements (em)
int $maxlength: maximum number of chars allowed to type in the field
int $min: the minimum value allowable
int $max: the maximum value allowable
boolean $label_flag: - add the range to the label automatically?

get_label (line 179)

This function builds and returns a label object based on the label text and error conditions

object SPANtag get_label ([FormContent $form_content = NULL], [string $label = ''], [ $indent_flag = TRUE])

FormContent $form_content: object that holds the required field marker
string $label: this string allows us to use this method and wrap any string as a FormElement label.
$indent_flag

Redefinition of:

FormElement::get_label(): This function builds and returns a label object based on the label text and error conditions

get_range_string (line 218)

This function builds a string for the range display

string get_range_string ([ $include_range = TRUE])

$include_range

validate (line 235)

This method validates the data for this Form Element.

It validates as is_price().

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

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()