ckeditor5-1.0.x-dev/src/Plugin/CKEditor5PluginConfigurableInterface.php

<?php

namespace Drupal\ckeditor5\Plugin;

use Drupal\Core\Form\FormStateInterface;
use Drupal\editor\Entity\Editor;

/**
 * Defines an interface for configurable CKEditor 5 plugins.
 *
 * This allows a CKEditor 5 plugin to define a settings form. These settings can
 * then be automatically passed on to the corresponding CKEditor 5 instance via
 * CKEditor5PluginInterface::getDynamicPluginConfig().
 *
 * @see \Drupal\ckeditor5\CKEditor5PluginInterface
 * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginBase
 * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager
 * @see \Drupal\ckeditor5\Annotation\CKEditor5Plugin
 * @see plugin_api
 */
interface CKEditor5PluginConfigurableInterface extends CKEditor5PluginInterface {

  /**
   * Returns a settings form to configure this CKEditor5 plugin.
   *
   * @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);

}