editor_tiny\plugin Class Reference

Tiny Editor Plugin class. More...

Inheritance diagram for editor_tiny\plugin:

Static Public Member Functions
static	get_plugin_info (context $context, array $options, array $fpoptions, ?editor $editor=null)
	Get the plugin information for the plugin.
static	is_enabled (context $context, array $options, array $fpoptions, ?editor $editor=null)
	Whether the plugin is enabled.

Detailed Description

Tiny Editor Plugin class.

This class must be implemented by any Moodle plugin adding TinyMCE features.

It should optionally implement the following interfaces:

• plugin_with_buttons: to add buttons to the TinyMCE toolbar
• plugin_with_menuitems
• plugin_with_configuration: to add configuration to the TinyMCE editor

Copyright

2021 Andrew Lyons andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_plugin_info()

static editor_tiny\plugin::get_plugin_info ( context $context, array $options, array $fpoptions, ?editor $editor = null )

staticfinal

Get the plugin information for the plugin.

Parameters

context	$context	The context that the editor is used within
array	$options	The options passed in when requesting the editor
array	$fpoptions	The filepicker options passed in when requesting the editor
editor	$editor	The editor instance in which the plugin is initialised

Return values

array

is_enabled()

static editor_tiny\plugin::is_enabled ( context $context, array $options, array $fpoptions, ?editor $editor = null )

static

Whether the plugin is enabled.

Parameters

context	$context	The context that the editor is used within
array	$options	The options passed in when requesting the editor
array	$fpoptions	The filepicker options passed in when requesting the editor
editor	$editor	The editor instance in which the plugin is initialised

Return values

boolean

Reimplemented in tiny_media\plugininfo, tiny_premium\plugininfo, and tiny_recordrtc\plugininfo.

---

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

• lib/editor/tiny/classes/plugin.php