hook_event_dispatcher-8.x-2.04/modules/core_event_dispatcher/tests/src/Kernel/Entity/EntityBundleFieldInfoAlterEventTest.php

<?php

namespace Drupal\Tests\core_event_dispatcher\Kernel\Entity;

use Drupal\core_event_dispatcher\EntityHookEvents;
use Drupal\core_event_dispatcher\Event\Entity\EntityBundleFieldInfoAlterEvent;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\hook_event_dispatcher\Kernel\ListenerTrait;
use Drupal\TestTools\Random;

/**
 * Class EntityBundleFieldInfoAlterEventTest.
 *
 * @covers \Drupal\core_event_dispatcher\Event\Entity\EntityBundleFieldInfoAlterEvent
 *
 * @group hook_event_dispatcher
 * @group core_event_dispatcher
 */
class EntityBundleFieldInfoAlterEventTest extends KernelTestBase {

  use ListenerTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'entity_test',
    'hook_event_dispatcher',
    'core_event_dispatcher',
  ];

  /**
   * The bundle machine name.
   *
   * @var string|int
   */
  protected string|int $bundle;

  /**
   * Test the EntityBundleFieldInfoAlterEvent.
   *
   * @dataProvider entityBundleFieldInfoAlterProvider
   *
   * @throws \Exception
   */
  public function testEntityBundleFieldInfoAlterEvent(string|int $bundle): void {
    $this->bundle = $bundle;
    $this->listen(EntityHookEvents::ENTITY_BUNDLE_FIELD_INFO_ALTER, 'onEntityBundleFieldInfoAlter');

    $definitions = $this->container
      ->get('entity_field.manager')
      ->getFieldDefinitions('entity_test', $this->bundle);

    $this->assertArrayHasKey('field_test', $definitions);
    $this->assertEquals('test_altered', $definitions['field_test']);
  }

  /**
   * Callback for EntityBundleFieldInfoAlterEvent.
   *
   * @param \Drupal\core_event_dispatcher\Event\Entity\EntityBundleFieldInfoAlterEvent $event
   *   The event.
   */
  public function onEntityBundleFieldInfoAlter(EntityBundleFieldInfoAlterEvent $event): void {
    $fields = &$event->getFields();
    $fields['field_test'] = 'test_altered';

    $this->assertEquals('entity_test', $event->getEntityType()->id());
    $this->assertEquals($this->bundle, $event->getBundle());
  }

  /**
   * Data provider for testEntityBundleFieldInfoAlterEvent().
   */
  public static function entityBundleFieldInfoAlterProvider(): \Generator {
    yield 'Random machine name' => [Random::machineName()];
    yield 'Integer bundle' => [mt_rand()];
  }

}