
| Current Path : /var/www/html/rocksensor1/web/core/modules/system/tests/src/Kernel/Form/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/rocksensor1/web/core/modules/system/tests/src/Kernel/Form/ProgrammaticTest.php |
<?php
declare(strict_types=1);
namespace Drupal\Tests\system\Kernel\Form;
use Drupal\Core\Form\FormState;
use Drupal\KernelTests\KernelTestBase;
/**
* Tests the programmatic form submission behavior.
*
* @group Form
*/
class ProgrammaticTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['form_test'];
/**
* Tests the programmatic form submission workflow.
*/
public function testSubmissionWorkflow(): void {
// Backup the current batch status and reset it to avoid conflicts while
// processing the dummy form submit handler.
$current_batch = $batch =& batch_get();
$batch = [];
// Test that a programmatic form submission is rejected when a required
// textfield is omitted and correctly processed when it is provided.
$this->doSubmitForm([], FALSE);
$this->doSubmitForm(['textfield' => 'test 1'], TRUE);
$this->doSubmitForm([], FALSE);
$this->doSubmitForm(['textfield' => 'test 2'], TRUE);
// Test that a programmatic form submission can turn on and off checkboxes
// which are, by default, checked.
$this->doSubmitForm(['textfield' => 'dummy value', 'checkboxes' => [1 => 1, 2 => 2]], TRUE);
$this->doSubmitForm(['textfield' => 'dummy value', 'checkboxes' => [1 => 1, 2 => NULL]], TRUE);
$this->doSubmitForm(['textfield' => 'dummy value', 'checkboxes' => [1 => NULL, 2 => 2]], TRUE);
$this->doSubmitForm(['textfield' => 'dummy value', 'checkboxes' => [1 => NULL, 2 => NULL]], TRUE);
// Test that a programmatic form submission can correctly click a button
// that limits validation errors based on user input. Since we do not
// submit any values for "textfield" here and the textfield is required, we
// only expect form validation to pass when validation is limited to a
// different field.
$this->doSubmitForm(['op' => 'Submit with limited validation', 'field_to_validate' => 'all'], FALSE);
$this->doSubmitForm(['op' => 'Submit with limited validation', 'field_to_validate' => 'textfield'], FALSE);
$this->doSubmitForm(['op' => 'Submit with limited validation', 'field_to_validate' => 'field_to_validate'], TRUE);
// Restore the current batch status.
$batch = $current_batch;
}
/**
* Programmatically submits the form_test.module form with the given values.
*
* @param $values
* An array of field values to be submitted.
* @param $valid_input
* A boolean indicating whether or not the form submission is expected to
* be valid.
*/
protected function doSubmitForm($values, $valid_input) {
// Programmatically submit the given values.
$form_state = (new FormState())->setValues($values);
\Drupal::formBuilder()->submitForm('\Drupal\form_test\Form\FormTestProgrammaticForm', $form_state);
// Check that the form returns an error when expected, and vice versa.
$errors = $form_state->getErrors();
$valid_form = empty($errors);
$input_values = print_r($values, TRUE);
$validation_errors = $valid_form ? t('None') : implode(' ', $errors);
$this->assertSame($valid_form, $valid_input, sprintf('Input values: %s<br />Validation handler errors: %s', $input_values, $validation_errors));
// We check submitted values only if we have a valid input.
if ($valid_input) {
// Fetching the values that were set in the submission handler.
$stored_values = $form_state->get('programmatic_form_submit');
foreach ($values as $key => $value) {
$this->assertEquals($value, $stored_values[$key], sprintf('Submission handler correctly executed: %s is %s', $key, print_r($value, TRUE)));
}
}
}
/**
* Tests the programmed_bypass_access_check flag.
*/
public function testProgrammaticAccessBypass(): void {
$form_state = (new FormState())->setValues([
'textfield' => 'dummy value',
'field_restricted' => 'dummy value',
]);
// Programmatically submit the form with a value for the restricted field.
// Since programmed_bypass_access_check is set to TRUE by default, the
// field is accessible and can be set.
\Drupal::formBuilder()->submitForm('\Drupal\form_test\Form\FormTestProgrammaticForm', $form_state);
$values = $form_state->get('programmatic_form_submit');
$this->assertEquals('dummy value', $values['field_restricted'], 'The value for the restricted field is stored correctly.');
// Programmatically submit the form with a value for the restricted field
// with programmed_bypass_access_check set to FALSE. Since access
// restrictions apply, the restricted field is inaccessible, and the value
// should not be stored.
$form_state->setProgrammedBypassAccessCheck(FALSE);
\Drupal::formBuilder()->submitForm('\Drupal\form_test\Form\FormTestProgrammaticForm', $form_state);
$values = $form_state->get('programmatic_form_submit');
$this->assertNotSame('dummy value', $values['field_restricted'], 'The value for the restricted field is not stored.');
}
}