class FormTestProgrammaticForm

Same name and namespace in other branches
  1. 9 core/modules/system/tests/modules/form_test/src/Form/FormTestProgrammaticForm.php \Drupal\form_test\Form\FormTestProgrammaticForm
  2. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestProgrammaticForm.php \Drupal\form_test\Form\FormTestProgrammaticForm
  3. 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestProgrammaticForm.php \Drupal\form_test\Form\FormTestProgrammaticForm

Form builder to test programmatic form submissions.

@internal

Hierarchy

Expanded class hierarchy of FormTestProgrammaticForm

File

core/modules/system/tests/modules/form_test/src/Form/FormTestProgrammaticForm.php, line 13

Namespace

Drupal\form_test\Form
View source
class FormTestProgrammaticForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_programmatic_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['textfield'] = [
            '#title' => 'Textfield',
            '#type' => 'textfield',
        ];
        $form['checkboxes'] = [
            '#title' => t('Checkboxes'),
            '#type' => 'checkboxes',
            '#options' => [
                1 => 'First checkbox',
                2 => 'Second checkbox',
            ],
            // Both checkboxes are selected by default so that we can test the ability
            // of programmatic form submissions to uncheck them.
'#default_value' => [
                1,
                2,
            ],
        ];
        $form['field_to_validate'] = [
            '#type' => 'radios',
            '#title' => 'Field to validate (in the case of limited validation)',
            '#description' => 'If the form is submitted by clicking the "Submit with limited validation" button, then validation can be limited based on the value of this radio button.',
            '#options' => [
                'all' => 'Validate all fields',
                'textfield' => 'Validate the "Textfield" field',
                'field_to_validate' => 'Validate the "Field to validate" field',
            ],
            '#default_value' => 'all',
        ];
        $form['field_restricted'] = [
            '#type' => 'textfield',
            '#title' => 'Textfield (no access)',
            '#access' => FALSE,
        ];
        // The main submit button for the form.
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => 'Submit',
        ];
        // A secondary submit button that allows validation to be limited based on
        // the value of the above radio selector.
        $form['submit_limit_validation'] = [
            '#type' => 'submit',
            '#value' => 'Submit with limited validation',
            // Use the same submit handler for this button as for the form itself.
            // (This must be set explicitly or otherwise the form API will ignore the
            // #limit_validation_errors property.)
'#submit' => [
                '::submitForm',
            ],
        ];
        $user_input = $form_state->getUserInput();
        if (!empty($user_input['field_to_validate']) && $user_input['field_to_validate'] != 'all') {
            $form['submit_limit_validation']['#limit_validation_errors'] = [
                [
                    $user_input['field_to_validate'],
                ],
            ];
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        if ($form_state->isValueEmpty('textfield')) {
            $form_state->setErrorByName('textfield', t('Textfield is required.'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_state->set('programmatic_form_submit', $form_state->getValues());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
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. Overrides UrlGeneratorTrait::redirect
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.
FormTestProgrammaticForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestProgrammaticForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestProgrammaticForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormTestProgrammaticForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.