class FormTestRebuildPreserveValuesForm in Drupal 9
Same name and namespace in other branches
- 8 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
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\form_test\Form\FormTestRebuildPreserveValuesForm
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\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
105 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
FormTestRebuildPreserveValuesForm:: |
public | function | ||
FormTestRebuildPreserveValuesForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
FormTestRebuildPreserveValuesForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
FormTestRebuildPreserveValuesForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |