Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/classes/plugininfo/ -> contenttype.php (source)

[Source view]

Differences Between: [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

Defines classes used for plugin info.

Copyright: 2020 Amaia Anabitarte <amaia@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 203 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

contenttype:: (8 methods):
  is_uninstall_allowed()
  get_settings_section_name()
  load_settings()
  get_manage_url()
  get_plugins()
  get_enabled_plugins()
  get_uninstall_extra_warning()
  uninstall_cleanup()


Class: contenttype  - X-Ref

Class for contentbank plugins

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

return: bool

get_settings_section_name()   X-Ref
Get the name for the settings section.

return: string

load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig)   X-Ref
Load the global settings for a particular contentbank plugin (if there are any)

param: \part_of_admin_tree $adminroot
param: string $parentnodename
param: bool $hassiteconfig

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

return: \moodle_url

get_plugins($type, $typerootdir, $typeclass, $pluginman)   X-Ref
Gathers and returns the information about all plugins of the given type

param: string $type the name of the plugintype, eg. mod, auth or workshopform
param: string $typerootdir full path to the location of the plugin dir
param: string $typeclass the name of the actually called class
param: core_plugin_manager $pluginman the plugin manager calling this method
return: array of plugintype classes, indexed by the plugin name

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_uninstall_extra_warning()   X-Ref
Optional extra warning before uninstallation adding number of existing contenttype contents.

return: string

uninstall_cleanup()   X-Ref
Pre-uninstall hook.

This is intended for disabling of plugin, some DB table purging, etc.

NOTE: to be called from uninstall_plugin() only.