class AjaxFormsTestCommandsForm

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

Form constructor for the Ajax Command display form.

@internal

Hierarchy

Expanded class hierarchy of AjaxFormsTestCommandsForm

1 string reference to 'AjaxFormsTestCommandsForm'
ajax_forms_test.routing.yml in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.routing.yml
core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.routing.yml

File

core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestCommandsForm.php, line 13

Namespace

Drupal\ajax_forms_test\Form
View source
class AjaxFormsTestCommandsForm extends FormBase {
    
    /**
     * {@inheritdoc}.
     */
    public function getFormId() {
        return 'ajax_forms_test_ajax_commands_form';
    }
    
    /**
     * {@inheritdoc}.
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form = [];
        // Shows the 'after' command with a callback generating commands.
        $form['after_command_example'] = [
            '#value' => $this->t("AJAX 'After': Click to put something after the div"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_after_callback',
            ],
            '#suffix' => '<div id="after_div">Something can be inserted after this</div>',
        ];
        // Shows the 'alert' command.
        $form['alert_command_example'] = [
            '#value' => $this->t("AJAX 'Alert': Click to alert"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_alert_callback',
            ],
        ];
        // Shows the 'announce' command with default priority.
        $form['announce_command_example'] = [
            '#value' => $this->t("AJAX 'Announce': Click to announce"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_announce_callback',
            ],
        ];
        // Shows the 'announce' command with 'polite' priority.
        $form['announce_command_polite_example'] = [
            '#value' => $this->t("AJAX 'Announce': Click to announce with 'polite' priority"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_announce_polite_callback',
            ],
        ];
        // Shows the 'announce' command with 'assertive' priority.
        $form['announce_command_assertive_example'] = [
            '#value' => $this->t("AJAX 'Announce': Click to announce with 'assertive' priority"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_announce_assertive_callback',
            ],
        ];
        // Shows the 'announce' command used twice in one AjaxResponse.
        $form['announce_command_double_example'] = [
            '#value' => $this->t("AJAX 'Announce': Click to announce twice"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_double_announce_callback',
            ],
        ];
        // Shows the 'append' command.
        $form['append_command_example'] = [
            '#value' => $this->t("AJAX 'Append': Click to append something"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_append_callback',
            ],
            '#suffix' => '<div id="append_div">Append inside this div</div>',
        ];
        // Shows the 'before' command.
        $form['before_command_example'] = [
            '#value' => $this->t("AJAX 'before': Click to put something before the div"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_before_callback',
            ],
            '#suffix' => '<div id="before_div">Insert something before this.</div>',
        ];
        // Shows the 'changed' command without asterisk.
        $form['changed_command_example'] = [
            '#value' => $this->t("AJAX changed: Click to mark div changed."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_changed_callback',
            ],
            '#suffix' => '<div id="changed_div"> <div id="changed_div_mark_this">This div can be marked as changed or not.</div></div>',
        ];
        // Shows the 'changed' command adding the asterisk.
        $form['changed_command_asterisk_example'] = [
            '#value' => $this->t("AJAX changed: Click to mark div changed with asterisk."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_changed_asterisk_callback',
            ],
        ];
        // Shows the Ajax 'css' command.
        $form['css_command_example'] = [
            '#value' => $this->t("Set the '#box' div to be blue."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_css_callback',
            ],
            '#suffix' => '<div id="css_div" style="height: 50px; width: 50px; border: 1px solid black"> box</div>',
        ];
        // Shows the Ajax 'data' command. But there is no use of this information,
        // as this would require a javascript client to use the data.
        $form['data_command_example'] = [
            '#value' => $this->t("AJAX data command: Issue command."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_data_callback',
            ],
            '#suffix' => '<div id="data_div">Data attached to this div.</div>',
        ];
        // Shows the Ajax 'invoke' command.
        $form['invoke_command_example'] = [
            '#value' => $this->t("AJAX invoke command: Invoke addClass() method."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_invoke_callback',
            ],
            '#suffix' => '<div id="invoke_div">Original contents</div>',
        ];
        // Shows the Ajax 'html' command.
        $form['html_command_example'] = [
            '#value' => $this->t("AJAX html: Replace the HTML in a selector."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_html_callback',
            ],
            '#suffix' => '<div id="html_div">Original contents</div>',
        ];
        // Shows the Ajax 'insert' command.
        $form['insert_command_example'] = [
            '#value' => $this->t("AJAX insert: Let client insert based on #ajax['method']."),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_insert_callback',
                'method' => 'prepend',
            ],
            '#suffix' => '<div id="insert_div">Original contents</div>',
        ];
        // Shows the Ajax 'prepend' command.
        $form['prepend_command_example'] = [
            '#value' => $this->t("AJAX 'prepend': Click to prepend something"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_prepend_callback',
            ],
            '#suffix' => '<div id="prepend_div">Something will be prepended to this div. </div>',
        ];
        // Shows the Ajax 'remove' command.
        $form['remove_command_example'] = [
            '#value' => $this->t("AJAX 'remove': Click to remove text"),
            '#type' => 'submit',
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_remove_callback',
            ],
            '#suffix' => '<div id="remove_div"><div id="remove_text">text to be removed</div></div>',
        ];
        // Shows the Ajax 'restripe' command.
        $form['restripe_command_example'] = [
            '#type' => 'submit',
            '#value' => $this->t("AJAX 'restripe' command"),
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_restripe_callback',
            ],
            '#suffix' => '<div id="restripe_div">
                    <table id="restripe_table" style="border: 1px solid black" >
                    <tr id="table-first"><td>first row</td></tr>
                    <tr ><td>second row</td></tr>
                    </table>
                    </div>',
        ];
        // Demonstrates the Ajax 'settings' command. The 'settings' command has
        // nothing visual to "show", but it can be tested via SimpleTest and via
        // Firebug.
        $form['settings_command_example'] = [
            '#type' => 'submit',
            '#value' => $this->t("AJAX 'settings' command"),
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_settings_callback',
            ],
        ];
        // Shows the Ajax 'add_css' command.
        $form['add_css_command_example'] = [
            '#type' => 'submit',
            '#value' => $this->t("AJAX 'add_css' command"),
            '#ajax' => [
                'callback' => 'ajax_forms_test_advanced_commands_add_css_callback',
            ],
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Submit'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}.
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AjaxFormsTestCommandsForm::buildForm public function . Overrides FormInterface::buildForm
AjaxFormsTestCommandsForm::getFormId public function . Overrides FormInterface::getFormId
AjaxFormsTestCommandsForm::submitForm public function . Overrides FormInterface::submitForm
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
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 &#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.
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.