Same name in this branch

1. 10 core/modules/ckeditor5/src/Annotation/CKEditor5Plugin.php \Drupal\ckeditor5\Annotation\CKEditor5Plugin::__construct()

Same name and namespace in other branches

1. 9 core/modules/ckeditor5/src/Annotation/CKEditor5Plugin.php \Drupal\ckeditor5\Annotation\CKEditor5Plugin::__construct()
2. 11.x core/modules/ckeditor5/src/Annotation/CKEditor5Plugin.php \Drupal\ckeditor5\Annotation\CKEditor5Plugin::__construct()
3. 11.x core/modules/ckeditor5/src/Attribute/CKEditor5Plugin.php \Drupal\ckeditor5\Attribute\CKEditor5Plugin::__construct()

Constructs a CKEditor5Plugin attribute.

Overridden for compatibility with the AttributeBridgeDecorator, which ensures YAML-defined CKEditor 5 plugin definitions are also processed by attributes. Unfortunately it does not (yet) support nested attributes. Force YAML-defined plugin definitions to be parsed by the attributes, to ensure consistent handling of defaults.

Parameters

string $id: The plugin ID.

array|\Drupal\ckeditor5\Attribute\CKEditor5AspectsOfCKEditor5Plugin|null $ckeditor5: (optional) The CKEditor 5 aspects of the plugin definition. Required unless set by deriver.

array|\Drupal\ckeditor5\Attribute\DrupalAspectsOfCKEditor5Plugin|null $drupal: (optional) The Drupal aspects of the plugin definition. Required unless set by deriver.

class-string|null $deriver: (optional) The deriver class.

See also

\Drupal\Component\Plugin\Discovery\AttributeBridgeDecorator::getDefinitions()

File

core/modules/ckeditor5/src/Attribute/CKEditor5Plugin.php, line 54

Class

CKEditor5Plugin

The CKEditor5Plugin attribute.

Namespace

Drupal\ckeditor5\Attribute

Code

public function __construct(public readonly string $id, array|CKEditor5AspectsOfCKEditor5Plugin|null $ckeditor5 = NULL, array|DrupalAspectsOfCKEditor5Plugin|null $drupal = NULL, public readonly ?string $deriver = NULL) {
  // If either of the two aspects of the plugin definition is in array form,
  // then this is a YAML-defined CKEditor 5 plugin definition. To avoid errors
  // due to violating either Attribute class constructor, verify basic data
  // shape requirements here. This provides a better DX for YAML-defined
  // plugins, and avoids the need for a PHP IDE or debugger.
  // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::processDefinition()
  // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition::validateCKEditor5Aspects()
  // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition::validateDrupalAspects()
  if (!$drupal instanceof DrupalAspectsOfCKEditor5Plugin) {
    if ($drupal === NULL) {
      throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "drupal" key.', $id));
    }
    // TRICKY: $this->deriver is incorrect due to AttributeBridgeDecorator!
    // If there's no deriver, validate here. Otherwise: the base definition is
    // allowed to be incomplete; let CKEditor5PluginManager::processDefinition
    // perform the validation.
    // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition::getDeriver()
    // @see \Drupal\Component\Plugin\Discovery\AttributeBridgeDecorator::getDefinitions()
    if (!isset($drupal['deriver'])) {
      if (isset($drupal['label']) && !is_string($drupal['label']) && !$drupal['label'] instanceof TranslatableMarkup) {
        throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.label" value that is not a string nor a TranslatableMarkup instance.', $id));
      }
      if (!$ckeditor5 instanceof CKEditor5AspectsOfCKEditor5Plugin) {
        if ($ckeditor5 === NULL) {
          throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "ckeditor5" key.', $id));
        }
        if (!isset($ckeditor5['plugins'])) {
          throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "ckeditor5.plugins" key.', $id));
        }
      }
    }
  }
  $this->ckeditor5 = is_array($ckeditor5) ? new CKEditor5AspectsOfCKEditor5Plugin(...$ckeditor5) : $ckeditor5;
  $this->drupal = is_array($drupal) ? new DrupalAspectsOfCKEditor5Plugin(...$drupal) : $drupal;
}

---