class CKEditor5PluginDefault in Drupal 10

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

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault implements CKEditor5PluginInterface

See also

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

12 files declare their use of CKEditor5PluginDefault

Alignment.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Alignment.php

DrupalAspectsOfCKEditor5Plugin.php in core/modules/ckeditor5/src/Annotation/DrupalAspectsOfCKEditor5Plugin.php

GlobalAttribute.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/GlobalAttribute.php

Heading.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Heading.php

ImageResize.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/ImageResize.php

... See full list

File

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

Namespace

Drupal\ckeditor5\Plugin

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

Name	Modifiers	Type	Description	Overrides
CKEditor5PluginDefault::getDynamicPluginConfig	public	function	Allows a plugin to modify its static configuration. Overrides CKEditor5PluginInterface::getDynamicPluginConfig
CKEditor5PluginDefault::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
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.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.