class EditorBase

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

4 files declare their use of EditorBase
CKEditor.php in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php
EditorBaseTest.php in core/modules/editor/tests/src/Unit/EditorBaseTest.php
TRexEditor.php in core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php
UnicornEditor.php in core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php

File

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

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) {
        if (method_exists($this, 'settingsForm')) {
            @trigger_error(get_called_class() . "::settingsForm is deprecated since version 8.3.x. Rename the implementation 'buildConfigurationForm'. See https://www.drupal.org/node/2819753", E_USER_DEPRECATED);
            if ($form_state instanceof SubformStateInterface) {
                $form_state = $form_state->getCompleteFormState();
            }
            return $this->settingsForm($form, $form_state, $form_state->get('editor'));
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
        if (method_exists($this, 'settingsFormValidate')) {
            @trigger_error(get_called_class() . "::settingsFormValidate is deprecated since version 8.3.x. Rename the implementation 'validateConfigurationForm'. See https://www.drupal.org/node/2819753", E_USER_DEPRECATED);
            if ($form_state instanceof SubformStateInterface) {
                $form_state = $form_state->getCompleteFormState();
            }
            $this->settingsFormValidate($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        if (method_exists($this, 'settingsFormSubmit')) {
            @trigger_error(get_called_class() . "::settingsFormSubmit is deprecated since version 8.3.x. Rename the implementation 'submitConfigurationForm'. See https://www.drupal.org/node/2819753", E_USER_DEPRECATED);
            if ($form_state instanceof SubformStateInterface) {
                $form_state = $form_state->getCompleteFormState();
            }
            $this->settingsFormSubmit($form, $form_state);
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
EditorBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
EditorBase::getDefaultSettings public function Returns the default settings for this configurable text editor. Overrides EditorPluginInterface::getDefaultSettings 3
EditorBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
EditorBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
EditorPluginInterface::getJSSettings public function Returns JavaScript settings to be attached. 4
EditorPluginInterface::getLibraries public function Returns libraries to be attached. 4
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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