class FormHelperTest in Drupal 8

@coversDefaultClass \Drupal\Core\Form\FormHelper @group Form

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Form\FormHelperTest

File

core/tests/Drupal/Tests/Core/Form/FormHelperTest.php, line 13

Namespace

Drupal\Tests\Core\Form

class FormHelperTest extends UnitTestCase {

  /**
   * Tests rewriting the #states selectors.
   *
   * @covers ::rewriteStatesSelector
   */
  public function testRewriteStatesSelector() {

    // Simple selectors.
    $value = [
      'value' => 'medium',
    ];
    $form['foo']['#states'] = [
      'visible' => [
        'select[name="fields[foo-id][settings_edit_form][settings][image_style]"]' => $value,
      ],
    ];
    FormHelper::rewriteStatesSelector($form, 'fields[foo-id][settings_edit_form]', 'options');
    $expected_selector = 'select[name="options[settings][image_style]"]';
    $this
      ->assertSame($form['foo']['#states']['visible'][$expected_selector], $value, 'The #states selector was not properly rewritten.');

    // Complex selectors.
    $form = [];
    $form['bar']['#states'] = [
      'visible' => [
        [
          ':input[name="menu[type]"]' => [
            'value' => 'normal',
          ],
        ],
        [
          ':input[name="menu[type]"]' => [
            'value' => 'tab',
          ],
        ],
        ':input[name="menu[type]"]' => [
          'value' => 'default tab',
        ],
      ],
      // Example from https://www.drupal.org/node/1464758
      'disabled' => [
        '[name="menu[options][dependee_1]"]' => [
          'value' => 'ON',
        ],
        [
          [
            '[name="menu[options][dependee_2]"]' => [
              'value' => 'ON',
            ],
          ],
          [
            '[name="menu[options][dependee_3]"]' => [
              'value' => 'ON',
            ],
          ],
        ],
        [
          [
            '[name="menu[options][dependee_4]"]' => [
              'value' => 'ON',
            ],
          ],
          'xor',
          [
            '[name="menu[options][dependee_5]"]' => [
              'value' => 'ON',
            ],
          ],
        ],
      ],
    ];
    $expected['bar']['#states'] = [
      'visible' => [
        [
          ':input[name="options[type]"]' => [
            'value' => 'normal',
          ],
        ],
        [
          ':input[name="options[type]"]' => [
            'value' => 'tab',
          ],
        ],
        ':input[name="options[type]"]' => [
          'value' => 'default tab',
        ],
      ],
      'disabled' => [
        '[name="options[options][dependee_1]"]' => [
          'value' => 'ON',
        ],
        [
          [
            '[name="options[options][dependee_2]"]' => [
              'value' => 'ON',
            ],
          ],
          [
            '[name="options[options][dependee_3]"]' => [
              'value' => 'ON',
            ],
          ],
        ],
        [
          [
            '[name="options[options][dependee_4]"]' => [
              'value' => 'ON',
            ],
          ],
          'xor',
          [
            '[name="options[options][dependee_5]"]' => [
              'value' => 'ON',
            ],
          ],
        ],
      ],
    ];
    FormHelper::rewriteStatesSelector($form, 'menu', 'options');
    $this
      ->assertSame($expected, $form, 'The #states selectors were properly rewritten.');
  }

  /**
   * @covers ::processStates
   * @dataProvider providerElements
   */
  public function testProcessStates($elements, $key) {
    $json = Json::encode($elements['#states']);
    FormHelper::processStates($elements);
    $this
      ->assertEquals([
      'core/drupal.states',
    ], $elements['#attached']['library']);
    $this
      ->assertEquals($json, $elements[$key]['data-drupal-states']);
  }

  /**
   * Provides a list of elements to test.
   */
  public function providerElements() {
    return [
      [
        [
          '#type' => 'date',
          '#states' => [
            'visible' => [
              ':input[name="toggle_me"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ],
        '#attributes',
      ],
      [
        [
          '#type' => 'item',
          '#states' => [
            'visible' => [
              ':input[name="foo"]' => [
                'value' => 'bar',
              ],
            ],
          ],
        ],
        '#wrapper_attributes',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FormHelperTest::providerElements	public	function	Provides a list of elements to test.
FormHelperTest::testProcessStates	public	function	@covers ::processStates @dataProvider providerElements
FormHelperTest::testRewriteStatesSelector	public	function	Tests rewriting the #states selectors.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		340