backup_setting_ui_select Class Reference

A select box, drop down user interface for backup settings. More...

Inheritance diagram for backup_setting_ui_select:

Public Member Functions
	__construct (backup_setting $setting, $label=null, $values=null, array $attributes=array(), array $options=array())
	Constructor.
	apply_options (array $properties)
	Applies config options to a given properties array and then returns it.
	destroy ()
	Destroy all circular references.
	disable ()
	Disables the UI for this element.
	get_attributes ()
	Gets the HTML attributes for this item.
	get_element_properties (base_task $task=null, renderer_base $output=null)
	Returns an array of properties suitable for generating a quickforms element.
	get_icon ()
	Returns the icon to display next to this item, or false if there isn't one.
	get_label (base_task $task=null)
	Gets the label for this item.
	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 static value for this select element.
	get_type ()
	Gets the type of this element.
	get_value ()
	Gets the value of this setting.
	get_values ()
	Returns the list of available values.
	is_changeable ($level=null)
	Returns true if the setting is changeable, false otherwise.
	set_icon (pix_icon $icon)
	Sets the icon to display next to this item.
	set_label (string $label)
	Sets the label.
	set_values (array $values)
	Sets the options for the select box.

Static Public Member Functions
static	make (backup_setting $setting, $type, $label, array $attributes=null, array $options=null)
	Creates a new backup setting ui based on the setting it is given.

Public Attributes
const	NAME_PREFIX = 'setting_'
	Prefix applied to all inputs/selects.

Protected Attributes
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.
array	$options = array()
	An array of options relating to this setting.
base_setting backup_setting	$setting
	The setting this UI belongs to (parent reference)
int	$type = backup_setting::UI_HTML_DROPDOWN
array	$values
	An array of options to display in the select.

Detailed Description

A select box, drop down user interface for backup settings.

Copyright

2010 Sam Hemelryk

License

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

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

Member Function Documentation

apply_options()

backup_setting_ui::apply_options ( array $properties )

inherited

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

Parameters

array

$properties

Return values

array

destroy()

base_setting_ui::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

get_attributes()

base_setting_ui::get_attributes ( )

inherited

Gets the HTML attributes for this item.

Return values

array

get_element_properties()

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

Returns an array of properties suitable for generating a quickforms element.

Parameters

base_task	$task
renderer_base	$output

Return values

array

(element, name, label, options, attributes)

Reimplemented from backup_setting_ui.

get_icon()

base_setting_ui::get_icon ( )

inherited

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

Return values

pix_icon|false

get_label() [1/2]

backup_setting_ui::get_label ( base_task $task = null )

inherited

Gets the label for this item.

Parameters

base_task

$task

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

Return values

string

get_label() [2/2]

base_setting_ui::get_label ( )

inherited

Gets the name of this item including its prefix.

Return values

string

get_name()

base_setting_ui::get_name ( )

inherited

Gets the name of this item including its prefix.

Return values

string

get_param_validation()

base_setting_ui::get_param_validation ( )

inherited

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()

backup_setting_ui_select::get_static_value

(

)

Gets the static value for this select element.

Return values

string

Reimplemented from base_setting_ui.

get_type()

base_setting_ui::get_type ( )

inherited

Gets the type of this element.

Return values

int

get_value()

base_setting_ui::get_value ( )

inherited

Gets the value of this setting.

Return values

mixed

get_values()

backup_setting_ui_select::get_values

(

)

Returns the list of available values.

Return values

array

is_changeable()

backup_setting_ui_select::is_changeable

(

$level = null

)

Returns true if the setting is changeable, false otherwise.

Parameters

int

$level

Optional, if provided only depedency_settings below or equal to this level are considered, when checking if the ui_setting is changeable. Although dependencies might cause a lock on this setting, they could be changeable in the same view.

Return values

bool

Reimplemented from backup_setting_ui.

make()

static backup_setting_ui::make ( backup_setting $setting, $type, $label, array $attributes = null, array $options = null )

staticfinalinherited

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

Exceptions

backup_setting_ui_exception

if the setting type is not supported,

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

Return values

backup_setting_ui_text|backup_setting_ui_checkbox|backup_setting_ui_select|backup_setting_ui_radio

set_icon()

base_setting_ui::set_icon ( pix_icon $icon )

inherited

Sets the icon to display next to this item.

Parameters

pix_icon

$icon

set_label()

base_setting_ui::set_label ( string $label )

inherited

Sets the label.

Exceptions

base_setting_ui_exception

when the label is not valid.

Parameters

string

$label

set_values()

backup_setting_ui_select::set_values

(

array

$values

)

Sets the options for the select box.

Parameters

array

$values

Associative array of value => text options

---

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

• backup/util/ui/backup_ui_setting.class.php