interface CKEditorPluginContextualInterface in Zircon Profile 8.0

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 (e.g. in the case where it must be enabled based on an explicit setting), then one must also implement the CKEditorPluginConfigurableInterface interface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\ckeditor\CKEditorPluginInterface
    • interface \Drupal\ckeditor\CKEditorPluginContextualInterface

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

3 files declare their use of CKEditorPluginContextualInterface

DrupalImageCaption.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php

Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImageCaption.

LlamaContextual.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextual.php

Contains \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextual.

LlamaContextualAndButton.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php

Contains \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton.

File

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

Contains \Drupal\ckeditor\CKEditorPluginContextualInterface.

Namespace

Drupal\ckeditor

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

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