Docs For Class miWidget

Description

Base class form web form widget

One web form widget can handle single data item, or multiple data items

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

Direct descendents

Class	Description
miBaseWidget	Base class for the base widgets: text, checkbox, radio, select

Variable Summary

mixed $_properties

mixed $_webForm

Method Summary

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

array getControl ()

array getData ()

array getEditableControl ()

array getProperties ()

void setProperty (string $name, mixed $value)

void validateData (miWebFormErrorsHandler &$errors)

Variables

mixed $_properties (line 23)

Contains the form widget properties

access: protected

mixed $_webForm (line 18)

A reference to the web form that contains this widget

access: protected

Methods

Constructor __construct (line 32)

Construct miWidget object

access: public

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

miWebForm $webForm
array $properties: widget properties (optional)
miWebForm &$webForm

Redefined in descendants as:

miBaseCheckboxWidget::__construct()

getControl (line 66)

Returns array with template variables to be displayed for non-editable control

access: public

array getControl ()

Redefined in descendants as:

getData (line 88)

Process the form submissions and returns the data

access: public

array getData ()

Redefined in descendants as:

miBaseTextWidget::getData() : Process the form submissions and returns the text widget data
miBaseCheckboxWidget::getData() : Process the form submissions and returns the checkbox widget data
miBaseRadioWidget::getData() : Process the form submissions and returns the widget data
miBaseSelectWidget::getData() : Process the form submissions and returns the widget data

getEditableControl (line 77)

Returns array with template variables to be displayed for editable control

access: public

array getEditableControl ()

Redefined in descendants as:

miBaseTextWidget::getEditableControl() : Returns the text widget contents to be displayed
miTextWidget::getEditableControl() : Returns the text widget contents to be displayed
miBaseCheckboxWidget::getEditableControl() : Returns the checkbox widget contents to be displayed
miCheckboxWidget::getEditableControl() : Returns the checkbox widget contents to be displayed
miBaseRadioWidget::getEditableControl() : Returns the widget contents to be displayed
miRadioWidget::getEditableControl() : Returns the widget contents to be displayed
miBaseSelectWidget::getEditableControl() : Returns the widget contents to be displayed
miSelectWidget::getEditableControl() : Returns the widget contents to be displayed

getProperties (line 44)

Returns the widget properties

access: public

array getProperties ()

setProperty (line 55)

Sets a property value

access: public

void setProperty (string $name, mixed $value)

string $name
mixed $value

validateData (line 100)

Validates the submitted data for this widget Called upon form submission

access: public

void validateData (miWebFormErrorsHandler &$errors)

miWebFormErrorsHandler &$errors

Redefined in descendants as:

miBaseTextWidget::validateData() : Validates the text widget