Dispatcher
实现 DispatcherInterface支持优先级监听器的 DispatcherInterface 的实现。
| 自 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
addEvent
将事件添加到此调度器，仅当事件不存在时。
addEvent(\Joomla\Event\EventInterface event) :
addListener
将监听器附加到事件
addListener( eventName, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, priority) :
| 自 |
1.0 |
|---|
参数
- 事件名称
string要监听的事件。- 回调
callable可调用函数- 优先级
int$callback 执行的优先级
响应
bool
addSubscriber
添加事件订阅者。
addSubscriber(\Joomla\Event\SubscriberInterface subscriber) :
clearEvents
清除所有事件。
clearEvents() : \Joomla\Event\EventInterface||string|int
clearListeners
清除此调度器中的监听器。
clearListeners( event = null) :
如果指定了事件，则将仅清除该事件的监听器。
| 自 |
1.0 |
|---|
参数
- 事件
string事件名称。
响应
$this
countEvents
统计已注册事件的数量。
countEvents() :
| 自 |
1.0 |
|---|---|
| 已弃用 |
3.0 将不再支持默认事件对象 |
响应
int已注册事件的数量。
countListeners
统计为给定事件注册的监听器数量。
countListeners( event) :
| 自 |
1.0 |
|---|
参数
- 事件
string事件名称。
响应
int
dispatch
将事件分派给所有已注册的监听器。
dispatch( name, \Joomla\Event\EventInterface event = null) : \Joomla\Event\EventInterface
| 自 |
2.0.0 |
|---|
参数
- 名称
string要分派的事件名称。- 事件
EventInterface|null要传递给事件处理程序/监听器的事件。如果未提供，则会创建一个空的 EventInterface 实例。注意，不传递事件已弃用，并且将在 3.0 中强制要求。
响应
getDefaultEvent
获取指定事件名称的事件对象
getDefaultEvent( name) : \Joomla\Event\EventInterface
getEvent
获取由给定名称标识的事件对象。
getEvent( name, default = null) : \Joomla\Event\EventInterface|mixed
getEvents
获取已注册的事件。
getEvents() : \Joomla\Event\EventInterface||string|int
getListenerPriority
获取给定事件的给定监听器的优先级。
getListenerPriority( eventName, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback) :
| 自 |
1.0 |
|---|
参数
- 事件名称
string要监听的事件。- 回调
callable可调用函数
响应
mixed监听器优先级，如果监听器不存在，则为 null。
getListeners
获取注册到给定事件的监听器。
getListeners(string|null event = null) : callable||string|int
| 自 |
1.0 |
|---|
参数
- 事件
string|null要获取监听器的事件，或为 null 以获取所有监听器
响应
array<string|int, callable>已注册的监听器数组，根据其优先级排序。
hasEvent
告知是否已将给定事件添加到此调度器。
hasEvent(\Joomla\Event\EventInterface|string event) :
hasListener
告知是否已添加给定监听器。
hasListener( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, string eventName = null) :
如果指定了事件，它将告知监听器是否已注册到该事件。
| 自 |
1.0 |
|---|
参数
- 回调
callable要检查的监听器是否正在监听事件。- 事件名称
string|null要检查监听器是否已订阅的可选事件名称。
响应
bool如果监听器已注册，则为 true，否则为 false。
removeEvent
从此调度器中删除事件。已注册的监听器将保留。
removeEvent(\Joomla\Event\EventInterface|string event) :
removeListener
从指定事件中删除事件监听器。
removeListener( eventName, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array listener) :
| 自 |
2.0.0 |
|---|
参数
- 事件名称
string要从中删除监听器的事件。- 监听器
callable要删除的监听器。
响应
void
removeSubscriber
删除事件订阅者。
removeSubscriber(\Joomla\Event\SubscriberInterface subscriber) :
setEvent
将事件设置为调度器。它将替换任何具有相同名称的事件。
setEvent(\Joomla\Event\EventInterface event) :
triggerEvent
触发事件。
triggerEvent(\Joomla\Event\EventInterface|string event) : \Joomla\Event\EventInterface
属性
监听器
按事件名称索引的 ListenersPriorityQueue 数组。
| 自 |
1.0 |
|---|
类型(s)
array<string|int, ListenersPriorityQueue>