tiny_premium\plugininfo Class Reference

Inheritance diagram for tiny_premium\plugininfo:

Static Public Member Functions
static	get_plugin_configuration_for_context (context $context, array $options, array $fpoptions, ?editor $editor=null)
	Get a list of enabled Tiny Premium plugins set by the admin.
static	get_plugin_configuration_for_external (context $context)
	Get the configuration for external functions provided by this plugin.
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 and accessible (e.g.
static	is_enabled_for_external (context $context, array $options)
	Whether the plugin is enabled and accessible for external functions.

Member Function Documentation

get_plugin_configuration_for_context()

static tiny_premium\plugininfo::get_plugin_configuration_for_context ( context $context, array $options, array $fpoptions, ?editor $editor = null )

static

Get a list of enabled Tiny Premium plugins set by the admin.

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 | null	$editor	The editor instance in which the plugin is initialised

Return values

array

Implements editor_tiny\plugin_with_configuration.

get_plugin_configuration_for_external()

static tiny_premium\plugininfo::get_plugin_configuration_for_external ( context $context )

static

Get the configuration for external functions provided by this plugin.

Parameters

context

$context

The context that the editor is used within.

Return values

array

Implements editor_tiny\plugin_with_configuration_for_external.

get_plugin_info()

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

staticfinalinherited

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 tiny_premium\plugininfo::is_enabled ( context $context, array $options, array $fpoptions, ?editor $editor = null )

static

Whether the plugin is enabled and accessible (e.g.

capability checks).

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 from editor_tiny\plugin.

is_enabled_for_external()

static editor_tiny\plugin::is_enabled_for_external ( context $context, array $options )

staticinherited

Whether the plugin is enabled and accessible for external functions.

Parameters

context	$context	The context that the editor is used within.
array	$options	Additional options: pluginname: Name of the plugin, without the "tiny_" prefix.

Return values

bool

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

---

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

• lib/editor/tiny/plugins/premium/classes/plugininfo.php