backup_setting_ui_checkbox Class Reference

Inheritance diagram for backup_setting_ui_checkbox:

Collaboration diagram for backup_setting_ui_checkbox:

Public Member Functions
	__construct (backup_setting $setting, $label=null, $text=null, array $attributes=array(), array $options=array())
	get_element_properties (base_task $task=null, renderer_base $output=null)
	set_text ($text)
	get_static_value ()
	is_changeable ()
	set_changeable ($newvalue)
Protected Attributes
	$type = backup_setting::UI_HTML_CHECKBOX
	$changeable = true
	$text

---

Detailed Description

A checkbox user interface element for backup settings (default)

Copyright:

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

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

---

Constructor & Destructor Documentation

__construct	(	backup_setting $	setting,
		$	label = null,
		$	text = null,
		array $	attributes = array(),
		array $	options = array()
	)

Overridden constructor so we can take text argument

Parameters:

backup_setting	$setting
string	$label
string	$text
array	$attributes
array	$options

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

---

Member Function Documentation

get_element_properties	(	base_task $	task = null,
		renderer_base $	output = null
	)

Returns an array of properties suitable for generating a quickforms element

Parameters:

backup_task | null

$task

Returns:

array (element, name, label, text, attributes);

Reimplemented from backup_setting_ui.

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

Here is the call graph for this function:

get_static_value

(

)

Gets the static value for the element core_renderer $OUTPUT

Returns:

string

Reimplemented from base_setting_ui.

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

Here is the call graph for this function:

is_changeable

(

)

Returns true if the setting is changeable

Returns:

bool

Reimplemented from backup_setting_ui.

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

set_changeable

(

$

newvalue

)

Sets whether the setting is changeable, Note dependencies can still mark this setting changeable or not

Parameters:

bool

$newvalue

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

set_text

(

$

text

)

Sets the text for the element

Parameters:

string

$text

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

---

Field Documentation

$changeable = true [protected]

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

$text [protected]

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

$type = backup_setting::UI_HTML_CHECKBOX [protected]

Reimplemented from base_setting_ui.

Definition at line 350 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