interface CKEditorPluginContextualInterface

Same name in other branches
  1. 9 core/modules/ckeditor/src/CKEditorPluginContextualInterface.php \Drupal\ckeditor\CKEditorPluginContextualInterface

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.

Hierarchy

Expanded class hierarchy of CKEditorPluginContextualInterface

All classes that implement CKEditorPluginContextualInterface

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginCssInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

5 files declare their use of CKEditorPluginContextualInterface
DrupalImageCaption.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php
DrupalMedia.php in core/modules/media/src/Plugin/CKEditorPlugin/DrupalMedia.php
Internal.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Internal.php
LlamaContextual.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextual.php
LlamaContextualAndButton.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php

File

core/modules/ckeditor/src/CKEditorPluginContextualInterface.php, line 28

Namespace

Drupal\ckeditor
View source 
interface CKEditorPluginContextualInterface extends CKEditorPluginInterface {
    
    /**
     * Checks if this plugin should be enabled based on the editor configuration.
     *
     * The editor's settings can be retrieved via $editor->getSettings().
     *
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     *
     * @return bool
     */
    public function isEnabled(Editor $editor);

}

Members

Title Modifiers Object type Summary Overrides
CKEditorPluginContextualInterface::isEnabled public function Checks if this plugin should be enabled based on the editor configuration. 5
CKEditorPluginInterface::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. 9
CKEditorPluginInterface::getDependencies public function Returns a list of plugins this plugin requires. 4
CKEditorPluginInterface::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. 9
CKEditorPluginInterface::getLibraries public function Returns a list of libraries this plugin requires. 4
CKEditorPluginInterface::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. 4
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.