public function DrupalSpecialChars::settingsForm in CKEditor Special Characters 8

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.

Parameters

array $form: An empty form array to be populated with a configuration form, if any.

\Drupal\Core\Form\FormStateInterface $form_state: The state of the entire filter administration form.

\Drupal\editor\Entity\Editor $editor: A configured text editor object.

Return value

array A render array for the settings form.

Overrides CKEditorPluginConfigurableInterface::settingsForm

File

src/Plugin/CKEditorPlugin/DrupalSpecialChars.php, line 134

Class

DrupalSpecialChars

Defines the "specialChars" plugin.

Namespace

Drupal\ckeditor_specialchars\Plugin\CKEditorPlugin

Code

public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {

  // Defaults.
  $config = [
    'characters' => '',
    'replace' => FALSE,
  ];
  $settings = $editor
    ->getSettings();
  if (isset($settings['plugins']['specialchars'])) {
    $config = $settings['plugins']['specialchars'];
  }
  $form['characters'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Special characters'),
    '#description' => $this
      ->t('One per line'),
    '#default_value' => $config['characters'],
  ];
  $form['replace'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Replace default characters?'),
    '#description' => $this
      ->t('Leaving un-checked will append to default character list.'),
    '#default_value' => $config['replace'],
  ];
  return $form;
}