Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
tiny_premium\plugininfo Class Reference
Inheritance diagram for tiny_premium\plugininfo:
editor_tiny\plugin editor_tiny\plugin_with_configuration

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_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)
 Determine if the plugin should be enabled by checking the capability and if the Tiny Premium API key is set.
 

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$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 | null$editorThe editor instance in which the plugin is initialised
Return values
array

Implements editor_tiny\plugin_with_configuration.

◆ 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$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
Return values
array

◆ is_enabled()

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

Determine if the plugin should be enabled by checking the capability and if the Tiny Premium API key is set.

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
Return values
bool

Reimplemented from editor_tiny\plugin.


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