Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
admin_setting_enablemobileservice Class Reference

Special checkbox for enable mobile web service If enable then we store the service id of the mobile service into config table If disable then we unstore the service id from the config table. More...

Inheritance diagram for admin_setting_enablemobileservice:
admin_setting_configcheckbox admin_setting

Public Member Functions

 add_dependent_on ($dependenton)
 Add a setting to the list of those that could cause this one to be hidden. More...
 
 config_read ($name)
 Returns the config if possible. More...
 
 config_write ($name, $value)
 Used to set a config pair and log change. More...
 
 get_defaultsetting ()
 Returns default setting if exists. More...
 
 get_dependent_on ()
 Get a list of the settings that could cause this one to be hidden. More...
 
 get_force_ltr ()
 Get whether this should be displayed in LTR mode. More...
 
 get_full_name ()
 Returns the fullname prefixed by the plugin. More...
 
 get_id ()
 Returns the ID string based on plugin and name. More...
 
 get_setting ()
 Retrieves the current setting using the objects name. More...
 
 get_setting_flag_defaults (& $defaults)
 Get the list of defaults for the flags on this setting. More...
 
 get_setting_flag_value (admin_setting_flag $flag)
 Get the currently saved value for a setting flag. More...
 
 has_custom_form_control ()
 Whether this setting uses a custom form control. More...
 
 is_readonly ()
 Is this option forced in config.php? More...
 
 is_related ($query)
 Is setting related to query text - used when searching. More...
 
 output_html ($data, $query='')
 Builds XHTML to display the control. More...
 
 output_setting_flags ()
 Output the input fields for the advanced and locked flags on this setting. More...
 
 post_write_settings ($original)
 Execute postupdatecallback if necessary. More...
 
 set_advanced_flag_options ($enabled, $default)
 Set the advanced options flag on this admin setting. More...
 
 set_affects_modinfo ($affectsmodinfo)
 
 set_enabled_flag_options ($enabled, $default)
 Set the enabled options flag on this admin setting. More...
 
 set_force_ltr ($value)
 Set whether to force LTR or not. More...
 
 set_locked_flag_options ($enabled, $default)
 Set the locked options flag on this admin setting. More...
 
 set_required_flag_options ($enabled, $default)
 Set the required options flag on this admin setting. More...
 
 set_updatedcallback ($functionname)
 Function called if setting updated - cleanup, cache reset, etc. More...
 
 write_setting ($data)
 Save the selected setting. More...
 
 write_setting_flags ($data)
 Write the values of the flags for this admin setting. More...
 

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.
 
string $no
 Value used when not checked.
 
bool $nosave = false
 true indicates this setting does not actually save anything, just information
 
mixed $plugin
 can be String or Null. More...
 
string $updatedcallback
 
string $visiblename
 localised name
 
string $yes
 Value used when checked.
 

Protected Member Functions

 add_to_config_log ($name, $oldvalue, $value)
 Log config changes if necessary. More...
 
 set_flag_options ($enabled, $default, $shortname, $displayname)
 Generic function to add a flag to this admin setting. More...
 

Protected Attributes

bool $customcontrol = false
 Whether this setting uses a custom form control.
 

Detailed Description

Special checkbox for enable mobile web service If enable then we store the service id of the mobile service into config table If disable then we unstore the service id from the config table.

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

admin_setting::get_defaultsetting ( )
inherited

◆ 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::get_force_ltr ( )
inherited

Get whether this should be displayed in LTR mode.

Return values
bool|null

Reimplemented in admin_setting_configtext, and admin_setting_filetypes.

◆ 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_enablemobileservice::get_setting ( )

Retrieves the current setting using the objects name.

Return values
string

Reimplemented from admin_setting_configcheckbox.

◆ 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_readonly()

admin_setting::is_readonly ( )
inherited

Is this option forced in config.php?

Return values
bool

◆ is_related()

admin_setting::is_related (   $query)
inherited

◆ output_html()

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

Builds XHTML to display the control.

The main purpose of this overloading is to display a warning when https is not supported by the server

Parameters
string$dataUnused
string$query
Return values
stringXHTML

Reimplemented from admin_setting_configcheckbox.

◆ 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_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
string$functionnameSets the function name
Return values
void

◆ write_setting()

admin_setting_enablemobileservice::write_setting (   $data)

Save the selected setting.

Parameters
string$dataThe selected site
Return values
stringempty string or error message

Reimplemented from admin_setting_configcheckbox.

◆ 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: