Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Used to validate a textarea used for domain names, wildcard domain names and IP addresses/ranges (both IPv4 and IPv6 format). More...
Public Member Functions | |
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 () | |
Returns default setting if exists. | |
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 () | |
Override, providing utf8-decoding for ascii-encoded IDN strings. | |
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. | |
output_html ($data, $query='') | |
Returns an XHTML string for the editor. | |
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. | |
validate ($data) | |
Validate the contents of the textarea as either IP addresses, domain name or wildcard domain name (RFC 4592). | |
write_setting ($data) | |
Override, providing ascii-encoding for utf8 (native) IDN strings. | |
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 | |
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. | |
int | $size |
default field size | |
string | $updatedcallback |
lang_string string | $visiblename |
localised name | |
Protected Member Functions | |
ace_decode ($data) | |
Decode any ascii-encoded domain names back to their utf-8 representation for display. | |
ace_encode ($data) | |
Convert any lines containing international domain names (IDNs) to their ascii-compatible encoding (ACE). | |
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 | |
bool | $customcontrol = false |
Whether this setting uses a custom form control. | |
Used to validate a textarea used for domain names, wildcard domain names and IP addresses/ranges (both IPv4 and IPv6 format).
|
protected |
Decode any ascii-encoded domain names back to their utf-8 representation for display.
string | $data | the setting data, as found in the database. |
string\$data | the setting data, with all ascii-encoded IDNs decoded back to their utf-8 representation. |
|
protected |
Convert any lines containing international domain names (IDNs) to their ascii-compatible encoding (ACE).
string | $data | the setting data, as sent from the web form. |
string\$data | the setting data, with all IDNs converted (using punycode) to their ascii encoded version. |
|
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 |
Returns default setting if exists.
mixed | array or string depending on instance; NULL means no default, user must supply |
Reimplemented in admin_setting_description, admin_setting_heading, admin_setting_manage_plugins, admin_setting_manageantiviruses, admin_setting_manageauths, admin_setting_managecontentbankcontenttypes, admin_setting_managecustomfields, admin_setting_managedataformats, admin_setting_manageenrols, admin_setting_manageexternalservices, admin_setting_manageformats, admin_setting_managemediaplayers, admin_setting_managerepository, admin_setting_managewebserviceprotocols, admin_setting_php_extension_enabled, admin_setting_pickroles, admin_setting_searchsetupinfo, admin_setting_special_registerauth, admin_setting_users_with_capability, admin_setting_webservicesoverview, core_admin\admin\admin_setting_plugin_manager, core_question\admin\manage_qbank_plugins_page, editor_atto_subplugins_setting, enrol_lti\local\ltiadvantage\admin\admin_setting_registeredplatforms, mod_glossary_admin_setting_display_formats, and tool_log_setting_managestores.
|
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.
Try to guess from the PARAM type unless specifically set.
Reimplemented from admin_setting.
Reimplemented in 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 |
admin_setting_configmixedhostiplist::get_setting | ( | ) |
Override, providing utf8-decoding for ascii-encoded IDN strings.
mixed | returns punycode-converted setting string if successful, else null. |
Reimplemented from admin_setting_configtext.
|
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 |
Reimplemented in admin_setting_configmulticheckbox, admin_setting_configmultiselect, admin_setting_configselect, admin_setting_manage_plugins, admin_setting_manageantiviruses, admin_setting_manageauths, admin_setting_managecontentbankcontenttypes, admin_setting_managecustomfields, admin_setting_managedataformats, admin_setting_manageenrols, admin_setting_manageexternalservices, admin_setting_manageformats, admin_setting_managemediaplayers, admin_setting_managerepository, admin_setting_managewebserviceprotocols, core_admin\admin\admin_setting_plugin_manager, core_communication\admin\manage_communication_providers_page, core_question\admin\manage_qbank_plugins_page, editor_atto_subplugins_setting, enrol_lti\local\ltiadvantage\admin\admin_setting_registeredplatforms, mod_glossary_admin_setting_display_formats, and tool_log_setting_managestores.
|
inherited |
Returns an XHTML string for the editor.
string | $data | |
string | $query |
string | XHTML string for the editor |
Reimplemented from admin_setting_configtext.
Reimplemented in admin_setting_confightmleditor.
|
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.
string | $functionname | Sets the function name |
void |
admin_setting_configmixedhostiplist::validate | ( | $data | ) |
Validate the contents of the textarea as either IP addresses, domain name or wildcard domain name (RFC 4592).
Used to validate a new line separated list of entries collected from a textarea control.
This setting provides support for internationalised domain names (IDNs), however, such UTF-8 names will be converted to their ascii-compatible encoding (punycode) on save, and converted back to their UTF-8 representation when fetched via the get_setting() method, which has been overriden.
string | $data | A list of FQDNs, DNS wildcard format domains, and IP addresses, separated by new lines. |
mixed | bool true for success or string:error on failure |
Reimplemented from admin_setting_configtext.
admin_setting_configmixedhostiplist::write_setting | ( | $data | ) |
Override, providing ascii-encoding for utf8 (native) IDN strings.
string | $data |
string |
Reimplemented from admin_setting_configtext.
|
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