class FormTestRebuildPreserveValuesForm

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

Form builder for testing preservation of values during a rebuild.

@internal

Hierarchy

Expanded class hierarchy of FormTestRebuildPreserveValuesForm

1 string reference to 'FormTestRebuildPreserveValuesForm'
form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml
core/modules/system/tests/modules/form_test/form_test.routing.yml

File

core/modules/system/tests/modules/form_test/src/Form/FormTestRebuildPreserveValuesForm.php, line 13

Namespace

Drupal\form_test\Form
View source
class FormTestRebuildPreserveValuesForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_form_rebuild_preserve_values_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // Start the form with two checkboxes, to test different defaults, and a
        // textfield, to test more than one element type.
        $form = [
            'checkbox_1_default_off' => [
                '#type' => 'checkbox',
                '#title' => t('This checkbox defaults to unchecked'),
                '#default_value' => FALSE,
            ],
            'checkbox_1_default_on' => [
                '#type' => 'checkbox',
                '#title' => t('This checkbox defaults to checked'),
                '#default_value' => TRUE,
            ],
            'text_1' => [
                '#type' => 'textfield',
                '#title' => t('This textfield has a non-empty default value.'),
                '#default_value' => 'DEFAULT 1',
            ],
        ];
        // Provide an 'add more' button that rebuilds the form with an additional two
        // checkboxes and a textfield. The test is to make sure that the rebuild
        // triggered by this button preserves the user input values for the initial
        // elements and initializes the new elements with the correct default values.
        if (!$form_state->has('add_more')) {
            $form['add_more'] = [
                '#type' => 'submit',
                '#value' => 'Add more',
                '#submit' => [
                    '::addMoreSubmitForm',
                ],
            ];
        }
        else {
            $form += [
                'checkbox_2_default_off' => [
                    '#type' => 'checkbox',
                    '#title' => t('This checkbox defaults to unchecked'),
                    '#default_value' => FALSE,
                ],
                'checkbox_2_default_on' => [
                    '#type' => 'checkbox',
                    '#title' => t('This checkbox defaults to checked'),
                    '#default_value' => TRUE,
                ],
                'text_2' => [
                    '#type' => 'textfield',
                    '#title' => t('This textfield has a non-empty default value.'),
                    '#default_value' => 'DEFAULT 2',
                ],
            ];
        }
        // A submit button that finishes the form workflow (does not rebuild).
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => 'Submit',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function addMoreSubmitForm(array &$form, FormStateInterface $form_state) {
        // Rebuild, to test preservation of input values.
        $form_state->set('add_more', TRUE);
        $form_state->setRebuild();
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Finish the workflow. Do not rebuild.
        $this->messenger()
            ->addStatus($this->t('Form values: %values', [
            '%values' => var_export($form_state->getValues(), TRUE),
        ]));
    }

}

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
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 57
FormTestRebuildPreserveValuesForm::addMoreSubmitForm public function
FormTestRebuildPreserveValuesForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestRebuildPreserveValuesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestRebuildPreserveValuesForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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 '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. 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.