Abstract class used to represent the user interface that a setting has.
More...
|
| __construct (base_setting $setting) |
| Constructors are sooooo cool.
|
|
| destroy () |
| Destroy all circular references.
|
|
| disable () |
| Disables the UI for this element.
|
|
| get_attributes () |
| Gets the HTML attributes for this item.
|
|
| get_icon () |
| Returns the icon to display next to this item, or false if there isn't one.
|
|
| get_label () |
| Gets the name of this item including its prefix.
|
|
| get_name () |
| Gets the name of this item including its prefix.
|
|
| get_param_validation () |
| Gets the the PARAM_XXXX validation to be applied to the setting.
|
|
| get_static_value () |
| Gets the value to display in a static quickforms element.
|
|
| get_type () |
| Gets the type of this element.
|
|
| get_value () |
| Gets the value of this setting.
|
|
| set_icon (pix_icon $icon) |
| Sets the icon to display next to this item.
|
|
| set_label (string $label) |
| Sets the label.
|
|
|
const | NAME_PREFIX = 'setting_' |
| Prefix applied to all inputs/selects.
|
|
|
array | $attributes = array() |
| An array of HTML attributes to apply to this setting.
|
|
pix_icon | $icon = false |
| An icon to display next to this setting in the UI.
|
|
string | $label |
| The label for the setting.
|
|
string | $name |
| The name of the setting.
|
|
base_setting backup_setting | $setting |
| The setting this UI belongs to (parent reference)
|
|
int | $type |
| The backup_setting UI type this relates to.
|
|
Abstract class used to represent the user interface that a setting has.
- Todo
- extend as required for restore
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
Constructors are sooooo cool.
- Parameters
-
◆ destroy()
base_setting_ui::destroy |
( |
| ) |
|
Destroy all circular references.
It helps PHP 5.2 a lot!
◆ get_attributes()
base_setting_ui::get_attributes |
( |
| ) |
|
Gets the HTML attributes for this item.
- Return values
-
◆ get_icon()
base_setting_ui::get_icon |
( |
| ) |
|
Returns the icon to display next to this item, or false if there isn't one.
- Return values
-
◆ get_label()
base_setting_ui::get_label |
( |
| ) |
|
Gets the name of this item including its prefix.
- Return values
-
◆ get_name()
base_setting_ui::get_name |
( |
| ) |
|
Gets the name of this item including its prefix.
- Return values
-
◆ get_param_validation()
base_setting_ui::get_param_validation |
( |
| ) |
|
Gets the the PARAM_XXXX validation to be applied to the setting.
return string The PARAM_XXXX constant of null if the setting type is not defined
◆ get_static_value()
base_setting_ui::get_static_value |
( |
| ) |
|
◆ get_type()
base_setting_ui::get_type |
( |
| ) |
|
Gets the type of this element.
- Return values
-
◆ get_value()
base_setting_ui::get_value |
( |
| ) |
|
Gets the value of this setting.
- Return values
-
◆ set_icon()
base_setting_ui::set_icon |
( |
pix_icon | $icon | ) |
|
Sets the icon to display next to this item.
- Parameters
-
◆ set_label()
base_setting_ui::set_label |
( |
string | $label | ) |
|
Sets the label.
- Exceptions
-
- Parameters
-
◆ $type
int base_setting_ui::$type |
|
protected |
The backup_setting UI type this relates to.
One of backup_setting\UI_*;
The documentation for this class was generated from the following file:
- backup/util/ui/backup_ui_setting.class.php