comparison core/modules/ckeditor/src/CKEditorPluginConfigurableInterface.php @ 0:c75dbcec494b

Initial commit from drush-created site

+<?php
+
+namespace Drupal\ckeditor;
+
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\editor\Entity\Editor;
+
+/**
+ * Defines an interface for configurable CKEditor plugins.
+ *
+ * This allows a CKEditor plugin to define a settings form. These settings can
+ * then be automatically passed on to the corresponding CKEditor instance via
+ * CKEditorPluginInterface::getConfig().
+ *
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginCssInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
+ */
+interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {
+
+  /**
+   * Returns a settings form to configure this CKEditor plugin.
+   *
+   * If the plugin's behavior depends on extensive options and/or external data,
+   * then the implementing module can choose to provide a separate, global
+   * configuration page rather than per-text-editor settings. In that case, this
+   * form should provide a link to the separate settings page.
+   *
+   * @param array $form
+   *   An empty form array to be populated with a configuration form, if any.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The state of the entire filter administration form.
+   * @param \Drupal\editor\Entity\Editor $editor
+   *   A configured text editor object.
+   *
+   * @return array
+   *   A render array for the settings form.
+   */
+  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor);
+
+}