Same name and namespace in other branches
  1. 8.9.x core/modules/editor/src/Plugin/EditorBase.php \Drupal\editor\Plugin\EditorBase
  2. 9 core/modules/editor/src/Plugin/EditorBase.php \Drupal\editor\Plugin\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

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

Namesort ascending Modifiers Type Description Overrides
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 40
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 1
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::messenger public function Gets the messenger. 8
MessengerTrait::$messenger protected property The messenger. 8
EditorPluginInterface::getLibraries public function Returns libraries to be attached.
EditorPluginInterface::getJSSettings public function Returns JavaScript settings to be attached.
EditorBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
EditorBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
EditorBase::getDefaultSettings public function Returns the default settings for this configurable text editor. Overrides EditorPluginInterface::getDefaultSettings
EditorBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
DependencySerializationTrait::__wakeup public function 2
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property