DispatcherInterface
事件分发器的接口。
自 |
1.0 |
---|---|
包 |
Joomla 框架 |
方法
addListener
将监听器附加到事件
addListener( eventName, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, priority) :
自 |
2.0.0 |
---|
参数
- eventName
string
要监听的事件。- callback
callable
可调用函数。- priority
int
$callback 执行的优先级。
响应
bool
addSubscriber
添加事件订阅者。
addSubscriber(\Joomla\Event\SubscriberInterface subscriber) :
clearListeners
清除此分发器中的监听器。
clearListeners( event = null) :
如果指定了事件,则只为该事件清除监听器。
自 |
2.0.0 |
---|
参数
- event
string
事件名称。
响应
$this
countListeners
计算为给定事件注册的监听器数量。
countListeners( event) :
自 |
2.0.0 |
---|
参数
- event
string
事件名称。
响应
int
dispatch
将事件分发到所有注册的监听器。
dispatch( name, \Joomla\Event\EventInterface event = null) : \Joomla\Event\EventInterface
自 |
2.0.0 |
---|
参数
- name
string
要分发的事件的名称。- event
EventInterface|null
要传递给事件处理程序/监听器的事件。如果未提供,则会创建一个空的 EventInterface 实例。注意,不传递事件已弃用,在 3.0 版本中将被强制要求。
响应
getListeners
获取注册到给定事件的监听器。
getListeners(string|null event = null) : callable||string|int
自 |
2.0.0 |
---|
参数
- event
string|null
要获取监听器的事件,或 null 以获取所有监听器
响应
array<string|int, callable>
根据其优先级排序的注册监听器数组。
hasListener
判断是否添加了给定的监听器。
hasListener( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, string|null eventName = null) :
如果指定了事件,它将判断是否为该事件注册了监听器。
自 |
2.0.0 |
---|
参数
- callback
callable
要检查是否正在监听事件的可调用对象。- eventName
string|null
要检查监听器是否订阅的可选事件名称。
响应
bool
如果监听器已注册,则为 true,否则为 false。
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 |
---|
参数
- eventName
string
要从中删除监听器的事件。- listener
callable
要删除的监听器。
响应
void
removeSubscriber
删除事件订阅者。
removeSubscriber(\Joomla\Event\SubscriberInterface subscriber) :