StateValuesCleanTest.php

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

Namespace

Drupal\Tests\system\Functional\Form

File

core/modules/system/tests/src/Functional/Form/StateValuesCleanTest.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Form;

use Drupal\Component\Serialization\Json;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests the proper removal of submitted form values.
 *
 * @see \Drupal\Core\Form\FormState::cleanValues()
 *
 * @group Form
 */
class StateValuesCleanTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests \Drupal\Core\Form\FormState::cleanValues().
     */
    public function testFormStateValuesClean() : void {
        $this->drupalGet('form_test/form-state-values-clean');
        $this->submitForm([], 'Submit');
        $values = Json::decode($this->getSession()
            ->getPage()
            ->getContent());
        // Setup the expected result.
        $result = [
            'beer' => 1000,
            'baz' => [
                'beer' => 2000,
            ],
        ];
        // Verify that all internal Form API elements were removed.
        $this->assertFalse(isset($values['form_id']), 'form_id was removed.');
        $this->assertFalse(isset($values['form_token']), 'form_token was removed.');
        $this->assertFalse(isset($values['form_build_id']), 'form_build_id was removed.');
        $this->assertFalse(isset($values['op']), 'op was removed.');
        // Verify that all buttons were removed.
        $this->assertFalse(isset($values['foo']), 'foo was removed.');
        $this->assertFalse(isset($values['bar']), 'bar was removed.');
        $this->assertFalse(isset($values['baz']['foo']), 'foo was removed.');
        $this->assertFalse(isset($values['baz']['baz']), 'baz was removed.');
        // Verify values manually added for cleaning were removed.
        $this->assertFalse(isset($values['wine']), 'wine was removed.');
        // Verify that nested form value still exists.
        $this->assertTrue(isset($values['baz']['beer']), 'Nested form value still exists.');
        // Verify that actual form values equal resulting form values.
        $this->assertEquals($result, $values, 'Expected form values equal actual form values.');
    }

}

Classes

Title Deprecated Summary
StateValuesCleanTest Tests the proper removal of submitted form values.

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