Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_adminpresets\local\setting\adminpresets_admin_setting_configmulticheckbox Class Reference
Inheritance diagram for core_adminpresets\local\setting\adminpresets_admin_setting_configmulticheckbox:
core_adminpresets\local\setting\adminpresets_admin_setting_configmultiselect core_adminpresets\local\setting\adminpresets_setting

Public Member Functions

 get_attributes ()
 
 get_attributes_values ()
 
 get_settingdata ()
 
 get_value ()
 Gets the setting value.
 
 get_visiblevalue ()
 
 save_attributes_values ()
 Saves the setting attributes values.
 
 save_value ($name=false, $value=null)
 Stores the setting into database, logs the change and returns the config_log inserted id.
 
 set_attribute_value ($name, $value)
 
 set_behaviors ()
 Each class can overwrite this method to specify extra processes.
 

Protected Member Functions

 apply_behaviors ()
 Applies the children class specific behaviors.
 
 set_value ($value)
 Sets the setting value cleaning it.
 
 set_visiblevalue ()
 Sets the visible name for the setting selected value.
 
 to_log ($plugin, $name, $value, $actualvalue)
 Copy of config_write method of the admin_setting class.
 

Protected Attributes

string $attributes = false
 For multiple value settings, used to look for the other values.
 
array $attributesvalues
 To store the setting attributes.
 
array array $behaviors = []
 To store the behaviors.
 
delegation $delegation
 
admin_setting_configmultiselect $settingdata
 $settingdata
 
mixed $value
 The setting DB value.
 
string $visiblevalue
 Stores the visible value of the setting DB value.
 

Member Function Documentation

◆ apply_behaviors()

core_adminpresets\local\setting\adminpresets_setting::apply_behaviors ( )
protectedinherited

Applies the children class specific behaviors.

See delegation class for the available extra behaviors

◆ get_value()

core_adminpresets\local\setting\adminpresets_setting::get_value ( )
inherited

Gets the setting value.

Return values
mixedThe setting value

◆ save_attributes_values()

core_adminpresets\local\setting\adminpresets_setting::save_attributes_values ( )
inherited

Saves the setting attributes values.

Return values
array|falseArray of inserted ids (in config_log) or false if nothing was inserted

◆ save_value()

core_adminpresets\local\setting\adminpresets_setting::save_value ( $name = false,
$value = null )
inherited

Stores the setting into database, logs the change and returns the config_log inserted id.

Parameters
bool$nameSetting name to store.
mixed$valueSetting value to store.
Return values
int|falseconfig_log inserted id or false whenever the new value is the same as old value.

Reimplemented in core_adminpresets\local\setting\adminpresets_admin_setting_bloglevel, and core_adminpresets\local\setting\adminpresets_admin_setting_sitesettext.

◆ set_attribute_value()

core_adminpresets\local\setting\adminpresets_setting::set_attribute_value ( $name,
$value )
inherited

◆ set_behaviors()

core_adminpresets\local\setting\adminpresets_admin_setting_configmulticheckbox::set_behaviors ( )

Each class can overwrite this method to specify extra processes.

Reimplemented from core_adminpresets\local\setting\adminpresets_setting.

◆ set_value()

◆ set_visiblevalue()

core_adminpresets\local\setting\adminpresets_admin_setting_configmultiselect::set_visiblevalue ( )
protectedinherited

Sets the visible name for the setting selected value.

In most cases the child classes will overwrite

Reimplemented from core_adminpresets\local\setting\adminpresets_setting.

◆ to_log()

core_adminpresets\local\setting\adminpresets_setting::to_log ( $plugin,
$name,
$value,
$actualvalue )
protectedinherited

Copy of config_write method of the admin_setting class.

Parameters
string$plugin
string$name
mixed$value
mixed$actualvalue
Return values
integerThe stored config_log id

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