Data Structures
interface	part_of_admin_tree
	CLASS DEFINITIONS /////////////////////////////////////////////////////////. More...
interface	parentable_part_of_admin_tree
class	admin_category
class	admin_root
class	admin_externalpage
class	admin_settingpage
class	admin_setting
class	admin_setting_heading
class	admin_setting_configtext
class	admin_setting_configtextarea
class	admin_setting_confightmleditor
class	admin_setting_configpasswordunmask
class	admin_setting_configfile
class	admin_setting_configexecutable
class	admin_setting_configdirectory
class	admin_setting_configcheckbox
class	admin_setting_configmulticheckbox
class	admin_setting_configmulticheckbox2
class	admin_setting_configselect
class	admin_setting_configmultiselect
class	admin_setting_configtime
class	admin_setting_configiplist
class	admin_setting_users_with_capability
class	admin_setting_special_adminseesall
class	admin_setting_special_selectsetup
class	admin_setting_sitesetselect
class	admin_setting_bloglevel
class	admin_setting_courselist_frontpage
class	admin_setting_sitesetcheckbox
class	admin_setting_sitesettext
class	admin_setting_special_frontpagedesc
class	admin_setting_emoticons
class	admin_setting_langlist
class	admin_settings_country_select
class	admin_settings_num_course_sections
class	admin_settings_coursecat_select
class	admin_setting_special_backupdays
class	admin_setting_special_debug
class	admin_setting_special_calendar_weekend
class	admin_setting_question_behaviour
class	admin_setting_pickroles
class	admin_setting_configtext_with_advanced
class	admin_setting_configcheckbox_with_advanced
class	admin_setting_configcheckbox_with_lock
class	admin_setting_configselect_with_advanced
class	admin_setting_special_gradebookroles
class	admin_setting_regradingcheckbox
class	admin_setting_special_coursecontact
class	admin_setting_special_gradelimiting
class	admin_setting_special_gradeexport
class	admin_setting_gradecat_combo
class	admin_setting_grade_profilereport
class	admin_setting_special_registerauth
class	admin_page_pluginsoverview
class	admin_page_managemods
class	admin_setting_manageenrols
class	admin_page_manageblocks
class	admin_page_managemessageoutputs
class	admin_page_defaultmessageoutputs
class	admin_page_manageqbehaviours
class	admin_page_manageqtypes
class	admin_page_manageportfolios
class	admin_page_managerepositories
class	admin_setting_manageauths
class	admin_setting_manageeditors
class	admin_setting_managelicenses
class	admin_page_managefilters
class	admin_setting_managerepository
class	admin_setting_enablemobileservice
class	admin_setting_manageexternalservices
class	admin_setting_manageplagiarism
class	admin_setting_webservicesoverview
class	admin_setting_managewebserviceprotocols
class	admin_setting_managewebservicetokens
class	admin_setting_configcolourpicker
class	admin_setting_devicedetectregex
class	admin_setting_configmultiselect_modules
Namespaces
namespace	core
Enumerations
enum	INSECURE_DATAROOT_WARNING
	Add libraries. More...
enum	INSECURE_DATAROOT_ERROR
Functions
	uninstall_plugin ($type, $name)
	get_component_version ($component, $source='installed')
	drop_plugin_tables ($name, $file, $feedback=true)
	get_used_table_names ()
	get_db_directories ()
	set_cron_lock ($name, $until, $ignorecurrent=false)
	admin_critical_warnings_present ()
	is_float_problem ()
	is_dataroot_insecure ($fetchtest=false)
	admin_externalpage_setup ($section, $extrabutton= '', array $extraurlparams=null, $actualurl= '', array $options=array())
	admin_get_root ($reload=false, $requirefulltree=true)
	admin_apply_default_settings ($node=NULL, $unconditional=true)
	settings utility functions
	admin_write_settings ($formdata)
	admin_find_write_settings ($node, $data)
	admin_search_settings_html ($query)
	admin_output_new_settings_by_page ($node)
	format_admin_setting ($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='')
	any_new_admin_settings ($node)
	db_replace ($search, $replace)

Enumeration Type Documentation

enum INSECURE_DATAROOT_ERROR

Definition at line 113 of file adminlib.php.

enum INSECURE_DATAROOT_WARNING

Add libraries.

Definition at line 112 of file adminlib.php.

Function Documentation

admin_apply_default_settings	(	$	node = `NULL`,
		$	unconditional = `true`
	)

settings utility functions

This function applies default settings.

Parameters:

object	$node,NULL	means complete tree, null by default
bool	$unconditional	if true overrides all values with defaults, null buy default

Definition at line 5945 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

admin_critical_warnings_present ( )

Test if and critical warnings are present

Returns:: bool

Definition at line 522 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

admin_externalpage_setup	(	$	section,
		$	extrabutton = `''`,
		array $	extraurlparams = `null`,
		$	actualurl = `''`,
		array $	options = `array()`
	)

Initialise admin page - this function does require login and permission checks specified in page definition.

This function must be called on each admin page before other code.

moodle_page $PAGE

Parameters:

