admin_setting_sitesetcheckbox Class Reference

Special checkbox for frontpage - stores data in course table. More...

Inheritance diagram for admin_setting_sitesetcheckbox:

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 ()
	Returns the current sites name.
	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 ()
	admin_setting_sitesetcheckbox is not meant to 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 checkbox field.
	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)
	Save the selected setting.
	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.
string	$no
	Value used when not checked.
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
string	$yes
	Value used when checked.

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	$customcontrol = false
	Whether this setting uses a custom form control.

Detailed Description

Special checkbox for frontpage - stores data in course table.

License

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

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

mixed

returns 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	$value	Gets converted to string if not null

Return values

bool	Write setting to config table

Reimplemented in enrol_flatfile_role_setting.

get_defaultsetting()

admin_setting::get_defaultsetting ( )

inherited

Returns default setting if exists.

Return values

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_gradeexportdefault, admin_setting_special_registerauth, admin_setting_users_with_capability, admin_setting_webservicesoverview, core_admin\admin\admin_setting_plugin_manager, core_admin\admin\admin_setting_template_render, core_question\admin\manage_qbank_plugins_page, enrol_lti\local\ltiadvantage\admin\admin_setting_registeredplatforms, mod_glossary_admin_setting_display_formats, and tool_log_setting_managestores.

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_sitesetcheckbox::get_setting

(

)

Returns the current sites 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

array

of 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_sitesetcheckbox::is_forceable

(

)

admin_setting_sitesetcheckbox is not meant to be overridden in config.php.

Return values

bool

Reimplemented from admin_setting.

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

Is setting related to query text - used when searching.

Parameters

string

$query

Return values

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, enrol_lti\local\ltiadvantage\admin\admin_setting_registeredplatforms, mod_glossary_admin_setting_display_formats, and tool_log_setting_managestores.

output_html()

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

inherited

Returns an XHTML checkbox field.

Parameters

string	$data	If $data matches yes then checkbox is checked
string	$query

Return values

string

XHTML field

Reimplemented from admin_setting.

Reimplemented in admin_setting_enablemobileservice.

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

$original

original value before write_setting()

Return values

bool	true 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

$affectsmodinfo

If 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

$value

True 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

$functionname

Sets the function name

Return values

void

write_setting()

admin_setting_sitesetcheckbox::write_setting

(

$data

)

Save the selected setting.

Parameters

string

$data

The selected site

Return values

string

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

• lib/adminlib.php