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

   1 <?php
   2
   3 namespace Drupal\ckeditor;
   4
   5 use Drupal\editor\Entity\Editor;
   6
   7 /**
   8  * Defines an interface for CKEditor plugins with associated CSS.
   9  *
  10  * This allows a CKEditor plugin to add additional CSS in iframe CKEditor
  11  * instances without needing to implement hook_ckeditor_css_alter().
  12  *
  13  * @see \Drupal\ckeditor\CKEditorPluginInterface
  14  * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
  15  * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
  16  * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
  17  * @see \Drupal\ckeditor\CKEditorPluginBase
  18  * @see \Drupal\ckeditor\CKEditorPluginManager
  19  * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
  20  * @see plugin_api
  21  */
  22 interface CKEditorPluginCssInterface extends CKEditorPluginInterface {
  23
  24   /**
  25    * Retrieves enabled plugins' iframe instance CSS files.
  26    *
  27    * Note: this does not use a Drupal asset library because this CSS will be
  28    * loaded by CKEditor, not by Drupal.
  29    *
  30    * @param \Drupal\editor\Entity\Editor $editor
  31    *   A configured text editor object.
  32    *
  33    * @return string[]
  34    *   An array of CSS files. This is a flat list of file paths relative to
  35    *   the Drupal root.
  36    */
  37   public function getCssFiles(Editor $editor);
  38
  39 }