Moodle  2.2.1
http://www.collinsharper.com
Public Member Functions | Data Fields
admin_setting Class Reference
Inheritance diagram for admin_setting:
Inheritance graph
[legend]

Public Member Functions

 __construct ($name, $visiblename, $description, $defaultsetting)
 get_full_name ()
 get_id ()
 set_affects_modinfo ($affectsmodinfo)
 config_read ($name)
 config_write ($name, $value)
 get_setting ()
 get_defaultsetting ()
 write_setting ($data)
 output_html ($data, $query='')
 set_updatedcallback ($functionname)
 is_related ($query)

Data Fields

 $name
 $visiblename
 $description
 $defaultsetting
 $updatedcallback
 $plugin
 $nosave = false
 $affectsmodinfo = false

Detailed Description

Admin settings class. Only exists on setting pages. Read & write happens at this level; no authentication.

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

Definition at line 1403 of file adminlib.php.

Constructor & Destructor Documentation

__construct ( $  name,
$  visiblename,
$  description,
$  defaultsetting 
)

Constructor

Parameters:
string$nameunique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
string$visiblenamelocalised name
string$descriptionlocalised long description
mixed$defaultsettingstring or array depending on implementation

Reimplemented in admin_setting_configmultiselect_modules, admin_setting_devicedetectregex, admin_setting_pickroles, admin_setting_question_behaviour, admin_settings_coursecat_select, admin_settings_num_course_sections, admin_setting_configfile, admin_setting_configpasswordunmask, and admin_setting_ldap_rolemapping.

Definition at line 1429 of file adminlib.php.

Member Function Documentation

config_read ( $  name)

Returns the config if possible

Returns:
mixed returns config if successful else null

Definition at line 1494 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

config_write ( $  name,
$  value 
)

Used to set a config pair and log change

Parameters:
string$name
mixed$valueGets converted to string if not null
Returns:
bool Write setting to config table

Definition at line 1516 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_defaultsetting ( )

Returns default setting if exists

Returns:
mixed array or string depending on instance; NULL means no default, user must supply

Reimplemented in admin_setting_managewebservicetokens, admin_setting_managewebserviceprotocols, admin_setting_webservicesoverview, admin_setting_manageplagiarism, admin_setting_manageexternalservices, admin_setting_managerepository, admin_setting_managelicenses, admin_setting_manageeditors, admin_setting_manageauths, admin_setting_manageenrols, admin_setting_special_registerauth, admin_setting_pickroles, admin_setting_users_with_capability, and admin_setting_heading.

Definition at line 1564 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_full_name ( )

Returns the fullname prefixed by the plugin

Returns:
string

Reimplemented in admin_setting_managerepository.

Definition at line 1469 of file adminlib.php.

Here is the caller graph for this function:

get_id ( )

Returns the ID string based on plugin and name

Returns:
string

Definition at line 1477 of file adminlib.php.

Here is the caller graph for this function:

get_setting ( ) [abstract]

Returns current value of this setting

Returns:
mixed array or string depending on instance, NULL means not set yet

Reimplemented in admin_setting_devicedetectregex, admin_setting_configcolourpicker, admin_setting_managewebservicetokens, admin_setting_managewebserviceprotocols, admin_setting_webservicesoverview, admin_setting_manageplagiarism, admin_setting_manageexternalservices, admin_setting_enablemobileservice, admin_setting_managerepository, admin_setting_managelicenses, admin_setting_manageeditors, admin_setting_manageauths, admin_setting_manageenrols, admin_setting_gradecat_combo, admin_setting_configselect_with_advanced, admin_setting_configcheckbox_with_lock, admin_setting_configcheckbox_with_advanced, admin_setting_configtext_with_advanced, admin_setting_special_calendar_weekend, admin_setting_emoticons, admin_setting_special_frontpagedesc, admin_setting_sitesettext, admin_setting_sitesetcheckbox, admin_setting_courselist_frontpage, admin_setting_sitesetselect, admin_setting_special_selectsetup, admin_setting_users_with_capability, admin_setting_configtime, admin_setting_configmultiselect, admin_setting_configselect, admin_setting_configmulticheckbox2, admin_setting_configmulticheckbox, admin_setting_configcheckbox, admin_setting_configtext, admin_setting_heading, mod_quiz_admin_review_setting, admin_setting_ldap_rolemapping, and admin_setting_ltimodule_configlink.

Here is the caller graph for this function:

is_related ( $  query)

Is setting related to query text - used when searching

