class EditorLinkDialog

Same name in other branches
  1. 9 core/modules/editor/src/Form/EditorLinkDialog.php \Drupal\editor\Form\EditorLinkDialog
  2. 8.9.x core/modules/editor/src/Form/EditorLinkDialog.php \Drupal\editor\Form\EditorLinkDialog

Provides a link dialog for text editors.

@internal

Hierarchy

Expanded class hierarchy of EditorLinkDialog

Deprecated

in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement.

See also

https://www.drupal.org/node/3291493

1 file declares its use of EditorLinkDialog
EditorDeprecationTest.php in core/modules/editor/tests/src/Kernel/EditorDeprecationTest.php
1 string reference to 'EditorLinkDialog'
editor.routing.yml in core/modules/editor/editor.routing.yml
core/modules/editor/editor.routing.yml

File

core/modules/editor/src/Form/EditorLinkDialog.php, line 23

Namespace

Drupal\editor\Form
View source
class EditorLinkDialog extends FormBase {
    
    /**
     * Constructs a form object for link dialog.
     */
    public function __construct() {
        @trigger_error(__NAMESPACE__ . '\\EditorLinkDialog is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3291493', E_USER_DEPRECATED);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'editor_link_dialog';
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\editor\Entity\Editor $editor
     *   The text editor to which this dialog corresponds.
     *
     * @return array
     */
    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 = $user_input['editor_object'] ?? [];
        $form['#tree'] = TRUE;
        $form['#attached']['library'][] = 'editor/drupal.editor.dialog';
        $form['#prefix'] = '<div id="editor-link-dialog-form">';
        $form['#suffix'] = '</div>';
        // Everything under the "attributes" key is merged directly into the
        // generated link tag's attributes.
        $form['attributes']['href'] = [
            '#title' => $this->t('URL'),
            '#type' => 'textfield',
            '#default_value' => $input['href'] ?? '',
            '#maxlength' => 2048,
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['save_modal'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save'),
            // No regular submit-handler. This form only works via JavaScript.
'#submit' => [],
            '#ajax' => [
                'callback' => '::submitForm',
                'event' => 'click',
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $response = new AjaxResponse();
        if ($form_state->getErrors()) {
            unset($form['#prefix'], $form['#suffix']);
            $form['status_messages'] = [
                '#type' => 'status_messages',
                '#weight' => -10,
            ];
            $response->addCommand(new HtmlCommand('#editor-link-dialog-form', $form));
        }
        else {
            $response->addCommand(new EditorDialogSave($form_state->getValues()));
            $response->addCommand(new CloseModalDialogCommand());
        }
        return $response;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EditorLinkDialog::buildForm public function Overrides FormInterface::buildForm
EditorLinkDialog::getFormId public function Overrides FormInterface::getFormId
EditorLinkDialog::submitForm public function Overrides FormInterface::submitForm
EditorLinkDialog::__construct public function Constructs a form object for link dialog.
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 Overrides ContainerInjectionInterface::create 111
FormBase::currentUser protected function Gets the current user. 2
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 Overrides FormInterface::validateForm 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.