Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
editor_tiny\manager Class Reference

Public Member Functions

 get_plugin_configuration (context $context, array $options=[], array $fpoptions=[], ?editor $editor=null)
 Get the configuration for all plugins.
 

Protected Member Functions

 get_available_plugins ()
 Return a list of all available plugins, including both TinyMCE shipped, and Moodle add-onis.
 
 get_disabled_tinymce_plugins ()
 Get a list of the built-in TinyMCE plugins which we want to disable.
 
 get_moodle_plugins ()
 Get a list of the Moodle plugins with their button, and menuitem, configuration.
 
 get_premium_plugins ()
 Get a list of the Tiny Premium plugins with their button, and menuitem, configuration.
 
 get_shipped_plugins ()
 Return a list of all available plugins built into TinyMCE and not shipped as separate Moodle plugins.
 
 get_tinymce_buttons ()
 Get a list of the buttons provided by this plugin.
 
 get_tinymce_menuitems ()
 Get a list of the menu items provided by this plugin.
 
 get_tinymce_plugins ()
 Get a list of the core plugins with their button, and menuitem, configuration.
 
 premium_plugins_enabled ()
 Check whether premium plugins are configured and enabled.
 

Member Function Documentation

◆ get_available_plugins()

editor_tiny\manager::get_available_plugins ( )
protected

Return a list of all available plugins, including both TinyMCE shipped, and Moodle add-onis.

Each plugin is returned as an array element containing:

  • a list of buttons (if applicable); and
  • a list of menuitems (if applicable).

Note: Not all plugins include buttons, and not all plugins include menuitems. These array keys are optional.

Return values
array

◆ get_disabled_tinymce_plugins()

editor_tiny\manager::get_disabled_tinymce_plugins ( )
protected

Get a list of the built-in TinyMCE plugins which we want to disable.

These are usually disabled because we have replaced them, or they are not compatible with Moodle in some way.

Return values
string[]

◆ get_moodle_plugins()

editor_tiny\manager::get_moodle_plugins ( )
protected

Get a list of the Moodle plugins with their button, and menuitem, configuration.

Return values
array[]

◆ get_plugin_configuration()

editor_tiny\manager::get_plugin_configuration ( context $context,
array $options = [],
array $fpoptions = [],
?editor $editor = null )

Get the configuration for all plugins.

Parameters
context$contextThe context that the editor is used within
array$optionsThe options passed in when requesting the editor
array$fpoptionsThe filepicker options passed in when requesting the editor
editor$editorThe editor instance in which the plugin is initialised

◆ get_premium_plugins()

editor_tiny\manager::get_premium_plugins ( )
protected

Get a list of the Tiny Premium plugins with their button, and menuitem, configuration.

Note: This only includes compatible premium plugins. Some premium plugins may not be compatible with Moodle, and some may require additional configuration.

Return values
array[]

◆ get_shipped_plugins()

editor_tiny\manager::get_shipped_plugins ( )
protected

Return a list of all available plugins built into TinyMCE and not shipped as separate Moodle plugins.

Each plugin is returned as an array element containing:

  • a list of buttons (if applicable); and
  • a list of menuitems (if applicable).

Note: Not all plugins include buttons, and not all plugins include menuitems. These array keys are optional.

Return values
array

◆ get_tinymce_buttons()

editor_tiny\manager::get_tinymce_buttons ( )
protected

Get a list of the buttons provided by this plugin.

Return values
string[]

◆ get_tinymce_menuitems()

editor_tiny\manager::get_tinymce_menuitems ( )
protected

Get a list of the menu items provided by this plugin.

Return values
string[]

◆ get_tinymce_plugins()

editor_tiny\manager::get_tinymce_plugins ( )
protected

Get a list of the core plugins with their button, and menuitem, configuration.

Return values
array[]

◆ premium_plugins_enabled()

editor_tiny\manager::premium_plugins_enabled ( )
protected

Check whether premium plugins are configured and enabled.

Return values
bool

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