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: 2017 Damyon Wiese
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 193 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: fileconverter  - X-Ref

Class for document converter plugins

plugintype_supports_disabling()   X-Ref
No description

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

Uninstallation is allowed for fileconverter plugins.

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 availability 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_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

enable_plugin(string $pluginname, int $enabled)   X-Ref
No description

set_enabled($newstate = true)   X-Ref
Sets the current plugin as enabled or disabled
When enabling tries to guess the sortorder based on default rank returned by the plugin.

param: bool $newstate

set_enabled_plugins($list)   X-Ref
Set the list of enabled converter players in the specified sort order
To be used when changing settings or in unit tests

param: string|array $list list of plugin names without frankenstyle prefix - comma-separated string or an array

get_supported_conversions()   X-Ref
Returns a string describing the formats this engine can converter from / to.

return: string

get_classname($plugin)   X-Ref
Return the class name for the plugin.

param: string $plugin
return: string