class FormHelperTest

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

Hierarchy

Expanded class hierarchy of FormHelperTest

File

View on git.drupalcode.org

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

Namespace

Drupal\Tests\Core\Form
View source 
class FormHelperTest extends UnitTestCase {
  
  /**
   * Tests rewriting the #states selectors.
   *
   * @covers ::rewriteStatesSelector
   */
  public function testRewriteStatesSelector() : void {
    // 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) : void {
    $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 static function providerElements() {
    return [
      [
        [
          '#type' => 'date',
          '#states' => [
            'visible' => [
              ':input[name="toggle_me"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ],
        '#attributes',
      ],
      [
        [
          '#type' => 'item',
          '#states' => [
            'visible' => [
              ':input[name="foo"]' => [
                'value' => 'bar',
              ],
            ],
          ],
          '#markup' => '',
          '#input' => TRUE,
        ],
        '#wrapper_attributes',
      ],
    ];
  }

}

Members

Title Deprecated Modifiers Object type Summary Overrides
FormHelperTest::providerElements public static function Provides a list of elements to test.
FormHelperTest::testProcessStates public function @covers ::processStates[[api-linebreak]]
@dataProvider providerElements
FormHelperTest::testRewriteStatesSelector public function Tests rewriting the #states selectors.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
UnitTestCase::$root protected property The app root. 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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 357
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function

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