class FormTestValidateForm

Same name in other branches
  1. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestValidateForm.php \Drupal\form_test\Form\FormTestValidateForm
  2. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestValidateForm.php \Drupal\form_test\Form\FormTestValidateForm
  3. 11.x 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

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\Form
View 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

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 105
FormBase::currentUser protected function Gets the current user.
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.
FormTestValidateForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestValidateForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestValidateForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormTestValidateForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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.