Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

Defines classes used for plugin info.

Copyright: 2011 David Mudrak <david@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 190 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: repository  - X-Ref

Class for repositories

plugintype_supports_disabling()   X-Ref
No description

get_enabled_plugins()   X-Ref
Finds all enabled plugins, the result may include missing plugins.

return: array|null of enabled plugins $pluginname=>$pluginname, null means unknown

get_enabled_plugin(string $pluginname)   X-Ref
Returns current status for a pluginname.

Repositories needs to be calculated in a different way than the default method in the base class because they need to take
into account the value of the visible column too.

param: string $pluginname The plugin name to check.
return: int The current status (enabled, disabled...) of $pluginname.

enable_plugin(string $pluginname, int $enabled)   X-Ref
Enable or disable a plugin.
When possible, the change will be stored into the config_log table, to let admins check when/who has modified it.

param: string $pluginname The plugin name to enable/disable.
param: int $enabled Whether the pluginname should be enabled and visible (1), enabled but hidden (0) or disabled (-1).
return: bool Whether $pluginname has been updated or not.

get_settings_section_name()   X-Ref
No description

load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig)   X-Ref
No description

get_manage_url()   X-Ref
Return URL used for management of plugins of this type.

return: moodle_url

is_uninstall_allowed()   X-Ref
Defines if there should be a way to uninstall the plugin via the administration UI.

return: boolean

uninstall_cleanup()   X-Ref
Pre-uninstall hook.
This is intended for disabling of plugin, some DB table purging, etc.
Converts all linked files to standard files when repository is removed
and cleans up all records in the DB for that repository.