class CKEditor5AspectsOfCKEditor5Plugin

Same name in this branch
  1. 10 core/modules/ckeditor5/src/Attribute/CKEditor5AspectsOfCKEditor5Plugin.php \Drupal\ckeditor5\Attribute\CKEditor5AspectsOfCKEditor5Plugin
Same name in other branches
  1. 9 core/modules/ckeditor5/src/Annotation/CKEditor5AspectsOfCKEditor5Plugin.php \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin
  2. 11.x core/modules/ckeditor5/src/Annotation/CKEditor5AspectsOfCKEditor5Plugin.php \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin
  3. 11.x core/modules/ckeditor5/src/Attribute/CKEditor5AspectsOfCKEditor5Plugin.php \Drupal\ckeditor5\Attribute\CKEditor5AspectsOfCKEditor5Plugin

Defines the "CKEditor 5 aspects of a CKEditor5Plugin" annotation object.

Plugin Namespace: Plugin\CKEditor5Plugin.

Hierarchy

Expanded class hierarchy of CKEditor5AspectsOfCKEditor5Plugin

See also

\Drupal\ckeditor5\Plugin\CKEditorPluginInterface

\Drupal\ckeditor5\Plugin\CKEditorPluginBase

\Drupal\ckeditor5\Plugin\CKEditorPluginManager

Plugin API

\Drupal\ckeditor5\Annotation\CKEditor5Plugin

\Drupal\ckeditor5\Annotation\DrupalPartsOfCKEditor5Plugin

Related topics

Annotations
Annotations for class discovery and metadata description.
1 file declares its use of CKEditor5AspectsOfCKEditor5Plugin
CKEditor5PluginManagerTest.php in core/modules/ckeditor5/tests/src/Kernel/CKEditor5PluginManagerTest.php

File

core/modules/ckeditor5/src/Annotation/CKEditor5AspectsOfCKEditor5Plugin.php, line 23

Namespace

Drupal\ckeditor5\Annotation
View source 
class CKEditor5AspectsOfCKEditor5Plugin extends Plugin {
    
    /**
     * The CKEditor 5 plugin classes provided.
     *
     * Found in the CKEditor5 global js object as {package.Class}.
     *
     * @var string[]
     */
    public $plugins;
    
    /**
     * A keyed array of additional values for the CKEditor 5 configuration.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var array[]
     */
    public $config = [];

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CKEditor5AspectsOfCKEditor5Plugin::$config public property A keyed array of additional values for the CKEditor 5 configuration.
CKEditor5AspectsOfCKEditor5Plugin::$plugins public property The CKEditor 5 plugin classes provided.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 3

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