BeforeCommandExecuteEvent
扩展 ConsoleEvent在执行命令之前触发的事件。
| 自 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
事件构造函数。
__construct(\Joomla\Console\Application application, \Joomla\Console\Command\AbstractCommand|null command = null) :
__serialize
序列化事件。
__serialize() : mixed||string|int
| 自 |
2.0.0 |
|---|
响应
array<string|int, mixed> 要序列化的数据
__unserialize
反序列化事件。
__unserialize(mixed||string|int data) :
| 自 |
2.0.0 |
|---|
参数
- data
array<string|int, mixed>序列化事件。
响应
void
addArgument
添加事件参数，但前提是它不存在。
addArgument( name, value) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。- value
mixed参数值。
响应
$this
clearArguments
清除所有事件参数。
clearArguments() : mixed||string|int
| 自 |
1.0 |
|---|
响应
array<string|int, mixed> 旧参数。
count
计算参数的数量。
count() :
| 自 |
1.0 |
|---|
响应
int 参数数量。
disableCommand
禁用命令。
disableCommand() :
| 自 |
2.0.0 |
|---|
响应
void
enableCommand
启用命令。
enableCommand() :
| 自 |
2.0.0 |
|---|
响应
void
getArgument
获取事件参数值。
getArgument( name, default = null) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
响应
mixed 参数值或默认值。
getArguments
获取所有事件参数。
getArguments() : mixed||string|int
| 自 |
1.0 |
|---|
响应
array<string|int, mixed> 一个关联数组，参数名称作为键，其值作为值。
getCommand
获取正在执行的命令。
getCommand() : \Joomla\Console\Command\AbstractCommand|null
getName
获取事件名称。
getName() :
| 自 |
1.0 |
|---|
响应
string 事件名称。
hasArgument
判断给定的事件参数是否存在。
hasArgument( name) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。
响应
bool 如果存在则为 true，否则为 false。
isCommandEnabled
检查命令是否已启用。
isCommandEnabled() :
| 自 |
2.0.0 |
|---|
响应
bool
isStopped
判断事件传播是否已停止。
isStopped() :
| 自 |
1.0 |
|---|
响应
bool 如果已停止则为 true，否则为 false。
offsetExists
判断给定的事件参数是否存在。
offsetExists( name) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。
响应
bool 如果存在则为 true，否则为 false。
offsetGet
获取事件参数值。
offsetGet( name) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。
响应
mixed 参数值，如果不存在则为 null。
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。
响应
void
removeArgument
删除事件参数。
removeArgument( name) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。
响应
mixed 旧参数值，如果不存在则为 null。
serialize
序列化事件。
serialize() :
| 自 |
1.0 |
|---|
响应
string 序列化事件。
setArgument
将参数添加到事件。
setArgument( name, value) :
| 自 |
1.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
stop
停止事件传播。
stop() :
| 自 |
1.0 |
|---|---|
| 已弃用 |
3.0 使用 stopPropagation 代替 |
响应
void
stopPropagation
停止事件传播到进一步的事件监听器。
stopPropagation() :
| 自 |
2.0.0 |
|---|
响应
void
unserialize
反序列化事件。
unserialize( serialized) :
| 自 |
1.0 |
|---|
参数
- 序列化
string序列化事件。
响应
void
常量
RETURN_CODE_DISABLED
此事件禁用的命令的返回代码。
| 值 | 113 |
|---|---|
| 自 |
2.0.0 |
类型
int
属性
name
事件名称。
| 自 |
1.0 |
|---|
类型
string
arguments
事件参数。
| 自 |
1.0 |
|---|
类型
array<string|int, mixed>
stopped
一个标志，用于查看事件传播是否已停止。
| 自 |
1.0 |
|---|
类型
bool
commandEnabled
指示命令是否已启用的标志
| 自 |
2.0.0 |
|---|
类型
bool