abstract class CKEditorPluginBase in Zircon Profile 8

Defines a base CKEditor plugin implementation.

No other CKEditor plugins can be internal, unless a different CKEditor build than the one provided by Drupal core is used. Most CKEditor plugins don't need to provide additional settings forms.

This base assumes that your plugin has buttons that you want to be enabled through the toolbar builder UI. It is still possible to also implement the CKEditorPluginContextualInterface (for contextual enabling) and CKEditorPluginConfigurableInterface interfaces (for configuring plugin settings) though.

NOTE: the Drupal plugin ID should correspond to the CKEditor plugin name.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginContextualInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

4 files declare their use of CKEditorPluginBase

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

Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImage.

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

Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalLink.

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

Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\Internal.

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

Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\StylesCombo.

File

core/modules/ckeditor/src/CKEditorPluginBase.php, line 36

Contains \Drupal\ckeditor\CKEditorPluginBase.

Namespace

Drupal\ckeditor

abstract class CKEditorPluginBase extends PluginBase implements CKEditorPluginInterface, CKEditorPluginButtonsInterface {

  /**
   * {@inheritdoc}
   */
  function isInternal() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  function getDependencies(Editor $editor) {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  function getLibraries(Editor $editor) {
    return array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::getDependencies		function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
CKEditorPluginBase::getLibraries		function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries	2
CKEditorPluginBase::isInternal		function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	2
CKEditorPluginButtonsInterface::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata.	6
CKEditorPluginInterface::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance.	6
CKEditorPluginInterface::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file.	6
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.