Docs For Class miBaseRadioWidget

Description

Radio buttons widget Use it with input type="radio"

This class supports a group of radio buttons

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

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

miWidget
   |
   --miBaseWidget
      |
      --miBaseRadioWidget

Direct descendents

Class	Description
miRadioWidget	Standard radio buttons widget Use it with input type="radio"

Variable Summary

mixed $_defaultRadioIndex

mixed $_radioButtons

Method Summary

void getControl ()

array getData ()

array getEditableControl ()

void getValue ()

void setRadioButtons (array $radioButtons, [string|int $defaultRadioIndex = null])

Variables

mixed $_defaultRadioIndex = null (line 182)

The index of the default radio button

access: protected

mixed $_radioButtons = array() (line 175)

Array with the radio buttons

access: protected

Inherited Variables

Inherited from miBaseWidget

miBaseWidget::$_fieldName

Inherited from miWidget

miWidget::$_properties
miWidget::$_webForm

Methods

getControl (line 210)

void getControl ()

Redefinition of:

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

getData (line 251)

Process the form submissions and returns the widget data

access: public

array getData ()

Redefinition of:

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

getEditableControl (line 235)

Returns the widget contents to be displayed

access: public

array getEditableControl ()

Redefinition of:

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

Redefined in descendants as:

miRadioWidget::getEditableControl() : Returns the widget contents to be displayed

getValue (line 216)

access: protected

void getValue ()

setRadioButtons (line 195)

Sets the radio buttons

The $radioButtons is an associative array where the key is used to separate the radio buttons within a group and the value is the display value of the radio button If $defaultRadioIndex is not set the first radio button is checked.

access: public

void setRadioButtons (array $radioButtons, [string|int $defaultRadioIndex = null])

array $radioButtons
string|int $defaultRadioIndex: the index of the default radio button (optional)

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