类处理器
命名空间: Cake\Queue\Queue
常量
属性摘要
-
$_eventClass protected
字符串
新事件对象的默认类名。
-
$_eventManager protected
Cake\Event\EventManagerInterface|null
Cake\Event\EventManager 的实例,此对象用于分派内部事件。
-
$container protected
Cake\Core\ContainerInterface|null
-
$logger protected
Psr\Log\LoggerInterface
方法摘要
-
__construct() public
处理器构造函数
-
dispatchEvent() public
用于创建和分派事件的包装器。
-
getEventManager() public
返回此对象的 Cake\Event\EventManager 管理器实例。
-
process() public
该方法处理消息
-
processMessage() public
-
setEventManager() public
返回此对象的 Cake\Event\EventManagerInterface 实例。
方法详细
__construct() ¶ public
__construct(Psr\Log\LoggerInterface|null $logger = null, Cake\Core\ContainerInterface|null $container = null)
处理器构造函数
参数
-
Psr\Log\LoggerInterface|null
$logger 可选 记录器实例。
-
Cake\Core\ContainerInterface|null
$container 可选 DI 容器实例
dispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>
用于创建和分派事件的包装器。
返回一个已分派的事件。
参数
-
string
$name 事件名称。
-
array
$data 可选 您希望与该事件一起传输的任何值,监听器都可以读取这些值。
-
TSubject|null
$subject 可选 此事件适用的对象(默认情况下为 $this)。
返回值
Cake\Event\EventInterface<TSubject>
getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterface
返回此对象的 Cake\Event\EventManager 管理器实例。
您可以使用此实例向对象事件注册任何新的监听器或回调,或创建您自己的事件并在需要时触发它们。
返回值
Cake\Event\EventManagerInterface
process() ¶ public
process(Interop\Queue\Message $message, Context $context): object|string
该方法处理消息
该方法还可以返回一个对象。它必须实现 __toString 方法,并且该方法必须返回上面列出的常量之一。
参数
-
Interop\Queue\Message
$message 消息。
-
Context
$context 上下文。
返回值
对象|字符串
processMessage() ¶ public
processMessage(Cake\Queue\Job\Message $message): object|string
参数
-
Cake\Queue\Job\Message
$message 消息。
返回值
对象|字符串
setEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $this
返回此对象的 Cake\Event\EventManagerInterface 实例。
您可以使用此实例向对象事件注册任何新的监听器或回调,或创建您自己的事件并在需要时触发它们。
参数
-
Cake\Event\EventManagerInterface
$eventManager 要设置的 eventManager
返回值
$this