class CKEditor4To5Upgrade in Drupal 10

Defines a CKEditor4To5Upgrade annotation object.

Plugin Namespace: Plugin\CKEditor4To5Upgrade.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\ckeditor5\Annotation\CKEditor4To5Upgrade

See also

\Drupal\ckeditor5\Plugin\CKEditor5PluginInterface

\Drupal\ckeditor5\Plugin\CKEditor5PluginManagerInterface

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

1 file declares its use of CKEditor4To5Upgrade

CKEditor4To5UpgradePluginManager.php in core/modules/ckeditor5/src/Plugin/CKEditor4To5UpgradePluginManager.php

File

core/modules/ckeditor5/src/Annotation/CKEditor4To5Upgrade.php, line 20

Namespace

Drupal\ckeditor5\Annotation

class CKEditor4To5Upgrade extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The CKEditor 4 buttons for which an upgrade path is provided.
   *
   * @var string[]
   */
  public $cke4_buttons;

  /**
   * The CKEditor 4 plugins for whose settings an upgrade path is provided.
   *
   * @var string[]
   */
  public $cke4_plugin_settings;

  /**
   * The CKEditor 5 plugins with configurable subset with upgrade path provided.
   *
   * @var string[]
   */
  public $cke5_plugin_elements_subset_configuration;

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditor4To5Upgrade::$cke4_buttons	public	property	The CKEditor 4 buttons for which an upgrade path is provided.
CKEditor4To5Upgrade::$cke4_plugin_settings	public	property	The CKEditor 4 plugins for whose settings an upgrade path is provided.
CKEditor4To5Upgrade::$cke5_plugin_elements_subset_configuration	public	property	The CKEditor 5 plugins with configurable subset with upgrade path provided.
CKEditor4To5Upgrade::$id	public	property	The plugin ID.
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