class FormTestValidateForm in Drupal 9
Same name and namespace in other branches
- 8 core/modules/system/tests/modules/form_test/src/Form/FormTestValidateForm.php \Drupal\form_test\Form\FormTestValidateForm
Form builder for testing \Drupal\Core\Form\FormValidatorInterface::validateForm().
Serves for testing form processing and alterations by form validation handlers, especially for the case of a validation error:
- $form_state->setValueForElement() should be able to alter submitted values in $form_state->getValues() without affecting the form element.
- #element_validate handlers should be able to alter the $element in the form structure and the alterations should be contained in the rebuilt form.
- #validate handlers should be able to alter the $form and the alterations should be contained in the rebuilt form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\form_test\Form\FormTestValidateForm
Expanded class hierarchy of FormTestValidateForm
1 string reference to 'FormTestValidateForm'
- 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/ FormTestValidateForm.php, line 23
Namespace
Drupal\form_test\FormView source
class FormTestValidateForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'form_test_validate_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$object = new Callbacks();
$form['name'] = [
'#type' => 'textfield',
'#title' => 'Name',
'#default_value' => '',
'#element_validate' => [
[
$object,
'validateName',
],
],
];
$form['submit'] = [
'#type' => 'submit',
'#value' => 'Save',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
if ($form_state
->getValue('name') == 'validate') {
// Alter the form element.
$form['name']['#value'] = '#value changed by #validate';
// Alter the submitted value in $form_state.
$form_state
->setValueForElement($form['name'], 'value changed by setValueForElement() in #validate');
// Output the element's value from $form_state.
$this
->messenger()
->addStatus($this
->t('@label value: @value', [
'@label' => $form['name']['#title'],
'@value' => $form_state
->getValue('name'),
]));
// Trigger a form validation error to see our changes.
$form_state
->setErrorByName('');
// To simplify this test, enable form caching and use form storage to
// remember our alteration.
$form_state
->setCached();
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
}
}
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. | |
FormTestValidateForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
FormTestValidateForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
FormTestValidateForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
FormTestValidateForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
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. |