Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
Graded roles in gradebook. More...
Public Member Functions | |
__construct () | |
Calls parent\__construct with specific arguments. | |
add_dependent_on ($dependenton) | |
Add a setting to the list of those that could cause this one to be hidden. | |
config_read ($name) | |
Returns the config if possible. | |
config_write ($name, $value) | |
Used to set a config pair and log change. | |
get_defaultsetting () | |
Return the default setting for this control. | |
get_dependent_on () | |
Get a list of the settings that could cause this one to be hidden. | |
get_force_ltr () | |
Get whether this should be displayed in LTR mode. | |
get_full_name () | |
Returns the fullname prefixed by the plugin. | |
get_id () | |
Returns the ID string based on plugin and name. | |
get_setting () | |
Returns the current setting if it is set. | |
get_setting_flag_defaults (& $defaults) | |
Get the list of defaults for the flags on this setting. | |
get_setting_flag_value (admin_setting_flag $flag) | |
Get the currently saved value for a setting flag. | |
has_custom_form_control () | |
Whether this setting uses a custom form control. | |
is_forceable () | |
Whether the setting can be overridden in config.php. | |
is_readonly () | |
Is this option forced in config.php? | |
is_related ($query) | |
Is setting related to query text - used when searching. | |
load_choices () | |
Load roles as choices. | |
output_html ($data, $query='') | |
Returns XHTML field(s) as required by choices. | |
output_setting_flags () | |
Output the input fields for the advanced and locked flags on this setting. | |
post_write_settings ($original) | |
Execute postupdatecallback if necessary. | |
set_advanced_flag_options ($enabled, $default) | |
Set the advanced options flag on this admin setting. | |
set_affects_modinfo ($affectsmodinfo) | |
set_enabled_flag_options ($enabled, $default) | |
Set the enabled options flag on this admin setting. | |
set_force_ltr ($value) | |
Set whether to force LTR or not. | |
set_locked_flag_options ($enabled, $default) | |
Set the locked options flag on this admin setting. | |
set_required_flag_options ($enabled, $default) | |
Set the required options flag on this admin setting. | |
set_updatedcallback ($functionname) | |
Function called if setting updated - cleanup, cache reset, etc. | |
write_setting ($data) | |
Saves the setting(s) provided in $data. | |
write_setting_flags ($data) | |
Write the values of the flags for this admin setting. | |
Public Attributes | |
bool | $affectsmodinfo = false |
if set, indicates that a change to this setting requires rebuild course cache | |
array | $choices |
Array of choices value=>label. | |
mixed | $defaultsetting |
Can be string or array of string. | |
string | $description |
localised long description in Markdown format | |
string | $name |
unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. | |
bool | $nosave = false |
true indicates this setting does not actually save anything, just information | |
mixed | $paramtype |
int means PARAM_XXX type, string is a allowed format in regex | |
mixed | $plugin |
can be String or Null. | |
callable | $updatedcallback |
lang_string string | $visiblename |
localised name | |
Protected Member Functions | |
add_to_config_log ($name, $oldvalue, $value) | |
Log config changes if necessary. | |
set_flag_options ($enabled, $default, $shortname, $displayname) | |
Generic function to add a flag to this admin setting. | |
Protected Attributes | |
callable null | $choiceloader = null |
Loader function for choices. | |
bool | $customcontrol = false |
Whether this setting uses a custom form control. | |
Graded roles in gradebook.
|
inherited |
Add a setting to the list of those that could cause this one to be hidden.
string | $dependenton |
|
protectedinherited |
Log config changes if necessary.
string | $name | |
string | $oldvalue | |
string | $value |
Reimplemented in admin_setting_configpasswordunmask.
|
inherited |
Returns the config if possible.
mixed | returns config if successful else null |
Reimplemented in enrol_flatfile_role_setting.
|
inherited |
Used to set a config pair and log change.
string | $name | |
mixed | $value | Gets converted to string if not null |
bool | Write setting to config table |
Reimplemented in enrol_flatfile_role_setting.
|
inherited |
Return the default setting for this control.
?array | Array of default settings |
Reimplemented from admin_setting.
|
inherited |
Get a list of the settings that could cause this one to be hidden.
array |
|
inherited |
Get whether this should be displayed in LTR mode.
bool|null |
Reimplemented in admin_setting_configtext, and admin_setting_filetypes.
|
inherited |
Returns the fullname prefixed by the plugin.
string |
Reimplemented in admin_setting_managerepository.
|
inherited |
Returns the ID string based on plugin and name.
string |
|
inherited |
Returns the current setting if it is set.
mixed | null if null, else an array |
Reimplemented from admin_setting.
Reimplemented in admin_setting_configmulticheckbox2.
|
inherited |
Get the list of defaults for the flags on this setting.
array | of strings describing the defaults for this setting. This is appended to by this function. |
|
inherited |
Get the currently saved value for a setting flag.
admin_setting_flag | $flag | - One of the admin_setting_flag for this admin_setting. |
bool |
|
inherited |
Whether this setting uses a custom form control.
This function is especially useful to decide if we should render a label element for this setting or not.
bool |
|
inherited |
Whether the setting can be overridden in config.php.
Returning true will allow the setting to be defined and overridden in config.php. Returning false will prevent the config setting from being overridden even when it gets defined in config.php.
bool |
Reimplemented in admin_setting_sitesetcheckbox, admin_setting_sitesetselect, admin_setting_sitesettext, and admin_setting_special_frontpagedesc.
|
inherited |
Is this option forced in config.php?
bool |
|
inherited |
Is setting related to query text - used when searching.
string | $query |
bool | true on related, false on not or failure |
Reimplemented from admin_setting.
|
inherited |
Load roles as choices.
bool | true=>success, false=>error |
Reimplemented from admin_setting_configmulticheckbox.
|
inherited |
Returns XHTML field(s) as required by choices.
Relies on data being an array should data ever be another valid vartype with acceptable value this may cause a warning/error if (!is_array($data)) would fix the problem
array | $data | An array of checked values |
string | $query |
string | XHTML field |
Reimplemented from admin_setting.
|
inherited |
Output the input fields for the advanced and locked flags on this setting.
bool | $adv | - The current value of the advanced flag. |
bool | $locked | - The current value of the locked flag. |
string\$output | - The html for the flags. |
|
inherited |
Execute postupdatecallback if necessary.
mixed | $original | original value before write_setting() |
bool | true if changed, false if not. |
Reimplemented in admin_setting_configstoredfile.
|
inherited |
Set the advanced options flag on this admin setting.
bool | $enabled | - One of self\OPTION_ENABLED or self\OPTION_DISABLED |
bool | $default | - The default for the flag |
|
inherited |
bool | $affectsmodinfo | If true, changes to this setting will cause the course cache to be rebuilt |
|
inherited |
Set the enabled options flag on this admin setting.
bool | $enabled | - One of self\OPTION_ENABLED or self\OPTION_DISABLED |
bool | $default | - The default for the flag |
|
protectedinherited |
Generic function to add a flag to this admin setting.
bool | $enabled | - One of self\OPTION_ENABLED or self\OPTION_DISABLED |
bool | $default | - The default for the flag |
string | $shortname | - The shortname for this flag. Used as a suffix for the setting name. |
string | $displayname | - The display name for this flag. Used as a label next to the checkbox. |
|
inherited |
Set whether to force LTR or not.
bool | $value | True when forced, false when not force, null when unknown. |
|
inherited |
Set the locked options flag on this admin setting.
bool | $enabled | - One of self\OPTION_ENABLED or self\OPTION_DISABLED |
bool | $default | - The default for the flag |
|
inherited |
Set the required options flag on this admin setting.
bool | $enabled | - One of self\OPTION_ENABLED or self\OPTION_DISABLED. |
bool | $default | - The default for the flag. |
|
inherited |
Function called if setting updated - cleanup, cache reset, etc.
callable | $functionname | Sets the function name |
void |
|
inherited |
Saves the setting(s) provided in $data.
array | $data | An array of data, if not array returns empty str |
mixed | empty string on useless data or bool true=success, false=failed |
Reimplemented from admin_setting.
Reimplemented in admin_setting_configmulticheckbox2.
|
inherited |
Write the values of the flags for this admin setting.
?array | $data | - The data submitted from the form or null to set the default value for new installs. |
bool | - true if successful. |
|
inherited |
can be String or Null.
Null means main config table