class AjaxTestDialogForm

Same name in other branches
  1. 9 core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php \Drupal\ajax_test\Form\AjaxTestDialogForm
  2. 10 core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php \Drupal\ajax_test\Form\AjaxTestDialogForm
  3. 11.x core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php \Drupal\ajax_test\Form\AjaxTestDialogForm

Dummy form for testing DialogRenderer with _form routes.

@internal

Hierarchy

Expanded class hierarchy of AjaxTestDialogForm

File

core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php, line 17

Namespace

Drupal\ajax_test\Form
View source
class AjaxTestDialogForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ajax_test_dialog_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // In order to use WebTestBase::drupalPostAjaxForm() to POST from a link, we need
        // to have a dummy field we can set in WebTestBase::drupalPostForm() else it won't
        // submit anything.
        $form['textfield'] = [
            '#type' => 'hidden',
        ];
        $form['button1'] = [
            '#type' => 'submit',
            '#name' => 'button1',
            '#value' => 'Button 1 (modal)',
            '#ajax' => [
                'callback' => '::modal',
            ],
        ];
        $form['button2'] = [
            '#type' => 'submit',
            '#name' => 'button2',
            '#value' => 'Button 2 (non-modal)',
            '#ajax' => [
                'callback' => '::nonModal',
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_state->setRedirect('ajax_test.dialog_contents');
    }
    
    /**
     * AJAX callback handler for AjaxTestDialogForm.
     */
    public function modal(&$form, FormStateInterface $form_state) {
        return $this->dialog(TRUE);
    }
    
    /**
     * AJAX callback handler for AjaxTestDialogForm.
     */
    public function nonModal(&$form, FormStateInterface $form_state) {
        return $this->dialog(FALSE);
    }
    
    /**
     * Util to render dialog in ajax callback.
     *
     * @param bool $is_modal
     *   (optional) TRUE if modal, FALSE if plain dialog. Defaults to FALSE.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An ajax response object.
     */
    protected function dialog($is_modal = FALSE) {
        $content = AjaxTestController::dialogContents();
        $response = new AjaxResponse();
        $title = $this->t('AJAX Dialog & contents');
        // Attach the library necessary for using the Open(Modal)DialogCommand and
        // set the attachments for this Ajax response.
        $content['#attached']['library'][] = 'core/drupal.dialog.ajax';
        if ($is_modal) {
            $response->addCommand(new OpenModalDialogCommand($title, $content));
        }
        else {
            $selector = '#ajax-test-dialog-wrapper-1';
            $response->addCommand(new OpenDialogCommand($selector, $title, $content));
        }
        return $response;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AjaxTestDialogForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AjaxTestDialogForm::dialog protected function Util to render dialog in ajax callback.
AjaxTestDialogForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AjaxTestDialogForm::modal public function AJAX callback handler for AjaxTestDialogForm.
AjaxTestDialogForm::nonModal public function AJAX callback handler for AjaxTestDialogForm.
AjaxTestDialogForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AjaxTestDialogForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

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