yaffs.net Git - yaffs-website/blob - web/core/modules/ckeditor/src/CKEditorPluginBase.php

   1 <?php
   2
   3 namespace Drupal\ckeditor;
   4
   5 use Drupal\Core\Plugin\PluginBase;
   6 use Drupal\editor\Entity\Editor;
   7
   8 /**
   9  * Defines a base CKEditor plugin implementation.
  10  *
  11  * No other CKEditor plugins can be internal, unless a different CKEditor build
  12  * than the one provided by Drupal core is used. Most CKEditor plugins don't
  13  * need to provide additional settings forms.
  14  *
  15  * This base class assumes that your plugin has buttons that you want to be
  16  * enabled through the toolbar builder UI. It is still possible to also
  17  * implement the CKEditorPluginContextualInterface (for contextual enabling) and
  18  * CKEditorPluginConfigurableInterface interfaces (for configuring plugin
  19  * settings).
  20  *
  21  * NOTE: the Drupal plugin ID should correspond to the CKEditor plugin name.
  22  *
  23  * @see \Drupal\ckeditor\CKEditorPluginInterface
  24  * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
  25  * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
  26  * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
  27  * @see \Drupal\ckeditor\CKEditorPluginManager
  28  * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
  29  * @see plugin_api
  30  */
  31 abstract class CKEditorPluginBase extends PluginBase implements CKEditorPluginInterface, CKEditorPluginButtonsInterface {
  32
  33   /**
  34    * {@inheritdoc}
  35    */
  36   public function isInternal() {
  37     return FALSE;
  38   }
  39
  40   /**
  41    * {@inheritdoc}
  42    */
  43   public function getDependencies(Editor $editor) {
  44     return [];
  45   }
  46
  47   /**
  48    * {@inheritdoc}
  49    */
  50   public function getLibraries(Editor $editor) {
  51     return [];
  52   }
  53
  54 }