class AjaxTestFormPromise

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

Test form for ajax_test_form_promise.

@internal

Hierarchy

Expanded class hierarchy of AjaxTestFormPromise

1 string reference to 'AjaxTestFormPromise'
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/AjaxTestFormPromise.php, line 16

Namespace

Drupal\ajax_test\Form
View source
class AjaxTestFormPromise extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ajax_test_form_promise';
    }
    
    /**
     * Form for testing the addition of various types of elements via Ajax.
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['#attached']['library'][] = 'ajax_test/command_promise';
        $form['custom']['#prefix'] = '<div id="ajax_test_form_promise_wrapper">';
        $form['custom']['#suffix'] = '</div>';
        // Button to test for the execution order of Ajax commands.
        $form['test_execution_order_button'] = [
            '#type' => 'submit',
            '#value' => $this->t('Execute commands button'),
            '#button_type' => 'primary',
            '#ajax' => [
                'callback' => [
                    static::class,
                    'executeCommands',
                ],
                'progress' => [
                    'type' => 'throbber',
                    'message' => NULL,
                ],
                'wrapper' => 'ajax_test_form_promise_wrapper',
            ],
        ];
        return $form;
    }
    
    /**
     * Ajax callback for the "Execute commands button" button.
     */
    public static function executeCommands(array $form, FormStateInterface $form_state) {
        $selector = '#ajax_test_form_promise_wrapper';
        $response = new AjaxResponse();
        $response->addCommand(new AppendCommand($selector, '1'));
        $response->addCommand(new AjaxTestCommandReturnPromise($selector, '2'));
        $response->addCommand(new AppendCommand($selector, '3'));
        $response->addCommand(new AppendCommand($selector, '4'));
        $response->addCommand(new AjaxTestCommandReturnPromise($selector, '5'));
        return $response;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // An empty implementation, as we never submit the actual form.
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AjaxTestFormPromise::buildForm public function Form for testing the addition of various types of elements via Ajax. Overrides FormInterface::buildForm
AjaxTestFormPromise::executeCommands public static function Ajax callback for the &quot;Execute commands button&quot; button.
AjaxTestFormPromise::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AjaxTestFormPromise::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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 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 73
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 &#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.