backup_setting_ui Class Reference

Inheritance diagram for backup_setting_ui:

Collaboration diagram for backup_setting_ui:

Public Member Functions
	__construct (backup_setting $setting, $label=null, array $attributes=null, array $options=null)
	get_element_properties (base_task $task=null, renderer_base $output=null)
	apply_options (array $properties)
	get_label (base_task $task=null)
	is_changeable ()
Static Public Member Functions
static	make (backup_setting $setting, $type, $label, array $attributes=null, array $options=null)
Protected Attributes
	$options = array()

---

Detailed Description

Abstract class to represent the user interface backup settings have

Copyright:

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

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

---

Constructor & Destructor Documentation

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

JAC... Just Another Constructor

Parameters:

backup_setting	$setting
string | null	$label	The label to display with the setting ui
array | null	$attributes	Array of HTML attributes to apply to the element
array | null	$options	Array of options to apply to the setting ui object

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

Here is the call graph for this function:

---

Member Function Documentation

apply_options

(

array $

properties

)

Applies config options to a given properties array and then returns it

Parameters:

array

$properties

Returns:

array

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

Here is the caller graph for this function:

get_element_properties	(	base_task $	task = null,
		renderer_base $	output = null
	)		[abstract]

Get element properties that can be used to make a quickform element

Returns:

array

Reimplemented in backup_setting_ui_dateselector, backup_setting_ui_select, backup_setting_ui_radio, backup_setting_ui_checkbox, and backup_setting_ui_text.

get_label

(

base_task $

task = null

)

Gets the label for this item

Parameters:

backup_task | null

$task

Optional, if provided and the setting is an include $task is used to set the setting label

Returns:

string

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

is_changeable

(

)

Returns true if the setting is changeable.

A setting is changeable if it meets either of the two following conditions.

1. The setting is not locked 2. The setting is locked but only by settings that are of the same level (same page)

Condition 2 is really why we have this function

Returns:

bool

Reimplemented in backup_setting_ui_select, and backup_setting_ui_checkbox.

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

static make	(	backup_setting $	setting,
		$	type,
		$	label,
		array $	attributes = null,
		array $	options = null
	)		[static, final]

Creates a new backup setting ui based on the setting it is given

Throws an exception if an invalid type is provided.

Parameters:

backup_setting	$setting
int	$type	The backup_setting UI type. One of backup_setting::UI_*;
string	$label	The label to display with the setting ui
array	$attributes	Array of HTML attributes to apply to the element
array	$options	Array of options to apply to the setting ui object

Returns:

backup_setting_ui_text|backup_setting_ui_checkbox|backup_setting_ui_select|backup_setting_ui_radio

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

Here is the caller graph for this function:

---

Field Documentation

$options = array() [protected]

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