FormTestStoragePageCacheForm.php

Same filename in other branches
  1. 9 core/modules/system/tests/modules/form_test/src/Form/FormTestStoragePageCacheForm.php
  2. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestStoragePageCacheForm.php
  3. 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestStoragePageCacheForm.php

Namespace

Drupal\form_test\Form

File

core/modules/system/tests/modules/form_test/src/Form/FormTestStoragePageCacheForm.php

View source
<?php

namespace Drupal\form_test\Form;

use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Form to test page cache storage.
 *
 * @internal
 */
class FormTestStoragePageCacheForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_storage_page_cache';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['title'] = [
            '#type' => 'textfield',
            '#title' => 'Title',
            '#required' => TRUE,
        ];
        $form['test_build_id_old'] = [
            '#type' => 'item',
            '#title' => 'Old build id',
            '#markup' => 'No old build id',
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => 'Save',
        ];
        $form['rebuild'] = [
            '#type' => 'submit',
            '#value' => 'Rebuild',
            '#submit' => [
                [
                    $this,
                    'form_test_storage_page_cache_rebuild',
                ],
            ],
        ];
        $form['#after_build'] = [
            [
                $this,
                'form_test_storage_page_cache_old_build_id',
            ],
        ];
        return $form;
    }
    
    /**
     * Form element #after_build callback: output the old form build-id.
     */
    public function form_test_storage_page_cache_old_build_id($form) {
        if (isset($form['#build_id_old'])) {
            $form['test_build_id_old']['#plain_text'] = $form['#build_id_old'];
        }
        return $form;
    }
    
    /**
     * Form submit callback: Rebuild the form and continue.
     */
    public function form_test_storage_page_cache_rebuild($form, FormStateInterface $form_state) {
        $form_state->setRebuild();
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        // Test using form cache when re-displaying a form due to validation
        // errors.
        if ($form_state->hasAnyErrors()) {
            $form_state->setCached();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Nothing must happen.
    }

}

Classes

Title Deprecated Summary
FormTestStoragePageCacheForm Form to test page cache storage.

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