abstract class EditorBase in Zircon Profile 8

Defines a base class from which other modules providing editors may extend.

This class provides default implementations of the EditorPluginInterface so that classes extending this one do not need to implement every method.

Plugins extending this class need to specify an annotation containing the plugin definition so the plugin can be discovered.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\editor\Plugin\EditorBase implements EditorPluginInterface

See also

\Drupal\editor\Annotation\Editor

\Drupal\editor\Plugin\EditorPluginInterface

\Drupal\editor\Plugin\EditorManager

Plugin API

3 files declare their use of EditorBase

CKEditor.php in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php

Contains \Drupal\ckeditor\Plugin\Editor\CKEditor.

TRexEditor.php in core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php

Contains \Drupal\editor_test\Plugin\Editor\TRexEditor.

UnicornEditor.php in core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php

Contains \Drupal\editor_test\Plugin\Editor\UnicornEditor.

File

core/modules/editor/src/Plugin/EditorBase.php, line 28

Contains \Drupal\editor\Plugin\EditorBase.

Namespace

Drupal\editor\Plugin

abstract class EditorBase extends PluginBase implements EditorPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getDefaultSettings() {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsFormValidate(array $form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function settingsFormSubmit(array $form, FormStateInterface $form_state) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EditorBase::getDefaultSettings	public	function	Returns the default settings for this configurable text editor. Overrides EditorPluginInterface::getDefaultSettings	3
EditorBase::settingsForm	public	function	Returns a settings form to configure this text editor. Overrides EditorPluginInterface::settingsForm	3
EditorBase::settingsFormSubmit	public	function	Modifies any values in the form state to prepare them for saving. Overrides EditorPluginInterface::settingsFormSubmit	1
EditorBase::settingsFormValidate	public	function	Validates the settings form for an editor. Overrides EditorPluginInterface::settingsFormValidate
EditorPluginInterface::getJSSettings	public	function	Returns JavaScript settings to be attached.	3
EditorPluginInterface::getLibraries	public	function	Returns libraries to be attached.	3
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.