Docs For Class miBaseCheckboxWidget

Description

Checkbox widget

Use it with input type="checkbox"

copyright: Copyright (c) 2006,2007 Mirchev Ideas Ltd. All rights reserved.

Located in /view/BaseWidgets.php (line 99)

miWidget
   |
   --miBaseWidget
      |
      --miBaseCheckboxWidget

Direct descendents

Class	Description
miCheckboxWidget	Standard checkbox widget

Class Constant Summary

VIEW_CHECKED = 'Yes'

VIEW_UNCHECKED = 'No'

Variable Summary

mixed $_defaultValue

Method Summary

void getControl ()

array getData ()

array getEditableControl ()

void getValue ()

void setDefaultValue (boolean $defaultValue)

miBaseCheckboxWidget __construct (miWebForm &$webForm, [ $properties = array()])

Variables

mixed $_defaultValue = false (line 103)

access: protected

Inherited Variables

Inherited from miBaseWidget

miBaseWidget::$_fieldName

Inherited from miWidget

miWidget::$_properties
miWidget::$_webForm

Methods

getControl (line 133)

void getControl ()

Redefinition of:

miWidget::getControl(): Returns array with template variables to be displayed for non-editable control

getData (line 153)

Process the form submissions and returns the checkbox widget data

array getData ()

Redefinition of:

miWidget::getData(): Process the form submissions and returns the data

getEditableControl (line 143)

Returns the checkbox widget contents to be displayed

array getEditableControl ()

Redefinition of:

miWidget::getEditableControl(): Returns array with template variables to be displayed for editable control

Redefined in descendants as:

miCheckboxWidget::getEditableControl() : Returns the checkbox widget contents to be displayed

getValue (line 122)

access: protected

void getValue ()

setDefaultValue (line 117)

Sets the default state of the checkbox

access: public

void setDefaultValue (boolean $defaultValue)

boolean $defaultValue

Constructor __construct (line 105)

access: public

miBaseCheckboxWidget __construct (miWebForm &$webForm, [ $properties = array()])

miWebForm &$webForm
$properties

Redefinition of:

miWidget::__construct(): Construct miWidget object

Inherited Methods

Inherited From miBaseWidget

miBaseWidget::getFieldName()
miBaseWidget::setFieldName()

Inherited From miWidget

miWidget::__construct()
miWidget::getControl()
miWidget::getData()
miWidget::getEditableControl()
miWidget::getProperties()
miWidget::setProperty()
miWidget::validateData()

Class Constants

VIEW_CHECKED = 'Yes' (line 100)

VIEW_UNCHECKED = 'No' (line 101)