plugin_information Interface Reference

Inheritance diagram for plugin_information:

Public Member Functions
	init_display_name ()
	load_disk_version ()
	load_db_version ()
	load_required_main_version ()
	init_is_standard ()
	is_standard ()
	get_status ()
	get_other_required_plugins ()
	is_enabled ()
	get_settings_url ()
	get_uninstall_url ()
	get_dir ()
	full_path ($relativepath)
Static Public Member Functions
static	get_plugins ($type, $typerootdir, $typeclass)

---

Detailed Description

Definition at line 522 of file pluginlib.php.

---

Member Function Documentation

full_path

(

$

relativepath

)

Return the full path name of a file within the plugin. No check is made to see if the file exists.

Parameters:

string

$relativepath

e.g. 'version.php'.

Returns:

string e.g. $CFG->dirroot . '/mod/quiz/version.php'.

Here is the caller graph for this function:

get_dir

(

)

get_other_required_plugins

(

)

Get the list of other plugins that this plugin requires ot be installed.

Returns:

array with keys the frankenstyle plugin name, and values either a version string (like '2011101700') or the constant ANY_VERSION.

Here is the caller graph for this function:

static get_plugins	(	$	type,
		$	typerootdir,
		$	typeclass
	)		[static]

Implemented in plugintype_mod, plugintype_filter, and plugintype_block.

get_settings_url

(

)

Returns the URL of the plugin settings screen

Null value means that the plugin either does not have the settings screen or its location is not available via this library.

Returns:

null|moodle_url

Implemented in plugintype_repository, plugintype_message, plugintype_enrol, plugintype_auth, plugintype_mod, plugintype_filter, and plugintype_block.

get_status

(

)

Returns the status of the plugin

Returns:

string one of plugin_manager::PLUGIN_STATUS_xxx constants

get_uninstall_url

(

)

Returns the URL of the screen where this plugin can be uninstalled

Visiting that URL must be safe, that is a manual confirmation is needed for actual uninstallation of the plugin. Null value means that the plugin either does not support uninstallation, or does not require any database cleanup or the location of the screen is not available via this library.

Returns:

null|moodle_url

Implemented in plugintype_report, plugintype_tool, plugintype_enrol, plugintype_qtype, plugintype_qbehaviour, plugintype_mod, plugintype_filter, and plugintype_block.

init_display_name

(

)

Sets $displayname property to a localized name of the plugin

Returns:

void

Implemented in plugintype_mod, plugintype_filter, and plugintype_block.

init_is_standard

(

)

Sets $source property to one of plugin_manager::PLUGIN_SOURCE_xxx constants.

If the property's value is null after calling this method, then the type of the plugin has not been recognized and you should throw an exception.

Returns:

void

is_enabled

(

)

Returns the information about plugin availability

True means that the plugin is enabled. False means that the plugin is disabled. Null means that the information is not available, or the plugin does not support configurable availability or the availability can not be changed.

Returns:

null|bool

Implemented in plugintype_mnetservice, plugintype_theme, plugintype_portfolio, plugintype_repository, plugintype_mod, plugintype_filter, and plugintype_block.

Here is the caller graph for this function:

is_standard

(

)

Returns true if the plugin is shipped with the official distribution of the current Moodle version, false otherwise.

Returns:

bool

load_db_version

(

)

Sets $versiondb property to a numerical value representing the currently installed version of the plugin.

If the value is null after calling this method, either the plugin does not use versioning (typically does not have any database data) or has not been installed yet.

Returns:

void

Implemented in plugintype_mod, and plugintype_block.

load_disk_version

(

)

Sets $versiondisk property to a numerical value representing the version of the plugin's source code.

If the value is null after calling this method, either the plugin does not use versioning (typically does not have any database data) or is missing from disk.

Returns:

void

load_required_main_version

(

)

Sets $versionrequires property to a numerical value representing the version of Moodle core that this plugin requires.

Returns:

void

---

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

• C:/xampp/htdocs/moodle/lib/pluginlib.php