string	$section	name of page
string	$extrabutton	extra HTML that is added after the blocks editing on/off button.
array	$extraurlparams	an array paramname => paramvalue, or parameters that need to be added to the turn blocks editing on/off form, so this page reloads correctly.
string	$actualurl	if the actual page being viewed is not the normal one for this page (e.g. admin/roles/allow.php, instead of admin/roles/manage.php, you can pass the alternate URL here.
array	$options	Additional options that can be specified for page setup. pagelayout - This option can be used to set a specific pagelyaout, admin is default.

Definition at line 5806 of file adminlib.php.

Here is the call graph for this function:

admin_find_write_settings	(	$	node,
		$	data
	)

Internal recursive function - finds all settings from submitted form

Parameters:

object	$node	Instance of admin_category, or admin_settingpage
array	$data

Returns:: array

Definition at line 6039 of file adminlib.php.

Here is the caller graph for this function:

admin_get_root	(	$	reload = `false`,
		$	requirefulltree = `true`
	)

Returns the reference to admin tree root

Returns:: object admin_root object

Definition at line 5900 of file adminlib.php.

Here is the caller graph for this function:

admin_output_new_settings_by_page ( $ node )

Internal function - returns arrays of html pages with uninitialised settings

Parameters:

object $node Instance of admin_category or admin_settingpage

Returns:: array

Definition at line 6132 of file adminlib.php.

Here is the call graph for this function:

admin_search_settings_html ( $ query )

Internal function - prints the search results

Parameters:

string $query String to search for

Returns:: string empty or XHTML

Definition at line 6071 of file adminlib.php.

Here is the call graph for this function:

admin_write_settings ( $ formdata )

Store changed settings, this function updates the errors variable in $ADMIN

Parameters:

object $formdata from form

Returns:: int number of changed settings

Definition at line 5980 of file adminlib.php.

Here is the call graph for this function:

any_new_admin_settings ( $ node )

Based on find_new_settings() in upgradesettings.php Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.

Parameters:

object $node Instance of admin_category, or admin_settingpage

Returns:: boolean true if any settings haven't been initialised, false if they all have

Definition at line 6252 of file adminlib.php.

db_replace	(	$	search,
		$	replace
	)

Moved from admin/replace.php so that we can use this in cron

Parameters:

string	$search	string to look for
string	$replace	string to replace

Returns:: bool success or fail

Definition at line 6280 of file adminlib.php.

Here is the call graph for this function:

drop_plugin_tables	(	$	name,
		$	file,
		$	feedback = `true`
	)

Delete all plugin tables

Parameters:

string	$name	Name of plugin, used as table prefix
string	$file	Path to install.xml file
bool	$feedback	defaults to true

Returns:: bool Always returns true

Iterate over, fixing id fields as necessary

Definition at line 395 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

format_admin_setting	(	$	setting,
		$	title = `''`,
		$	form = `''`,
		$	description = `''`,
		$	label = `true`,
		$	warning = `''`,
		$	defaultinfo = `NULL`,
		$	query = `''`
	)

Format admin settings

Parameters:

object	$setting
string	$title	label element
string	$form	form fragment, html code - not highlighted automatically
string	$description
bool	$label	link label to id, true by default
string	$warning	warning text
sting	$defaultinfo	defaults info, null means nothing, '' is converted to "Empty" string, defaults to null
string	$query	search query to be highlighted

Returns:: string XHTML

Definition at line 6187 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_component_version	(	$	component,
		$	source = `'installed'`
	)

Returns the version of installed component

Parameters:

string	$component	component name
string	$source	either 'disk' or 'installed' - where to get the version information from

Returns:: string|bool version number or false if the component is not found

Definition at line 316 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_db_directories ( )

Returns list of all directories where we expect install.xml files

Returns:: array Array of paths

First, the main one (lib/db)

Then, all the ones defined by get_plugin_types()

Definition at line 463 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_used_table_names ( )

Returns names of all known tables == tables that moodle knows about.

Returns:: array Array of lowercase table names

Definition at line 433 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

is_dataroot_insecure ( $ fetchtest = false )

Try to verify that dataroot is not accessible from web.

Try to verify that dataroot is not accessible from web. It is not 100% correct but might help to reduce number of vulnerable sites. Protection from httpd.conf and .htaccess is not detected properly.

INSECURE_DATAROOT_WARNING INSECURE_DATAROOT_ERROR

Parameters:

bool $fetchtest try to test public access by fetching file, default false

Returns:: mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic

Definition at line 566 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

is_float_problem ( )

Detects if float supports at least 10 decimal digits

Detects if float supports at least 10 decimal digits and also if float-->string conversion works as expected.

Returns:: bool true if problem found

Definition at line 547 of file adminlib.php.

set_cron_lock	(	$	name,
		$	until,
		$	ignorecurrent = `false`
	)

Try to obtain or release the cron lock.

Parameters:

string	$name	name of lock
int	$until	timestamp when this lock considered stale, null means remove lock unconditionally
bool	$ignorecurrent	ignore current lock state, usually extend previous lock, defaults to false

Returns:: bool true if lock obtained

Definition at line 491 of file adminlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

uninstall_plugin	(	$	type,
		$	name
	)

Automatically clean-up all plugin data and remove the plugin DB tables

Parameters:

string	$type	The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc.
string	$name	The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc. global $OUTPUT to produce notices and other messages

Returns:: void

Definition at line 123 of file adminlib.php.

Here is the call graph for this function:

Data Structures

Namespaces

Enumerations

Functions

Enumeration Type Documentation

Function Documentation