class FormErrorHandlerTest

Same name in this branch

main core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php \Drupal\Tests\inline_form_errors\Unit\FormErrorHandlerTest

Same name and namespace in other branches

11.x core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php \Drupal\Tests\inline_form_errors\Unit\FormErrorHandlerTest
11.x core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php \Drupal\Tests\Core\Form\FormErrorHandlerTest
10 core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php \Drupal\Tests\inline_form_errors\Unit\FormErrorHandlerTest
10 core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php \Drupal\Tests\Core\Form\FormErrorHandlerTest
9 core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php \Drupal\Tests\inline_form_errors\Unit\FormErrorHandlerTest
9 core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php \Drupal\Tests\Core\Form\FormErrorHandlerTest
8.9.x core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php \Drupal\Tests\inline_form_errors\Unit\FormErrorHandlerTest
8.9.x core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php \Drupal\Tests\Core\Form\FormErrorHandlerTest

Tests Drupal\Core\Form\FormErrorHandler.

Attributes

#[CoversClass(FormErrorHandler::class)] #[Group('Form')]

Hierarchy

class \Drupal\Tests\UnitTestCase uses \Drupal\Tests\DrupalTestCaseTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\Tests\RandomGeneratorTrait extends \PHPUnit\Framework\TestCase
- class \Drupal\Tests\Core\Form\FormErrorHandlerTest extends \Drupal\Tests\UnitTestCase

Expanded class hierarchy of FormErrorHandlerTest

File

View on git.drupalcode.org

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

Namespace

Drupal\Tests\Core\Form

View source

class FormErrorHandlerTest extends UnitTestCase {
  
  /**
   * The form error handler.
   */
  protected FormErrorHandler $formErrorHandler;
  
