class FormTestValidateRequiredForm

Same name in other branches
  1. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestValidateRequiredForm.php \Drupal\form_test\Form\FormTestValidateRequiredForm
  2. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestValidateRequiredForm.php \Drupal\form_test\Form\FormTestValidateRequiredForm
  3. 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestValidateRequiredForm.php \Drupal\form_test\Form\FormTestValidateRequiredForm

Form constructor to test the #required property.

@internal

Hierarchy

Expanded class hierarchy of FormTestValidateRequiredForm

1 string reference to 'FormTestValidateRequiredForm'
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/FormTestValidateRequiredForm.php, line 13

Namespace

Drupal\form_test\Form
View source
class FormTestValidateRequiredForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_validate_required_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $options = [
            'foo' => 'foo',
            'bar' => 'bar',
        ];
        $validate = [
            '::elementValidateRequired',
        ];
        $form['textfield'] = [
            '#type' => 'textfield',
            '#title' => 'Name',
            '#required' => TRUE,
            '#required_error' => t('Please enter a name.'),
        ];
        $form['checkboxes'] = [
            '#type' => 'checkboxes',
            '#title' => 'Checkboxes',
            '#options' => $options,
            '#required' => TRUE,
            '#form_test_required_error' => t('Please choose at least one option.'),
            '#element_validate' => $validate,
        ];
        $form['select'] = [
            '#type' => 'select',
            '#title' => 'Select',
            '#options' => $options,
            '#required' => TRUE,
            '#form_test_required_error' => t('Please select something.'),
            '#element_validate' => $validate,
        ];
        $form['radios'] = [
            '#type' => 'radios',
            '#title' => 'Radios',
            '#options' => $options,
            '#required' => TRUE,
        ];
        $form['radios_optional'] = [
            '#type' => 'radios',
            '#title' => 'Radios (optional)',
            '#options' => $options,
        ];
        $form['radios_optional_default_value_false'] = [
            '#type' => 'radios',
            '#title' => 'Radios (optional, with a default value of FALSE)',
            '#options' => $options,
            '#default_value' => FALSE,
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => 'Submit',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function elementValidateRequired($element, FormStateInterface $form_state) {
        // Set a custom validation error on the #required element.
        if (!empty($element['#required_but_empty']) && isset($element['#form_test_required_error'])) {
            $form_state->setError($element, $element['#form_test_required_error']);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->messenger()
            ->addStatus('The form_test_validate_required_form form was submitted successfully.');
    }

}

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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
FormTestValidateRequiredForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestValidateRequiredForm::elementValidateRequired public function
FormTestValidateRequiredForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestValidateRequiredForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.