class FormElementHelperTest

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php \Drupal\Tests\Core\Form\FormElementHelperTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php \Drupal\Tests\Core\Form\FormElementHelperTest
  3. 10 core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php \Drupal\Tests\Core\Form\FormElementHelperTest

Tests the form element helper.

@group Drupal @group Form

@coversDefaultClass \Drupal\Core\Form\FormElementHelper

Hierarchy

Expanded class hierarchy of FormElementHelperTest

File

core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php, line 18

Namespace

Drupal\Tests\Core\Form
View source 
class FormElementHelperTest extends UnitTestCase {
    
    /**
     * Tests the getElementByName() method.
     *
     * @covers ::getElementByName
     *
     * @dataProvider getElementByNameProvider
     */
    public function testGetElementByName($name, $form, $expected) : void {
        $this->assertSame($expected, FormElementHelper::getElementByName($name, $form));
    }
    
    /**
     * Provides test data.
     */
    public static function getElementByNameProvider() {
        $data = [];
        $data[] = [
            'id',
            [],
            [],
        ];
        $data[] = [
            'id',
            [
                'id' => [
                    '#title' => 'ID',
                    '#parents' => [
                        'id',
                    ],
                ],
            ],
            [
                '#title' => 'ID',
                '#parents' => [
                    'id',
                ],
            ],
        ];
        $data[] = [
            'id',
            [
                'fieldset' => [
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            [
                '#title' => 'ID',
                '#parents' => [
                    'id',
                ],
            ],
        ];
        $data[] = [
            'fieldset',
            [
                'fieldset' => [
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            [
                'id' => [
                    '#title' => 'ID',
                    '#parents' => [
                        'id',
                    ],
                ],
                '#parents' => [
                    'fieldset',
                ],
            ],
        ];
        $data[] = [
            'fieldset][id',
            [
                'fieldset' => [
                    '#tree' => TRUE,
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'fieldset',
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            [
                '#title' => 'ID',
                '#parents' => [
                    'fieldset',
                    'id',
                ],
            ],
        ];
        return $data;
    }
    
    /**
     * Tests the getElementTitle() method.
     *
     * @covers ::getElementTitle
     *
     * @dataProvider getElementTitleProvider
     */
    public function testGetElementTitle($name, $form, $expected) : void {
        $element = FormElementHelper::getElementByName($name, $form);
        $this->assertSame($expected, FormElementHelper::getElementTitle($element));
    }
    
    /**
     * Provides test data.
     */
    public static function getElementTitleProvider() {
        $data = [];
        $data[] = [
            'id',
            [],
            '',
        ];
        $data[] = [
            'id',
            [
                'id' => [
                    '#title' => 'ID',
                    '#parents' => [
                        'id',
                    ],
                ],
            ],
            'ID',
        ];
        $data[] = [
            'id',
            [
                'fieldset' => [
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            'ID',
        ];
        $data[] = [
            'fieldset',
            [
                'fieldset' => [
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            'ID',
        ];
        $data[] = [
            'fieldset][id',
            [
                'fieldset' => [
                    '#tree' => TRUE,
                    'id' => [
                        '#title' => 'ID',
                        '#parents' => [
                            'fieldset',
                            'id',
                        ],
                    ],
                    '#parents' => [
                        'fieldset',
                    ],
                ],
            ],
            'ID',
        ];
        return $data;
    }

}

Members

Title Modifiers Object type Summary Overrides
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
FormElementHelperTest::getElementByNameProvider public static function Provides test data.
FormElementHelperTest::getElementTitleProvider public static function Provides test data.
FormElementHelperTest::testGetElementByName public function Tests the getElementByName() method.
FormElementHelperTest::testGetElementTitle public function Tests the getElementTitle() method.
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.
UnitTestCase::$root protected property The app root.
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 358
UnitTestCase::setUpBeforeClass public static function

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