core_adminpresets\local\setting\adminpresets_setting Class Reference

Inheritance diagram for core_adminpresets\local\setting\adminpresets_setting:

Public Member Functions
	__construct (admin_setting $settingdata, $dbsettingvalue)
	Stores the setting data and the selected value.
	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)

Protected Member Functions
	apply_behaviors ()
	Applies the children class specific behaviors.
	set_behaviors ()
	Each class can overwrite this method to specify extra processes.
	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	$settingdata
mixed	$value
	The setting DB value.
string	$visiblevalue
	Stores the visible value of the setting DB value.

Constructor & Destructor Documentation

__construct()

core_adminpresets\local\setting\adminpresets_setting::__construct	(	admin_setting	$settingdata,
			$dbsettingvalue )

Stores the setting data and the selected value.

Parameters

admin_setting	$settingdata	admin_setting subclass
mixed	$dbsettingvalue	Actual value

Reimplemented in core_adminpresets\local\setting\adminpresets_admin_setting_configcheckbox_with_advanced, core_adminpresets\local\setting\adminpresets_admin_setting_configcheckbox_with_lock, core_adminpresets\local\setting\adminpresets_admin_setting_configselect_with_advanced, core_adminpresets\local\setting\adminpresets_admin_setting_configtext_with_advanced, and core_adminpresets\local\setting\adminpresets_admin_setting_gradecat_combo.

Member Function Documentation

apply_behaviors()

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

protected

Applies the children class specific behaviors.

See delegation class for the available extra behaviors

get_value()

core_adminpresets\local\setting\adminpresets_setting::get_value

(

)

Gets the setting value.

Return values

mixed

The setting value

save_attributes_values()

core_adminpresets\local\setting\adminpresets_setting::save_attributes_values

(

)

Saves the setting attributes values.

Return values

array|false

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

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

Parameters

bool	$name	Setting name to store.
mixed	$value	Setting value to store.

Return values

int|false

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

Reimplemented in core_adminpresets\local\setting\adminpresets_admin_setting_configtime.

set_behaviors()

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

protected

Each class can overwrite this method to specify extra processes.

Reimplemented in core_adminpresets\local\setting\adminpresets_admin_setting_configmulticheckbox, core_adminpresets\local\setting\adminpresets_admin_setting_configmultiselect_with_loader, core_adminpresets\local\setting\adminpresets_admin_setting_users_with_capability, mod_quiz\adminpresets\adminpresets_browser_security_setting, mod_quiz\adminpresets\adminpresets_grade_method_setting, mod_quiz\adminpresets\adminpresets_overdue_handling_setting, and mod_quiz\adminpresets\adminpresets_user_image_setting.

set_value()

core_adminpresets\local\setting\adminpresets_setting::set_value ( $value )

protected

Sets the setting value cleaning it.

Child classes should overwrite method to clean more acurately

Parameters

mixed

$value

Setting value

Return values

mixed

Returns false if wrong param value

Reimplemented in auth_ldap\adminpresets\adminpresets_auth_ldap_admin_setting_special_contexts_configtext, core_adminpresets\local\setting\adminpresets_admin_setting_configiplist, core_adminpresets\local\setting\adminpresets_admin_setting_configselect, core_adminpresets\local\setting\adminpresets_admin_setting_configtext, core_adminpresets\local\setting\adminpresets_admin_setting_configtime, core_adminpresets\local\setting\adminpresets_admin_setting_special_backupdays, and core_adminpresets\local\setting\adminpresets_admin_setting_users_with_capability.

set_visiblevalue()

core_adminpresets\local\setting\adminpresets_setting::set_visiblevalue ( )

protected

Sets the visible name for the setting selected value.

In most cases the child classes will overwrite

Reimplemented in core_adminpresets\local\setting\adminpresets_admin_setting_configcheckbox, core_adminpresets\local\setting\adminpresets_admin_setting_configcheckbox_with_advanced, core_adminpresets\local\setting\adminpresets_admin_setting_configcheckbox_with_lock, core_adminpresets\local\setting\adminpresets_admin_setting_configmultiselect, core_adminpresets\local\setting\adminpresets_admin_setting_configselect, core_adminpresets\local\setting\adminpresets_admin_setting_configselect_with_advanced, core_adminpresets\local\setting\adminpresets_admin_setting_configtext_with_advanced, core_adminpresets\local\setting\adminpresets_admin_setting_configtime, core_adminpresets\local\setting\adminpresets_admin_setting_devicedetectregex, core_adminpresets\local\setting\adminpresets_admin_setting_gradecat_combo, core_adminpresets\local\setting\adminpresets_admin_setting_special_backupdays, core_adminpresets\local\setting\adminpresets_admin_setting_special_calendar_weekend, and mod_quiz\adminpresets\adminpresets_review_setting.

to_log()

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

protected

Copy of config_write method of the admin_setting class.

Parameters

string	$plugin
string	$name
mixed	$value
mixed	$actualvalue

Return values

integer

The stored config_log id

---

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

• admin/presets/classes/local/setting/adminpresets_setting.php