Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
admin_setting_filetypes Class Reference

Administration setting to define a list of file types. More...

Inheritance diagram for admin_setting_filetypes:
admin_setting_configtext admin_setting

Public Member Functions

 __construct ($name, $visiblename, $description, $defaultsetting='', array $options=[])
 Constructor.
 
 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 ()
 Should the values be always 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 ()
 Return the setting.
 
 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='')
 Return an HTML string for the setting element.
 
 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_data_attribute (string $key, string $value)
 Set arbitrary data attributes for template.
 
 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 data before storage.
 
 write_setting ($data)
 Normalize the user's input and write it to the database as comma separated list.
 
 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
 
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

bool $allowall = true
 Allow selection of 'All file types' (will be stored as '*').
 
bool $customcontrol = false
 Whether this setting uses a custom form control.
 
array $datavalues = []
 List of arbitrary data attributes.
 
array $onlytypes = []
 Allow selection from these file types only.
 
core_form filetypes_util $util = null
 instance to use as a helper.
 

Detailed Description

Administration setting to define a list of file types.

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

Constructor & Destructor Documentation

◆ __construct()

admin_setting_filetypes::__construct ( $name,
$visiblename,
$description,
$defaultsetting = '',
array $options = [] )

Constructor.

Parameters
string$nameUnique ascii name like 'mycoresetting' or 'myplugin/mysetting'
string$visiblenameLocalised label of the setting
string$descriptionLocalised description of the setting
string$defaultsettingDefault setting value.
array$optionsSetting widget options, an array with optional keys: 'onlytypes' => array Allow selection from these file types only; for example ['onlytypes' => ['web_image']]. 'allowall' => bool Allow to select 'All file types', defaults to true. Does not apply if onlytypes are set.

Member Function Documentation

◆ add_dependent_on()

admin_setting::add_dependent_on ( $dependenton)
inherited

Add a setting to the list of those that could cause this one to be hidden.

Parameters
string$dependenton

◆ add_to_config_log()

admin_setting::add_to_config_log ( $name,
$oldvalue,
$value )
protectedinherited

Log config changes if necessary.

Parameters
string$name
string$oldvalue
string$value

Reimplemented in admin_setting_configpasswordunmask.

◆ config_read()

admin_setting::config_read ( $name)
inherited

Returns the config if possible.

Return values
mixedreturns config if successful else null

Reimplemented in enrol_flatfile_role_setting.

◆ config_write()

admin_setting::config_write ( $name,
$value )
inherited

Used to set a config pair and log change.

Parameters
string$name
mixed$valueGets converted to string if not null
Return values
boolWrite setting to config table

Reimplemented in enrol_flatfile_role_setting.

◆ get_defaultsetting()

◆ get_dependent_on()

admin_setting::get_dependent_on ( )
inherited

Get a list of the settings that could cause this one to be hidden.

Return values
array

◆ get_force_ltr()

admin_setting_filetypes::get_force_ltr ( )

Should the values be always displayed in LTR mode?

We always return true here because these values are not RTL compatible.

Return values
boolTrue because these values are not RTL compatible.

Reimplemented from admin_setting_configtext.

◆ get_full_name()

admin_setting::get_full_name ( )
inherited

Returns the fullname prefixed by the plugin.

Return values
string

Reimplemented in admin_setting_managerepository.

◆ get_id()

admin_setting::get_id ( )
inherited

Returns the ID string based on plugin and name.

Return values
string

◆ get_setting()

admin_setting_configtext::get_setting ( )
inherited

Return the setting.

Return values
mixedreturns config if successful else null

Reimplemented from admin_setting.

Reimplemented in admin_setting_configmixedhostiplist, admin_setting_sitesettext, and admin_setting_special_frontpagedesc.

◆ get_setting_flag_defaults()

admin_setting::get_setting_flag_defaults ( & $defaults)
inherited

Get the list of defaults for the flags on this setting.

Parameters
arrayof strings describing the defaults for this setting. This is appended to by this function.

◆ get_setting_flag_value()

admin_setting::get_setting_flag_value ( admin_setting_flag $flag)
inherited

Get the currently saved value for a setting flag.

Parameters
admin_setting_flag$flag- One of the admin_setting_flag for this admin_setting.
Return values
bool

◆ has_custom_form_control()

admin_setting::has_custom_form_control ( )
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.

Return values
bool

◆ is_forceable()

admin_setting::is_forceable ( )
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.

