interface CKEditorPluginConfigurableInterface

Defines an interface for configurable CKEditor plugins.

This allows a CKEditor plugin to define a settings form. These settings can then be automatically passed on to the corresponding CKEditor instance via CKEditorPluginInterface::getConfig().

Hierarchy

Expanded class hierarchy of CKEditorPluginConfigurableInterface

All classes that implement CKEditorPluginConfigurableInterface

See also

CKEditorPluginInterface

CKEditorPluginButtonsInterface

CKEditorPluginContextualInterface

2 files declare their use of CKEditorPluginConfigurableInterface
LlamaContextualAndButton.php in drupal/core/modules/ckeditor/tests/modules/lib/Drupal/ckeditor_test/Plugin/CKEditorPlugin/LlamaContextualAndButton.php
Contains \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton.
StylesCombo.php in drupal/core/modules/ckeditor/lib/Drupal/ckeditor/Plugin/CKEditorPlugin/StylesCombo.php
Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\StylesCombo.

File

drupal/core/modules/ckeditor/lib/Drupal/ckeditor/CKEditorPluginConfigurableInterface.php, line 23
Contains \Drupal\ckeditor\CKEditorPluginConfigurableInterface.

Namespace

Drupal\ckeditor
View source
interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {

  /**
   * Returns a settings form to configure this CKEditor plugin.
   *
   * If the plugin's behavior depends on extensive options and/or external data,
   * then the implementing module can choose to provide a separate, global
   * configuration page rather than per-text-editor settings. In that case, this
   * form should provide a link to the separate settings page.
   *
   * @param array $form
   *   An empty form array to be populated with a configuration form, if any.
   * @param array $form_state
   *   The state of the entire filter administration form.
   * @param \Drupal\editor\Plugin\Core\Entity\Editor $editor
   *   A configured text editor object.
   *
   * @return array|FALSE
   *   A render array for the settings form, or FALSE if there is none.
   */
  function settingsForm(array $form, array &$form_state, Editor $editor);

}

Members

Namesort descending Modifiers Type Description Overrides
CKEditorPluginConfigurableInterface::settingsForm function Returns a settings form to configure this CKEditor plugin. 2
CKEditorPluginInterface::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. 3
CKEditorPluginInterface::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. 3
CKEditorPluginInterface::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. 2
PluginInspectionInterface::getPluginDefinition public function Returns the definition of the plugin implementation. 1
PluginInspectionInterface::getPluginId public function Returns the plugin_id of the plugin instance. 1