实体事件

Testing Is Documentation

tests/Database/Ddd/EntityEventTest.php

实体在新增和更新时，预植了事件监听器，可以定义一些事件。

Uses

<?php

use Leevel\Database\Ddd\Entity;
use Leevel\Di\Container;
use Leevel\Event\Dispatch;
use Leevel\Kernel\Utils\Api;
use PHPUnit\Framework\Attributes\DataProvider;
use Tests\Database\DatabaseTestCase as TestCase;
use Tests\Database\Ddd\Entity\DemoEventEntity;

事件基本使用方法

public function testBaseUse(): void
{
    $dispatch = new Dispatch(new Container());
    self::assertNull(Entity::eventDispatch());
    Entity::withEventDispatch($dispatch);
    $this->assertInstanceof(Dispatch::class, Entity::eventDispatch());

    $test = new DemoEventEntity(['name' => 'foo']);
    DemoEventEntity::event(Entity::BEFORE_CREATING_EVENT, static function (): void {
        $_SERVER['ENTITY.BEFORE_CREATING_EVENT'] = 'BEFORE_CREATING_EVENT';
    });
    DemoEventEntity::event(Entity::AFTER_CREATED_EVENT, static function (): void {
        $_SERVER['ENTITY.AFTER_CREATED_EVENT'] = 'AFTER_CREATED_EVENT';
    });

    self::assertFalse(isset($_SERVER['ENTITY.BEFORE_CREATING_EVENT']));
    self::assertFalse(isset($_SERVER['ENTITY.AFTER_CREATED_EVENT']));

    $test->create()->flush();

    self::assertTrue(isset($_SERVER['ENTITY.BEFORE_CREATING_EVENT']));
    self::assertTrue(isset($_SERVER['ENTITY.AFTER_CREATED_EVENT']));
    self::assertSame('BEFORE_CREATING_EVENT', $_SERVER['ENTITY.BEFORE_CREATING_EVENT']);
    self::assertSame('AFTER_CREATED_EVENT', $_SERVER['ENTITY.AFTER_CREATED_EVENT']);

    unset($_SERVER['ENTITY.BEFORE_CREATING_EVENT'], $_SERVER['ENTITY.AFTER_CREATED_EVENT']);
}

实体支持的事件

# Tests\Database\Ddd\EntityEventTest::getSupportedEvent
public static function getSupportedEvent(): array
{
    return [
        [Entity::BEFORE_SAVING_EVENT],
        [Entity::AFTER_SAVED_EVENT],
        [Entity::BEFORE_CREATING_EVENT],
        [Entity::AFTER_CREATED_EVENT],
        [Entity::BEFORE_UPDATING_EVENT],
        [Entity::AFTER_UPDATED_EVENT],
        [Entity::BEFORE_DELETING_EVENT],
        [Entity::AFTER_DELETED_EVENT],
        [Entity::BEFORE_SOFT_DELETING_EVENT],
        [Entity::AFTER_SOFT_DELETED_EVENT],
        [Entity::BEFORE_SOFT_RESTORING_EVENT],
        [Entity::AFTER_SOFT_RESTORED_EVENT],
    ];
}

public function testSupportEvent($event): void
{
    $dispatch = new Dispatch(new Container());
    self::assertNull(Entity::eventDispatch());
    Entity::withEventDispatch($dispatch);
    $this->assertInstanceof(Dispatch::class, Entity::eventDispatch());

    $supportEvent = DemoEventEntity::supportEvent();
    self::assertTrue(\in_array($event, $supportEvent, true));
}

不受支持的事件

public function testEventWasNotSupport(): void
{
    $this->expectException(\InvalidArgumentException::class);
    $this->expectExceptionMessage('Event `not_support` do not support.');

    $dispatch = new Dispatch(new Container());
    self::assertNull(Entity::eventDispatch());
    Entity::withEventDispatch($dispatch);
    $this->assertInstanceof(Dispatch::class, Entity::eventDispatch());
    DemoEventEntity::event('not_support', static function (): void {});
}