Parameters:
string$query
Returns:
bool

Reimplemented in admin_setting_managewebserviceprotocols, admin_setting_manageexternalservices, admin_setting_managerepository, admin_setting_manageeditors, admin_setting_manageauths, admin_setting_manageenrols, admin_setting_configmultiselect, admin_setting_configselect, and admin_setting_configmulticheckbox.

Definition at line 1612 of file adminlib.php.

Here is the call graph for this function:

output_html ( $  data,
$  query = '' 
)

Return part of form with setting This function should always be overwritten

Parameters:
mixed$dataarray or string depending on setting
string$query
Returns:
string

Reimplemented in admin_setting_devicedetectregex, admin_setting_configcolourpicker, admin_setting_managewebservicetokens, admin_setting_managewebserviceprotocols, admin_setting_webservicesoverview, admin_setting_manageplagiarism, admin_setting_manageexternalservices, admin_setting_enablemobileservice, admin_setting_managerepository, admin_setting_managelicenses, admin_setting_manageeditors, admin_setting_manageauths, admin_setting_manageenrols, admin_setting_gradecat_combo, admin_setting_configselect_with_advanced, admin_setting_configcheckbox_with_lock, admin_setting_configcheckbox_with_advanced, admin_setting_configtext_with_advanced, admin_setting_special_calendar_weekend, admin_setting_emoticons, admin_setting_special_frontpagedesc, admin_setting_courselist_frontpage, admin_setting_configtime, admin_setting_configmultiselect, admin_setting_configselect, admin_setting_configmulticheckbox, admin_setting_configcheckbox, admin_setting_configdirectory, admin_setting_configexecutable, admin_setting_configfile, admin_setting_configpasswordunmask, admin_setting_confightmleditor, admin_setting_configtextarea, admin_setting_configtext, admin_setting_heading, admin_setting_ldap_rolemapping, mod_quiz_admin_review_setting, and admin_setting_ltimodule_configlink.

Definition at line 1593 of file adminlib.php.

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

Definition at line 1485 of file adminlib.php.

set_updatedcallback ( $  functionname)

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

Parameters:
string$functionnameSets the function name
Returns:
void

Definition at line 1603 of file adminlib.php.

write_setting ( $  data) [abstract]

Store new setting

Parameters:
mixed$datastring or array, must not be NULL
Returns:
string empty string if ok, string error message otherwise

Reimplemented in admin_setting_devicedetectregex, admin_setting_configcolourpicker, admin_setting_managewebservicetokens, admin_setting_managewebserviceprotocols, admin_setting_webservicesoverview, admin_setting_manageplagiarism, admin_setting_manageexternalservices, admin_setting_enablemobileservice, admin_setting_managerepository, admin_setting_managelicenses, admin_setting_manageeditors, admin_setting_manageauths, admin_setting_manageenrols, admin_setting_gradecat_combo, admin_setting_special_gradelimiting, admin_setting_regradingcheckbox, admin_setting_configselect_with_advanced, admin_setting_configcheckbox_with_lock, admin_setting_configcheckbox_with_advanced, admin_setting_configtext_with_advanced, admin_setting_special_calendar_weekend, admin_setting_langlist, admin_setting_emoticons, admin_setting_special_frontpagedesc, admin_setting_sitesettext, admin_setting_sitesetcheckbox, admin_setting_courselist_frontpage, admin_setting_bloglevel, admin_setting_sitesetselect, admin_setting_special_selectsetup, admin_setting_special_adminseesall, admin_setting_users_with_capability, admin_setting_configtime, admin_setting_configmultiselect, admin_setting_configselect, admin_setting_configmulticheckbox2, admin_setting_configmulticheckbox, admin_setting_configcheckbox, admin_setting_configtext, admin_setting_heading, mod_quiz_admin_review_setting, admin_setting_ldap_rolemapping, admin_setting_ltimodule_configlink, and admin_setting_configtext_trim_lower.

Field Documentation

$affectsmodinfo = false

Definition at line 1419 of file adminlib.php.

$defaultsetting

Definition at line 1411 of file adminlib.php.

$description

Definition at line 1409 of file adminlib.php.

$name

Definition at line 1405 of file adminlib.php.

$nosave = false

Definition at line 1417 of file adminlib.php.

$plugin

Definition at line 1415 of file adminlib.php.

$updatedcallback

Definition at line 1413 of file adminlib.php.

$visiblename

Definition at line 1407 of file adminlib.php.

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations