3 namespace Drupal\editor;
5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
8 * Provides an interface defining a text editor entity.
10 interface EditorInterface extends ConfigEntityInterface {
13 * Returns whether this text editor has an associated filter format.
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
21 public function hasAssociatedFilterFormat();
24 * Returns the filter format this text editor is associated with.
26 * This could be NULL if the associated filter format is still being created.
27 * @see hasAssociatedFilterFormat()
29 * @return \Drupal\filter\FilterFormatInterface|null
31 public function getFilterFormat();
34 * Returns the associated text editor plugin ID.
37 * The text editor plugin ID.
39 public function getEditor();
42 * Set the text editor plugin ID.
44 * @param string $editor
45 * The text editor plugin ID to set.
47 public function setEditor($editor);
50 * Returns the text editor plugin-specific settings.
53 * A structured array containing all text editor settings.
55 public function getSettings();
58 * Sets the text editor plugin-specific settings.
60 * @param array $settings
61 * The structured array containing all text editor settings.
65 public function setSettings(array $settings);
68 * Returns the image upload settings.
71 * A structured array containing image upload settings.
73 public function getImageUploadSettings();
76 * Sets the image upload settings.
78 * @param array $image_upload
79 * The structured array containing image upload settings.
83 public function setImageUploadSettings(array $image_upload);