Docs For Class input

Description

Input checkbox class.

Located in /input.checkbox.php (line 25)

input_base
   |
   --input_form_element
      |
      --input_checkbox

Variable Summary

bool $checked

Method Summary

input_checkbox input_checkbox (string $name, object &$form, [bool $checked = FALSE], [string $caption = NULL])

void display ([string $class = NULL], [string $javascript = NULL])

void reset ()

bool set (bool $value)

Variables

bool $checked (line 31)

Whether the checkbox is checked.

input_form_element::$caption
input_form_element::$form

Inherited from input_base

input_base::$default
input_base::$name
input_base::$regex
input_base::$required
input_base::$value
input_base::$wasSet
input_base::$wasValid

Methods

Constructor input_checkbox (line 41)

Constructs a new checkbox object.

input_checkbox input_checkbox (string $name, object &$form, [bool $checked = FALSE], [string $caption = NULL])

display (line 109)

Display the checkbox.

If the value was not valid, the CSS class is set/changed to 'error'.

uses: input_form_element::_get_error_css() - to get/modify the specified CSS class

void display ([string $class = NULL], [string $javascript = NULL])

reset (line 67)

Reset checkbox value to default

void reset ()

Redefinition of:

set (line 80)

Sets the value of the checkbox.

bool set (bool $value)

Redefinition of:

input_base::set(): Sets the value of the object to the specified value if that value is valid according to regex given to constructor.

input_form_element::input_form_element()
input_form_element::_get_error_css()

Inherited From input_base

input_base::input_base()
input_base::reset()
input_base::set()