class EditorBase
Same name in other branches
- 9 core/modules/editor/src/Plugin/EditorBase.php \Drupal\editor\Plugin\EditorBase
- 8.9.x core/modules/editor/src/Plugin/EditorBase.php \Drupal\editor\Plugin\EditorBase
- 10 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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\editor\Plugin\EditorBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\editor\Plugin\EditorPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of EditorBase
See also
\Drupal\editor\Annotation\Editor
\Drupal\editor\Plugin\EditorPluginInterface
\Drupal\editor\Plugin\EditorManager
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\PluginView 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 | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |
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.