class FormTestMachineNameValidationForm in Drupal 10
Same name and namespace in other branches
- 8 core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php \Drupal\form_test\Form\FormTestMachineNameValidationForm
- 9 core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php \Drupal\form_test\Form\FormTestMachineNameValidationForm
Form to test whether machine name validation works with ajax requests.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\form_test\Form\FormTestMachineNameValidationForm
Expanded class hierarchy of FormTestMachineNameValidationForm
1 string reference to 'FormTestMachineNameValidationForm'
- 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/ FormTestMachineNameValidationForm.php, line 11
Namespace
Drupal\form_test\FormView source
class FormTestMachineNameValidationForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'form_test_machine_name_validation_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Disable client-side validation so that we can test AJAX requests with
// invalid input.
$form['#attributes']['novalidate'] = 'novalidate';
$form['name'] = [
'#type' => 'textfield',
'#default_value' => $form_state
->getValue('name'),
'#maxlength' => 50,
'#required' => TRUE,
'#title' => 'Name',
];
// The default value simulates how an entity form works, which has default
// values based on an entity, which is updated in an afterBuild callback.
// During validation and after build, limit_validation_errors is not
// in effect, which means that getValue('id') does return a value, while it
// does not during the submit callback. Therefore, this test sets the value
// in ::buildAjaxSnackConfigureFormValidate() and then uses that as the
// default value, so that the default value and the value are identical.
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $form_state
->get('id'),
'#maxlength' => 50,
'#required' => TRUE,
'#machine_name' => [
'exists' => [
$this,
'load',
],
'source' => [
'name',
],
],
];
// Test support for multiple machine names on the form. Although this has
// the default value duplicate it should not generate an error because it
// is the default value.
$form['id2'] = [
'#type' => 'machine_name',
'#default_value' => 'duplicate',
'#maxlength' => 50,
'#required' => TRUE,
'#machine_name' => [
'exists' => [
$this,
'load',
],
'source' => [
'name',
],
],
];
$form['snack'] = [
'#type' => 'select',
'#title' => $this
->t('Select a snack'),
'#options' => [
'apple' => 'apple',
'pear' => 'pear',
'potato' => 'potato',
],
'#required' => TRUE,
'#ajax' => [
'callback' => '::buildAjaxSnackConfigureForm',
'wrapper' => 'snack-config-form',
'method' => 'replace',
'effect' => 'fade',
],
];
$form['snack_configs'] = [
'#type' => 'container',
'#attributes' => [
'id' => 'snack-config-form',
],
'#tree' => TRUE,
];
$form['submit'] = [
'#type' => 'submit',
'#value' => 'Save',
];
return $form;
}
/**
* Validate callback that forces a form rebuild.
*/
public function buildAjaxSnackConfigureFormValidate(array $form, FormStateInterface $form_state) {
$form_state
->set('id', $form_state
->getValue('id'));
}
/**
* Submit callback that forces a form rebuild.
*/
public function buildAjaxSnackConfigureFormSubmit(array $form, FormStateInterface $form_state) {
$form_state
->setRebuild();
}
/**
* Handles changes to the selected snack configuration.
*/
public function buildAjaxSnackConfigureForm(array $form, FormStateInterface $form_state) {
return $form['snack_configs'];
}
/**
* Loading stub for machine name.
*
* @param $machine_name
* The machine name.
*
* @return bool
*/
public function load($machine_name) {
if (strpos($machine_name, 'duplicate') !== FALSE) {
return TRUE;
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this
->messenger()
->addStatus('The form_test_machine_name_validation_form form has been submitted successfully.');
}
}
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. | |
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:: |
97 |
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:: |
65 |
FormTestMachineNameValidationForm:: |
public | function | Handles changes to the selected snack configuration. | |
FormTestMachineNameValidationForm:: |
public | function | Submit callback that forces a form rebuild. | |
FormTestMachineNameValidationForm:: |
public | function | Validate callback that forces a form rebuild. | |
FormTestMachineNameValidationForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
FormTestMachineNameValidationForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
FormTestMachineNameValidationForm:: |
public | function | Loading stub for machine name. | |
FormTestMachineNameValidationForm:: |
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. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
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. | 3 |
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. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |