base_setting_ui Class Reference

Inheritance diagram for base_setting_ui:

Public Member Functions
	__construct (base_setting $setting)
	destroy ()
	get_name ()
	get_label ()
	get_type ()
	get_attributes ()
	get_value ()
	get_static_value ()
	set_label ($label)
	disable ()
	set_icon (pix_icon $icon)
	get_icon ()
Data Fields
const	NAME_PREFIX = 'setting_'
Protected Attributes
	$name
	$label
	$attributes = array()
	$type
	$icon = false
	$setting

---

Detailed Description

Abstract class used to represent the user interface that a setting has.

Todo:

extend as required for restore

Copyright:

2010 Sam Hemelryk http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 34 of file backup_ui_setting.class.php.

---

Constructor & Destructor Documentation

__construct

(

base_setting $

setting

)

Constructors are sooooo cool

Parameters:

base_setting

$setting

Definition at line 73 of file backup_ui_setting.class.php.

---

Member Function Documentation

destroy

(

)

Destroy all circular references. It helps PHP 5.2 a lot!

Definition at line 80 of file backup_ui_setting.class.php.

disable

(

)

Disables the UI for this element

Definition at line 140 of file backup_ui_setting.class.php.

get_attributes

(

)

Gets the HTML attributes for this item

Returns:

array

Definition at line 110 of file backup_ui_setting.class.php.

get_icon

(

)

Returns the icon to display next to this item, or false if there isn't one.

Returns:

pix_icon|false

Definition at line 158 of file backup_ui_setting.class.php.

Here is the caller graph for this function:

get_label

(

)

Gets the name of this item including its prefix

Returns:

string

Definition at line 96 of file backup_ui_setting.class.php.

Here is the caller graph for this function:

get_name

(

)

Gets the name of this item including its prefix

Returns:

string

Definition at line 89 of file backup_ui_setting.class.php.

get_static_value

(

)

Gets the value to display in a static quickforms element

Returns:

mixed

Reimplemented in backup_setting_ui_dateselector, backup_setting_ui_select, backup_setting_ui_radio, and backup_setting_ui_checkbox.

Definition at line 124 of file backup_ui_setting.class.php.

get_type

(

)

Gets the type of this element

Returns:

int

Definition at line 103 of file backup_ui_setting.class.php.

get_value

(

)

Gets the value of this setting

Returns:

mixed

Definition at line 117 of file backup_ui_setting.class.php.

Here is the caller graph for this function:

set_icon

(

pix_icon $

icon

)

Sets the icon to display next to this item

Parameters:

pix_icon

$icon

Definition at line 149 of file backup_ui_setting.class.php.

set_label

(

$

label

)

Sets the label

Parameters:

string

$label

Definition at line 131 of file backup_ui_setting.class.php.

Here is the call graph for this function:

---

Field Documentation

$attributes = array() [protected]

Definition at line 53 of file backup_ui_setting.class.php.

$icon = false [protected]

Definition at line 63 of file backup_ui_setting.class.php.

$label [protected]

Definition at line 48 of file backup_ui_setting.class.php.

$name [protected]

Definition at line 43 of file backup_ui_setting.class.php.

$setting [protected]

Definition at line 68 of file backup_ui_setting.class.php.

$type [protected]

Reimplemented in backup_setting_ui_select, backup_setting_ui_radio, backup_setting_ui_checkbox, and backup_setting_ui_text.

Definition at line 58 of file backup_ui_setting.class.php.

const NAME_PREFIX = 'setting_'

Prefix applied to all inputs/selects

Definition at line 38 of file backup_ui_setting.class.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/backup/util/ui/backup_ui_setting.class.php