class EditorBase

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

Expanded class hierarchy of EditorBase

See also

\Drupal\editor\Annotation\Editor

\Drupal\editor\Plugin\EditorPluginInterface

\Drupal\editor\Plugin\EditorManager

Plugin API

3 files declare their use of EditorBase
CKEditor5.php in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
TRexEditor.php in core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/TRexEditor.php
UnicornEditor.php in core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php

File

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

Namespace

Drupal\editor\Plugin
View source
abstract class EditorBase extends PluginBase implements EditorPluginInterface {
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultSettings() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AutowiredInstanceTrait::createInstanceAutowired public static function Instantiates a new instance of the implementing class using autowiring.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EditorBase::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm 3
EditorBase::getDefaultSettings public function Overrides EditorPluginInterface::getDefaultSettings 3
EditorBase::submitConfigurationForm public function Overrides PluginFormInterface::submitConfigurationForm 1
EditorBase::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 1
EditorPluginInterface::getJSSettings public function Returns JavaScript settings to be attached. 3
EditorPluginInterface::getLibraries public function Returns libraries to be attached. 3
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::create public static function Instantiates a new instance of the implementing class using autowiring. 163
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 80
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1

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