class AjaxTestForm

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

Dummy form for testing DialogRenderer with _form routes.

@internal

Hierarchy

Expanded class hierarchy of AjaxTestForm

1 string reference to 'AjaxTestForm'
ajax_test.routing.yml in core/modules/system/tests/modules/ajax_test/ajax_test.routing.yml
core/modules/system/tests/modules/ajax_test/ajax_test.routing.yml

File

core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestForm.php, line 16

Namespace

Drupal\ajax_test\Form
View source
class AjaxTestForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ajax_test_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['#action'] = Url::fromRoute('ajax_test.dialog')->toString();
        $form['description'] = [
            '#markup' => '<p>' . $this->t("Ajax Form contents description.") . '</p>',
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Do it'),
        ];
        $form['actions']['preview'] = [
            '#title' => 'Preview',
            '#type' => 'link',
            '#url' => Url::fromRoute('ajax_test.dialog_form'),
            '#attributes' => [
                'class' => [
                    'use-ajax',
                    'button',
                ],
                'data-dialog-type' => 'modal',
            ],
        ];
        $form['actions']['hello_world'] = [
            '#type' => 'submit',
            '#value' => $this->t('Hello world'),
            // No regular submit-handler. This form only works via JavaScript.
'#submit' => [],
            '#ajax' => [
                'callback' => '::helloWorld',
                'event' => 'click',
            ],
        ];
        return $form;
    }
    
    /**
     * An AJAX callback that prints "Hello World!" as a message.
     *
     * @param array $form
     *   The form array to remove elements from.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response.
     */
    public function helloWorld(array &$form, FormStateInterface $form_state) {
        $response = new AjaxResponse();
        $response->addCommand(new MessageCommand('Hello world!'));
        return $response;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AjaxTestForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AjaxTestForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AjaxTestForm::helloWorld public function An AJAX callback that prints &quot;Hello World!&quot; as a message.
AjaxTestForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AjaxTestForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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 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.
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.