CKEditorPluginContextualInterface
interface CKEditorPluginContextualInterface implements CKEditorPluginInterface (View source)
Defines an interface for contextually enabled CKEditor plugins.
Contextually enabled CKEditor plugins can be enabled via an explicit setting, or enable themselves based on the configuration of another setting, such as enabling based on a particular button being present in the toolbar.
If a contextually enabled CKEditor plugin must also be configurable (for instance, in the case where it must be enabled based on an explicit setting), then one must also implement the CKEditorPluginConfigurableInterface interface.
Methods
Gets the definition of the plugin implementation.
Indicates if this plugin is part of the optimized CKEditor build.
Returns the Drupal root-relative file path to the plugin JavaScript file.
Details
string
getPluginId()
Gets the plugin_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isInternal()
Indicates if this plugin is part of the optimized CKEditor build.
Plugins marked as internal are implicitly loaded as part of CKEditor.
array
getDependencies(Editor $editor)
Returns a list of plugins this plugin requires.
array
getLibraries(Editor $editor)
Returns a list of libraries this plugin requires.
These libraries will be attached to the text_format element on which the editor is being loaded.
string|false
getFile()
Returns the Drupal root-relative file path to the plugin JavaScript file.
Note: this does not use a Drupal library because this uses CKEditor's API.
array
getConfig(Editor $editor)
Returns the additions to CKEDITOR.config for a specific CKEditor instance.
The editor's settings can be retrieved via $editor->getSettings(), but be aware that it may not yet contain plugin-specific settings, because the user may not yet have configured the form. If there are plugin-specific settings (verify with isset()), they can be found at
bool
isEnabled(Editor $editor)
Checks if this plugin should be enabled based on the editor configuration.
The editor's settings can be retrieved via $editor->getSettings().