class FormTestFormStateValuesCleanForm

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

Form builder for \Drupal\Core\Form\FormState::cleanValues() test.

@internal

Hierarchy

Expanded class hierarchy of FormTestFormStateValuesCleanForm

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

Namespace

Drupal\form_test\Form
View source
class FormTestFormStateValuesCleanForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_form_state_clean_values_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // Build an example form containing multiple submit and button elements; not
        // only on the top-level.
        $form = [
            '#tree' => TRUE,
        ];
        $form['foo'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        $form['bar'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        $form['beer'] = [
            '#type' => 'value',
            '#value' => 1000,
        ];
        $form['baz']['foo'] = [
            '#type' => 'button',
            '#value' => t('Submit'),
        ];
        $form['baz']['baz'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        $form['baz']['beer'] = [
            '#type' => 'value',
            '#value' => 2000,
        ];
        // Add an arbitrary element and manually set it to be cleaned.
        // Using $form_state->addCleanValueKey('wine'); didn't work here.
        $class = static::class;
        $form['wine'] = [
            '#type' => 'value',
            '#value' => 3000,
            '#process' => [
                [
                    $class,
                    'cleanValue',
                ],
            ],
        ];
        return $form;
    }
    
    /**
     * Helper function to clean a value on an element.
     */
    public static function cleanValue(&$element, FormStateInterface $form_state, &$complete_form) {
        $form_state->addCleanValueKey('wine');
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_state->cleanValues();
        // This won't have a proper JSON header, but Drupal doesn't check for that
        // anyway so this is fine until it's replaced with a JsonResponse.
        print Json::encode($form_state->getValues());
        exit;
    }

}

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
FormTestFormStateValuesCleanForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestFormStateValuesCleanForm::cleanValue public static function Helper function to clean a value on an element.
FormTestFormStateValuesCleanForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestFormStateValuesCleanForm::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.