SubmitContactEvent
扩展 AbstractImmutableEvent联系事件类
自 |
5.0.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
抛出 |
|
---|---|
自 |
5.0.0 |
参数
- name
string
事件名称。- arguments
array<string|int, mixed>
事件参数。
响应
mixed
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须给出以下参数:主题对象 事件的主题。这是您要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass string 事件类名称。如果您没有提供它,将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- eventName
string
事件名称,例如 onTableBeforeLoad- arguments
array<string|int, mixed>
传递给事件的附加参数
响应
静态
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在,它将使用预处理方法。该方法的签名为
onGet<ArgumentName>($value): mixed
其中
$value 是当前存储在事件的 $arguments 数组中的值 它返回要返回给调用者的值。
自 |
4.0.0 |
---|
参数
- name
string
参数名称。- default
mixed
如果未找到,则为默认值。
响应
mixed
参数值或默认值。
getContact
获取联系人的 getter。
getContact() :
自 |
5.0.0 |
---|
响应
object
getData
获取数据的 getter。
getData() : mixed||string|int
自 |
5.0.0 |
---|
响应
array<string|int, mixed>
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果事件名称对此特征未知,此方法会回退到通用的 Joomla\Event\Event 类。
自 |
4.2.0 |
---|
参数
- eventName
string
事件名称
响应
string
事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- name
string
参数名称。- value
mixed
参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- name
string
参数名称。
响应
void
onSetData
数据参数的 setter。
onSetData(mixed||string|int value) : mixed||string|int
自 |
5.0.0 |
---|
参数
- value
array<string|int, mixed>
要设置的值
响应
array<string|int, mixed>
onSetSubject
主题参数的 setter。
onSetSubject( value) :
自 |
5.0.0 |
---|
参数
- value
object
要设置的值
响应
object
reshapeArguments
重塑参数数组以保留与旧版侦听器的 b/c
reshapeArguments(mixed||string|int arguments, mixed||string|int argumentNames, mixed||string|int defaults = []) : mixed||string|int
自 |
4.2.0 |
---|
参数
- arguments
array<string|int, mixed>
传递给构造函数的命名参数数组。- argumentNames
array<string|int, mixed>
允许的参数名称(强制和可选)。- defaults
array<string|int, mixed>
可选参数的默认值。
响应
array<string|int, mixed>
重塑的参数。
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在,它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回以设置在事件的 $arguments 数组中的值。
自 |
4.0.0 |
---|
参数
- name
string
参数名称。- value
mixed
值。
响应
$this
updateData
更新数据。
updateData(mixed||string|int value) :
自 |
5.0.0 |
---|
参数
- value
array<string|int, mixed>
要设置的值
响应
静态
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这只适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。
自 |
4.2.0 |
---|
类型
array<string|int, mixed>
constructed
一个标志,用于查看构造函数是否已被调用。
自 |
4.0.0 |
---|
类型
bool
legacyArgumentsOrder
参数名称,按旧版插件所需的顺序排列。
自 |
5.0.0 |
---|---|
已弃用 |
5.0 将在 6.0 中删除 |
类型
array<string|int, mixed>