www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/editor/src/EditorInterface.php

   1 <?php
   2
   3 namespace Drupal\editor;
   4
   5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a text editor entity.
   9  */
  10 interface EditorInterface extends ConfigEntityInterface {
  11
  12   /**
  13    * Returns whether this text editor has an associated filter format.
  14    *
  15    * A text editor may be created at the same time as the filter format it's
  16    * going to be associated with; in that case, no filter format object is
  17    * available yet.
  18    *
  19    * @return bool
  20    */
  21   public function hasAssociatedFilterFormat();
  22
  23   /**
  24    * Returns the filter format this text editor is associated with.
  25    *
  26    * This could be NULL if the associated filter format is still being created.
  27    * @see hasAssociatedFilterFormat()
  28    *
  29    * @return \Drupal\filter\FilterFormatInterface|null
  30    */
  31   public function getFilterFormat();
  32
  33   /**
  34    * Returns the associated text editor plugin ID.
  35    *
  36    * @return string
  37    *   The text editor plugin ID.
  38    */
  39   public function getEditor();
  40
  41   /**
  42    * Set the text editor plugin ID.
  43    *
  44    * @param string $editor
  45    *   The text editor plugin ID to set.
  46    */
  47   public function setEditor($editor);
  48
  49   /**
  50    * Returns the text editor plugin-specific settings.
  51    *
  52    * @return array
  53    *   A structured array containing all text editor settings.
  54    */
  55   public function getSettings();
  56
  57   /**
  58    * Sets the text editor plugin-specific settings.
  59    *
  60    * @param array $settings
  61    *   The structured array containing all text editor settings.
  62    *
  63    * @return $this
  64    */
  65   public function setSettings(array $settings);
  66
  67   /**
  68    * Returns the image upload settings.
  69    *
  70    * @return array
  71    *   A structured array containing image upload settings.
  72    */
  73   public function getImageUploadSettings();
  74
  75   /**
  76    * Sets the image upload settings.
  77    *
  78    * @param array $image_upload
  79    *   The structured array containing image upload settings.
  80    *
  81    * @return $this
  82    */
  83   public function setImageUploadSettings(array $image_upload);
  84
  85 }