事件注册

swoft提供了简便的事件使用

注解

Listener

事件监听器类注解tag @Listener

  • 注解类： Swoft\Event\Annotation\Mapping\Listener
  • 作用范围： CLASS
  • 拥有属性：
    • event string 要监听的事件名称
    • priority int 此监听器的优先级，值越大越先被调用

注意你的类必须实现接口: Swoft\Event\EventHandlerInterface

Subscriber

事件监听器类注解tag @Subscriber，与 @Listener 不同的是，允许在同一个类里处理多个事件。

  • 注解类： Swoft\Event\Annotation\Mapping\Subscriber
  • 作用范围： CLASS

注意你的类必须实现接口: Swoft\Event\EventSubscriberInterface

示例

Listener示例

  1. <?php declare(strict_types=1);
  3. namespace SwoftTest\Event\Testing;
  5. use Swoft\Event\Annotation\Mapping\Listener;
  6. use Swoft\Event\EventHandlerInterface;
  7. use Swoft\Event\EventInterface;
  9. /**
  10.  * Class TestHandler
  11.  * @Listener("test.evt")
  12.  */
  13. class TestHandler implements EventHandlerInterface
  14. {
  15.     /**
  16.      * @param EventInterface $event
  17.      */
  18.     public function handle(EventInterface $event): void
  19.     {
  20.         $pos = __METHOD__;
  21.         echo "handle the event '{$event->getName()}' on the: $pos\n";
  22.     }
  23. }

Subscriber示例

  1. <?php declare(strict_types=1);
  3. namespace SwoftTest\Event\Testing;
  5. use Swoft\Event\Annotation\Mapping\Subscriber;
  6. use Swoft\Event\EventInterface;
  7. use Swoft\Event\EventSubscriberInterface;
  8. use Swoft\Event\Listener\ListenerPriority;
  10. /**
  11.  * Class TestSubscriber
  12.  * @Subscriber()
  13.  */
  14. class TestSubscriber implements EventSubscriberInterface
  15. {
  16.     public const EVENT_ONE = 'test.event1';
  17.     public const EVENT_TWO = 'test.event2';
  19.     /**
  20.      * Configure events and corresponding processing methods (you can configure the priority)
  21.      * @return array
  22.      * [
  23.      *  'event name' => 'handler method'
  24.      *  'event name' => ['handler method', priority]
  25.      * ]
  26.      */
  27.     public static function getSubscribedEvents(): array
  28.     {
  29.         return [
  30.             self::EVENT_ONE => 'handleEvent1',
  31.             self::EVENT_TWO => ['handleEvent2', ListenerPriority::HIGH],
  32.         ];
  33.     }
  35.     public function handleEvent1(EventInterface $evt): void
  36.     {
  37.         $evt->setParams(['msg' => 'handle the event: test.event1 position: TestSubscriber.handleEvent1()']);
  38.     }
  40.     public function handleEvent2(EventInterface $evt): void
  41.     {
  42.         $evt->setParams(['msg' => 'handle the event: test.event2 position: TestSubscriber.handleEvent2()']);
  43.     }
  44. }

触发事件

事件名称管理推荐放置在一个单独类的常量里面，方便管理和维护

  1. \Swoft::trigger('event name', null, $arg0, $arg1);