  /**
   * The messenger.
   */
  protected MessengerInterface $messenger;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->messenger = $this->createStub(MessengerInterface::class);
    $container = new ContainerBuilder();
    $container->set('messenger', $this->messenger);
    \Drupal::setContainer($container);
    $this->formErrorHandler = new FormErrorHandler();
  }
  
  /**
   * Initializes the messenger as a mock object.
   */
  protected function setUpMockMessenger() : void {
    $this->messenger = $this->createMock(MessengerInterface::class);
    $container = new ContainerBuilder();
    $container->set('messenger', $this->messenger);
    \Drupal::setContainer($container);
  }
  
  /**
   * Tests display error messages.
   *
   * @legacy-covers ::handleFormErrors
   * @legacy-covers ::displayErrorMessages
   */
  public function testDisplayErrorMessages() : void {
    $this->setUpMockMessenger();
    $messages = [
      'invalid',
      'invalid',
      'invalid',
      'no title given',
      'element is invisible',
      'this missing element is invalid',
    ];
    $this->messenger
      ->expects($this->exactly(count($messages)))
      ->method('addMessage')
      ->with($this->callback(function (string $message) use (&$messages) : bool {
      return array_shift($messages) === $message;
    }), 'error');
    $form = [
      '#parents' => [],
      '#array_parents' => [],
    ];
    $form['test1'] = [
      '#type' => 'textfield',
      '#title' => 'Test 1',
      '#parents' => [
        'test1',
      ],
      '#array_parents' => [
        'test1',
      ],
      '#id' => 'edit-test1',
    ];
    $form['test2'] = [
      '#type' => 'textfield',
      '#title' => 'Test 2 & a half',
      '#parents' => [
        'test2',
      ],
      '#array_parents' => [
        'test2',
      ],
      '#id' => 'edit-test2',
    ];
    $form['fieldset'] = [
      '#parents' => [
        'fieldset',
      ],
      '#array_parents' => [
        'fieldset',
      ],
      'test3' => [
        '#type' => 'textfield',
        '#title' => 'Test 3',
        '#parents' => [
          'fieldset',
          'test3',
        ],
        '#array_parents' => [
          'fieldset',
          'test3',
        ],
        '#id' => 'edit-test3',
      ],
    ];
    $form['test5'] = [
      '#type' => 'textfield',
      '#parents' => [
        'test5',
      ],
      '#array_parents' => [
        'test5',
      ],
      '#id' => 'edit-test5',
    ];
    $form['test6'] = [
      '#type' => 'value',
      '#title' => 'Test 6',
      '#parents' => [
        'test6',
      ],
      '#array_parents' => [
        'test6',
      ],
      '#id' => 'edit-test6',
    ];
    $form_state = new FormState();
    $form_state->setErrorByName('test1', 'invalid');
    $form_state->setErrorByName('test2', 'invalid');
    $form_state->setErrorByName('fieldset][test3', 'invalid');
    $form_state->setErrorByName('test5', 'no title given');
    $form_state->setErrorByName('test6', 'element is invisible');
    $form_state->setErrorByName('missing_element', 'this missing element is invalid');
    $this->formErrorHandler
      ->handleFormErrors($form, $form_state);
    $this->assertSame('invalid', $form['test1']['#errors']);
  }
  
  /**
   * Tests set element errors from form state.
   *
   * @legacy-covers ::handleFormErrors
   * @legacy-covers ::setElementErrorsFromFormState
   */
  public function testSetElementErrorsFromFormState() : void {
    $form = [
      '#parents' => [],
      '#array_parents' => [],
    ];
    $form['test'] = [
      '#type' => 'textfield',
      '#title' => 'Test',
      '#parents' => [
        'test',
      ],
      '#array_parents' => [
        'test',
      ],
      '#id' => 'edit-test',
    ];
    $form['details'] = [
      '#type' => 'details',
      '#title' => 'Details grouping test',
      '#parents' => [
        'details',
      ],
      '#array_parents' => [
        'details',
      ],
      '#id' => 'edit-details',
    ];
    $form['grouping_test'] = [
      '#type' => 'textfield',
      '#title' => 'Grouping test',
      '#parents' => [
        'grouping_test',
      ],
      '#array_parents' => [
        'grouping_test',
      ],
      '#id' => 'edit-grouping-test',
      '#group' => 'details',
    ];
    $form['grouping_test2'] = [
      '#type' => 'textfield',
      '#title' => 'Grouping test 2',
      '#parents' => [
        'grouping_test2',
      ],
      '#array_parents' => [
        'grouping_test2',
      ],
      '#id' => 'edit-grouping-test2',
      '#group' => 'details',
    ];
    $form['details2'] = [
      '#type' => 'details',
      '#title' => 'Details grouping test 2',
      '#parents' => [
        'details2',
      ],
      '#array_parents' => [
        'details2',
      ],
      '#id' => 'edit-details2',
    ];
    $form['grouping_test3'] = [
      '#type' => 'textfield',
      '#title' => 'Grouping test 3',
      '#parents' => [
        'grouping_test3',
      ],
      '#array_parents' => [
        'grouping_test3',
      ],
      '#id' => 'edit-grouping-test3',
      '#group' => 'details2',
    ];
    $form['fieldset'] = [
      '#type' => 'fieldset',
      '#parents' => [
        'fieldset',
      ],
      '#array_parents' => [
        'fieldset',
      ],
      '#id' => 'edit-fieldset',
      'nested_test' => [
        '#type' => 'textfield',
        '#title' => 'Nested test',
        '#parents' => [
          'fieldset',
          'nested_test',
        ],
        '#array_parents' => [
          'fieldset',
          'nested_test',
        ],
        '#id' => 'edit-nested_test',
      ],
      'nested_test2' => [
        '#type' => 'textfield',
        '#title' => 'Nested test2',
        '#parents' => [
          'fieldset',
          'nested_test2',
        ],
        '#array_parents' => [
          'fieldset',
          'nested_test2',
        ],
        '#id' => 'edit-nested_test2',
      ],
    ];
    $form_state = new FormState();
    $form_state->setErrorByName('test', 'invalid');
    $form_state->setErrorByName('grouping_test', 'invalid');
    $form_state->setErrorByName('grouping_test2', 'invalid');
    $form_state->setErrorByName('fieldset][nested_test', 'invalid');
    $form_state->setErrorByName('fieldset][nested_test2', 'invalid2');
    $this->formErrorHandler
      ->handleFormErrors($form, $form_state);
    $this->assertSame('invalid', $form['test']['#errors']);
    $this->assertSame([
      'grouping_test' => 'invalid',
      'grouping_test2' => 'invalid',
    ], $form['details']['#children_errors']);
    $this->assertSame([
      'fieldset][nested_test' => 'invalid',
      'fieldset][nested_test2' => 'invalid2',
    ], $form['fieldset']['#children_errors']);
    $this->assertEmpty($form['details2']['#children_errors'], 'Children errors are empty for grouping element.');
    $this->assertCount(5, $form['#children_errors']);
  }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
DrupalTestCaseTrait::$root		protected	property	The Drupal root directory.
DrupalTestCaseTrait::checkErrorHandlerOnTearDown		public	function	Checks the test error handler after test execution.		1
DrupalTestCaseTrait::getDrupalRoot	Deprecated	protected static	function	Returns the Drupal root directory.		1
DrupalTestCaseTrait::setDebugDumpHandler		public static	function	Registers the dumper CLI handler when the DebugDump extension is enabled.
DrupalTestCaseTrait::setUpRoot		final protected	function	Ensure that the $root property is set initially.
FormErrorHandlerTest::$formErrorHandler		protected	property	The form error handler.
FormErrorHandlerTest::$messenger		protected	property	The messenger.
FormErrorHandlerTest::setUp		protected	function		Overrides UnitTestCase::setUp
FormErrorHandlerTest::setUpMockMessenger		protected	function	Initializes the messenger as a mock object.
FormErrorHandlerTest::testDisplayErrorMessages		public	function	Tests display error messages.
FormErrorHandlerTest::testSetElementErrorsFromFormState		public	function	Tests set element errors from form state.
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::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::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::setupMockIterator		protected	function	Set up a traversable class mock to return specific items when iterated.

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

class FormErrorHandlerTest

Attributes

Hierarchy

File

Namespace

Members

Search drupal main

API Navigation

Breadcrumb

class FormErrorHandlerTest

Attributes

Hierarchy

File

Namespace

Members

Search drupal main

API Navigation