annotate core/modules/ckeditor/src/CKEditorPluginCssInterface.php @ 19:fa3358dc1485 tip

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