You are here

class CkeditorAbbreviationDialog in CKEditor Abbreviation 2.0.x

Provides an abbreviation dialog for text editors.

Hierarchy

Expanded class hierarchy of CkeditorAbbreviationDialog

1 string reference to 'CkeditorAbbreviationDialog'
ckeditor_abbreviation.routing.yml in ./ckeditor_abbreviation.routing.yml
ckeditor_abbreviation.routing.yml

File

src/Form/CkeditorAbbreviationDialog.php, line 16

Namespace

Drupal\ckeditor_abbreviation\Form
View source
class CkeditorAbbreviationDialog extends FormBase {

  /**
   * Gets the form's ID.
   *
   * @return string
   */
  public function getFormId() {
    return 'ckeditor_abbreviation_dialog';
  }

  /**
   * {@inheritdoc}
   *
   * @param array $form
   *   The form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   The form's state.
   * @param Drupal\editor\Entity\Editor $editor
   *   The editor.
   */
  public function buildForm(array $form, FormStateInterface $form_state, Editor $editor = NULL) {

    // The default values are set directly from \Drupal::request()->request,
    // provided by the editor plugin opening the dialog.
    $user_input = $form_state
      ->getUserInput();
    $input = isset($user_input['editor_object']) ? $user_input['editor_object'] : [];
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'editor/drupal.editor.dialog';
    $form['#prefix'] = '<div id="ckeditor-abbreviation-dialog-form">';
    $form['#suffix'] = '</div>';
    $form['attributes']['text'] = [
      '#title' => $this
        ->t('Abbreviation'),
      '#type' => 'textfield',
      '#default_value' => isset($input['text']) ? $input['text'] : '',
    ];
    $form['attributes']['title'] = [
      '#title' => $this
        ->t('Explanation'),
      '#type' => 'textfield',
      '#default_value' => isset($input['title']) ? $input['title'] : '',
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save_modal'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#submit' => [],
      '#ajax' => [
        'callback' => '::submitForm',
        'event' => 'click',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritDoc}
   *
   * @param array $form
   *   The form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   The form's state.
   * @return Drupal\Core\Ajax\AjaxResponse
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    if ($form_state
      ->getErrors()) {
      unset($form['#prefix'], $form['#suffix']);
      $form['status_message'] = [
        '#type' => 'status_messages',
        '#weight' => -10,
      ];
      $response
        ->addCommand(new HtmlCommand('#ckeditor-abbreviation-dialog-form', $form));
    }
    else {
      $response
        ->addCommand(new EditorDialogSave($form_state
        ->getValues()));
      $response
        ->addCommand(new CloseModalDialogCommand());
    }
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CkeditorAbbreviationDialog::buildForm public function Overrides FormInterface::buildForm
CkeditorAbbreviationDialog::getFormId public function Gets the form's ID. Overrides FormInterface::getFormId
CkeditorAbbreviationDialog::submitForm public function Overrides FormInterface::submitForm
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.