aleph1.co.uk Git - yaffs-website/blob - web/core/modules/ckeditor/src/Annotation/CKEditorPlugin.php

   1 <?php
   2
   3 namespace Drupal\ckeditor\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines a CKEditorPlugin annotation object.
   9  *
  10  * Plugin Namespace: Plugin\CKEditorPlugin
  11  *
  12  * For a working example, see \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImage
  13  *
  14  * @see \Drupal\ckeditor\CKEditorPluginInterface
  15  * @see \Drupal\ckeditor\CKEditorPluginBase
  16  * @see \Drupal\ckeditor\CKEditorPluginManager
  17  * @see hook_ckeditor_plugin_info_alter()
  18  * @see plugin_api
  19  *
  20  * @Annotation
  21  */
  22 class CKEditorPlugin extends Plugin {
  23
  24   /**
  25    * The plugin ID.
  26    *
  27    * This MUST match the name of the CKEditor plugin itself (written in
  28    * JavaScript). Otherwise CKEditor will throw JavaScript errors when it runs,
  29    * because it fails to load this CKEditor plugin.
  30    *
  31    * @var string
  32    */
  33   public $id;
  34
  35   /**
  36    * The human-readable name of the CKEditor plugin.
  37    *
  38    * @ingroup plugin_translatable
  39    *
  40    * @var \Drupal\Core\Annotation\Translation
  41    */
  42   public $label;
  43
  44 }