class CKEditor5PluginDefault

Same name and namespace in other branches
  1. 9 core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault
  2. 10 core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault

Defines the default CKEditor 5 plugin implementation.

When a CKEditor 5 plugin is not configurable nor has dynamic plugin configuration, no custom code needs to be written: this default implementation will be used under the hood.

Hierarchy

Expanded class hierarchy of CKEditor5PluginDefault

See also

@see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$class

15 files declare their use of CKEditor5PluginDefault
Alignment.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Alignment.php
CodeBlock.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/CodeBlock.php
DrupalAspectsOfCKEditor5Plugin.php in core/modules/ckeditor5/src/Annotation/DrupalAspectsOfCKEditor5Plugin.php
DrupalAspectsOfCKEditor5Plugin.php in core/modules/ckeditor5/src/Attribute/DrupalAspectsOfCKEditor5Plugin.php
GlobalAttribute.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/GlobalAttribute.php

... See full list

File

core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php, line 19

Namespace

Drupal\ckeditor5\Plugin
View on git.drupalcode.org
View source 
class CKEditor5PluginDefault extends PluginBase implements CKEditor5PluginInterface {
  
  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    // Ensure the configuration is set as expected for configurable plugins.
    if ($this instanceof CKEditor5PluginConfigurableInterface) {
      $this->setConfiguration($configuration);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor) : array {
    return $static_plugin_config;
  }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
CKEditor5PluginDefault::getDynamicPluginConfig public function Allows a plugin to modify its static configuration. Overrides CKEditor5PluginInterface::getDynamicPluginConfig 11
CKEditor5PluginDefault::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 3
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 3
DependencySerializationTrait::__wakeup public function 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::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 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
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.