Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/classes/plugininfo/ -> media.php (source)

[Source view]

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

Defines classes used for plugin info.

Copyright: 2016 Marina Glancy
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 188 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

media:: (9 methods):
  is_uninstall_allowed()
  get_settings_section_name()
  load_settings()
  get_manage_url()
  get_enabled_plugins()
  set_enabled()
  set_enabled_plugins()
  get_rank()
  supports()


Class: media  - X-Ref

Class for media plugins

is_uninstall_allowed()   X-Ref
No description

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
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 media 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_rank()   X-Ref
Returns the default rank of this plugin for default sort order

return: int

supports(&$extensions)   X-Ref
Returns human-readable string of supported file/link types for the "Manage media players" page

param: array $extensions
return: string