class CKEditor5AspectsOfCKEditor5Plugin in Drupal 10

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

Plugin Namespace: Plugin\CKEditor5Plugin.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\ckeditor5\Annotation\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.

File

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

Namespace

Drupal\ckeditor5\Annotation

class CKEditor5AspectsOfCKEditor5Plugin extends Plugin {

  /**
   * The CKEditor5 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 CKEditor5 constructor config.
   *
   * This property is optional and it does not need to be declared.
   *
   * @var array[]
   */
  public $config = [];

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditor5AspectsOfCKEditor5Plugin::$config	public	property	A keyed array of additional values for the CKEditor5 constructor config.
CKEditor5AspectsOfCKEditor5Plugin::$plugins	public	property	The CKEditor5 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