Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
backup_setting_ui Class Reference

Abstract class to represent the user interface backup settings have. More...

Inheritance diagram for backup_setting_ui:
base_setting_ui backup_setting_ui_checkbox backup_setting_ui_radio backup_setting_ui_select backup_setting_ui_text backup_setting_ui_dateselector backup_setting_ui_defaultcustom

Public Member Functions

 __construct (backup_setting $setting, $label=null, array $attributes=null, array $options=null)
 JAC... More...
 
 apply_options (array $properties)
 Applies config options to a given properties array and then returns it. More...
 
 destroy ()
 Destroy all circular references. More...
 
 disable ()
 Disables the UI for this element.
 
 get_attributes ()
 Gets the HTML attributes for this item. More...
 
 get_element_properties (base_task $task=null, renderer_base $output=null)
 Get element properties that can be used to make a quickform element. More...
 
 get_icon ()
 Returns the icon to display next to this item, or false if there isn't one. More...
 
 get_label ()
 Gets the name of this item including its prefix. More...
 
 get_label (base_task $task=null)
 Gets the label for this item. More...
 
 get_name ()
 Gets the name of this item including its prefix. More...
 
 get_param_validation ()
 Gets the the PARAM_XXXX validation to be applied to the setting. More...
 
 get_static_value ()
 Gets the value to display in a static quickforms element. More...
 
 get_type ()
 Gets the type of this element. More...
 
 get_value ()
 Gets the value of this setting. More...
 
 is_changeable ($level=null)
 Returns true if the setting is changeable. More...
 
 set_icon (pix_icon $icon)
 Sets the icon to display next to this item. More...
 
 set_label ($label)
 Sets the label. More...
 

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. More...
 

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
 The backup_setting UI type this relates to. More...
 

Detailed Description

Abstract class to represent the user interface backup settings have.

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

Constructor & Destructor Documentation

◆ __construct()

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

JAC...

Just Another Constructor

Parameters
backup_setting$setting
string$labelThe label to display with the setting ui
array$attributesArray of HTML attributes to apply to the element
array$optionsArray of options to apply to the setting ui object

Reimplemented in backup_setting_ui_defaultcustom.

Member Function Documentation

◆ apply_options()

backup_setting_ui::apply_options ( array  $properties)

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::get_element_properties ( base_task  $task = null,
renderer_base  $output = null 
)
abstract

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

Parameters
base_task$task
renderer_base$output
Return values
array

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

◆ 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]

base_setting_ui::get_label ( )
inherited

Gets the name of this item including its prefix.

Return values
string

◆ get_label() [2/2]

backup_setting_ui::get_label ( base_task  $task = null)

Gets the label for this item.

Parameters
base_task$taskOptional, if provided and the setting is an include $task is used to set the setting label
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()

base_setting_ui::get_static_value ( )
inherited

Gets the value to display in a static quickforms element.

Return values
mixed

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

◆ 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

◆ is_changeable()

backup_setting_ui::is_changeable (   $level = null)

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

Parameters
int$levelOptional, 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 in backup_setting_ui_select, and backup_setting_ui_checkbox.

◆ make()

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

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

Exceptions
backup_setting_ui_exceptionif the setting type is not supported,
Parameters
backup_setting$setting
int$typeThe backup_setting UI type. One of backup_setting::UI_*;
string$labelThe label to display with the setting ui
array$attributesArray of HTML attributes to apply to the element
array$optionsArray 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 (   $label)
inherited

Sets the label.

Exceptions
base_setting_ui_exceptionwhen the label is not valid.
Parameters
string$label

Member Data Documentation

◆ $type

int base_setting_ui::$type
protectedinherited

The backup_setting UI type this relates to.

One of backup_setting::UI_*;


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