Return values
bool

Reimplemented in admin_setting_sitesetcheckbox, admin_setting_sitesetselect, admin_setting_sitesettext, and admin_setting_special_frontpagedesc.

◆ is_readonly()

admin_setting::is_readonly ( )
inherited

Is this option forced in config.php?

Return values
bool

◆ is_related()

◆ output_html()

admin_setting_filetypes::output_html ( $data,
$query = '' )

Return an HTML string for the setting element.

Parameters
string$dataThe current setting value
string$queryAdmin search query to be highlighted
Return values
stringHTML to be displayed

Reimplemented from admin_setting_configtext.

◆ output_setting_flags()

admin_setting::output_setting_flags ( )
inherited

Output the input fields for the advanced and locked flags on this setting.

Parameters
bool$adv- The current value of the advanced flag.
bool$locked- The current value of the locked flag.
Return values
string\$output- The html for the flags.

◆ post_write_settings()

admin_setting::post_write_settings ( $original)
inherited

Execute postupdatecallback if necessary.

Parameters
mixed$originaloriginal value before write_setting()
Return values
booltrue if changed, false if not.

Reimplemented in admin_setting_configstoredfile.

◆ set_advanced_flag_options()

admin_setting::set_advanced_flag_options ( $enabled,
$default )
inherited

Set the advanced options flag on this admin setting.

Parameters
bool$enabled- One of self\OPTION_ENABLED or self\OPTION_DISABLED
bool$default- The default for the flag

◆ set_affects_modinfo()

admin_setting::set_affects_modinfo ( $affectsmodinfo)
inherited
Parameters
bool$affectsmodinfoIf true, changes to this setting will cause the course cache to be rebuilt

◆ set_data_attribute()

admin_setting_configtext::set_data_attribute ( string $key,
string $value )
inherited

Set arbitrary data attributes for template.

Parameters
string$keyAttribute key for template.
string$valueAttribute value for template.

◆ set_enabled_flag_options()

admin_setting::set_enabled_flag_options ( $enabled,
$default )
inherited

Set the enabled options flag on this admin setting.

Parameters
bool$enabled- One of self\OPTION_ENABLED or self\OPTION_DISABLED
bool$default- The default for the flag

◆ set_flag_options()

admin_setting::set_flag_options ( $enabled,
$default,
$shortname,
$displayname )
protectedinherited

Generic function to add a flag to this admin setting.

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

◆ set_force_ltr()

admin_setting::set_force_ltr ( $value)
inherited

Set whether to force LTR or not.

Parameters
bool$valueTrue when forced, false when not force, null when unknown.

◆ set_locked_flag_options()

admin_setting::set_locked_flag_options ( $enabled,
$default )
inherited

Set the locked options flag on this admin setting.

Parameters
bool$enabled- One of self\OPTION_ENABLED or self\OPTION_DISABLED
bool$default- The default for the flag

◆ set_required_flag_options()

admin_setting::set_required_flag_options ( $enabled,
$default )
inherited

Set the required options flag on this admin setting.

Parameters
bool$enabled- One of self\OPTION_ENABLED or self\OPTION_DISABLED.
bool$default- The default for the flag.

◆ set_updatedcallback()

admin_setting::set_updatedcallback ( $functionname)
inherited

Function called if setting updated - cleanup, cache reset, etc.

Parameters
callable$functionnameSets the function name
Return values
void

◆ validate()

admin_setting_filetypes::validate ( $data)

Validate data before storage.

Parameters
string$dataThe setting values provided by the admin
Return values
bool|stringTrue if ok, the string if error found

Reimplemented from admin_setting_configtext.

◆ write_setting()

admin_setting_filetypes::write_setting ( $data)

Normalize the user's input and write it to the database as comma separated list.

Comma separated list as a text representation of the array was chosen to make this compatible with how the $CFG->courseoverviewfilesext values are stored.

Parameters
string$dataValue submitted by the admin.
Return values
stringEpty string if all good, error message otherwise.

Reimplemented from admin_setting_configtext.

◆ write_setting_flags()

admin_setting::write_setting_flags ( $data)
inherited

Write the values of the flags for this admin setting.

Parameters
?array$data- The data submitted from the form or null to set the default value for new installs.
Return values
bool- true if successful.

Member Data Documentation

◆ $plugin

mixed admin_setting::$plugin
inherited

can be String or Null.

Null means main config table


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