You are here

Home » API reference » Drupal 9 » FormTestStorageForm.php

class FormTestStorageForm in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/system/tests/modules/form_test/src/Form/FormTestStorageForm.php \Drupal\form_test\Form\FormTestStorageForm

A multistep form for testing the form storage.

It uses two steps for editing a virtual "thing". Any changes to it are saved in the form storage and have to be present during any step. By setting the request parameter "cache" the form can be tested with caching enabled, as it would be the case, if the form would contain some #ajax callbacks.

@internal

Hierarchy

Expanded class hierarchy of FormTestStorageForm

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

Namespace

Drupal\form_test\Form
View source 
class FormTestStorageForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'form_test_storage_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if ($form_state
      ->isRebuilding()) {
      $form_state
        ->setUserInput([]);
    }

    // Initialize
    $storage = $form_state
      ->getStorage();
    $session = $this
      ->getRequest()
      ->getSession();
    if (empty($storage)) {
      $user_input = $form_state
        ->getUserInput();
      if (empty($user_input)) {
        $session
          ->set('constructions', 0);
      }

      // Put the initial thing into the storage
      $storage = [
        'thing' => [
          'title' => 'none',
          'value' => '',
        ],
      ];
      $form_state
        ->setStorage($storage);
    }

    // Count how often the form is constructed.
    $counter = $session
      ->get('constructions');
    $session
      ->set('constructions', ++$counter);
    $this
      ->messenger()
      ->addStatus("Form constructions: " . $counter);
    $form['title'] = [
      '#type' => 'textfield',
      '#title' => 'Title',
      '#default_value' => $storage['thing']['title'],
      '#required' => TRUE,
    ];
    $form['value'] = [
      '#type' => 'textfield',
      '#title' => 'Value',
      '#default_value' => $storage['thing']['value'],
      '#element_validate' => [
        '::elementValidateValueCached',
      ],
    ];
    $form['continue_button'] = [
      '#type' => 'button',
      '#value' => 'Reset',
    ];
    $form['continue_submit'] = [
      '#type' => 'submit',
      '#value' => 'Continue submit',
      '#submit' => [
        '::continueSubmitForm',
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => 'Save',
    ];

    // @todo Remove this in https://www.drupal.org/node/2524408, because form
    //   cache immutability is no longer necessary, because we no longer cache
    //   forms during safe HTTP methods. In the meantime, because
    //   Drupal\system\Tests\Form still has test coverage for a poisoned form
    //   cache following a GET request, trick $form_state into caching the form
    //   to keep that test working until we either remove it or change it in
    //   that issue.
    if ($this
      ->getRequest()
      ->get('immutable')) {
      $form_state
        ->addBuildInfo('immutable', TRUE);
      if ($this
        ->getRequest()
        ->get('cache') && $this
        ->getRequest()
        ->isMethodCacheable()) {
        $form_state
          ->setRequestMethod('FAKE');
        $form_state
          ->setCached();
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($this
      ->getRequest()
      ->get('cache')) {

      // Manually activate caching, so we can test that the storage keeps working
      // when it's enabled.
      $form_state
        ->setCached();
    }
  }

  /**
   * Form element validation handler for 'value' element.
   *
   * Tests updating of cached form storage during validation.
   */
  public function elementValidateValueCached($element, FormStateInterface $form_state) {

    // If caching is enabled and we receive a certain value, change the storage.
    // This presumes that another submitted form value triggers a validation error
    // elsewhere in the form. Form API should still update the cached form storage
    // though.
    if ($this
      ->getRequest()
      ->get('cache') && $form_state
      ->getValue('value') == 'change_title') {
      $form_state
        ->set([
        'thing',
        'changed',
      ], TRUE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function continueSubmitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->set([
      'thing',
      'title',
    ], $form_state
      ->getValue('title'));
    $form_state
      ->set([
      'thing',
      'value',
    ], $form_state
      ->getValue('value'));
    $form_state
      ->setRebuild();
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->messenger()
      ->addStatus("Title: " . Html::escape($form_state
      ->getValue('title')));
    $this
      ->messenger()
      ->addStatus("Form constructions: " . $this
      ->getRequest()
      ->getSession()
      ->get('constructions'));
    if ($form_state
      ->has([
      'thing',
      'changed',
    ])) {
      $this
        ->messenger()
        ->addStatus("The thing has been changed.");
    }
    $form_state
      ->setRedirect('<front>');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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.
FormTestStorageForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestStorageForm::continueSubmitForm public function
FormTestStorageForm::elementValidateValueCached public function Form element validation handler for 'value' element.
FormTestStorageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestStorageForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormTestStorageForm::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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.