BeforeBindEvent
扩展自 AbstractEventTable onBeforeBind 事件的事件类
自版本 |
4.0.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必填参数:subject TableInterface 我们正在操作的表 src mixed 要绑定到 Table 实例的关联数组或对象。ignore mixed 绑定时要忽略的属性的可选数组或空格分隔列表。
抛出 |
|
---|
参数
- name
string
事件名称。- arguments
array<string|int, mixed>
事件参数。
响应
mixed
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须给出以下参数:subject object 事件的主题。这是您将要操作的核心对象。
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
参数值或默认值。
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
onSetIgnore
ignore 参数的设置器
onSetIgnore( value) :
抛出 |
|
---|---|
自版本 |
4.4.0 |
参数
- value
mixed
要设置的值
响应
mixed
onSetSrc
src 参数的设置器
onSetSrc( value) :
抛出 |
|
---|---|
自版本 |
4.4.0 |
参数
- value
mixed
要设置的值
响应
mixed
onSetSubject
subject 参数的设置器
onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在,它将使用预处理方法。该方法具有签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
自版本 |
4.0.0 |
---|
参数
- name
string
参数名称。- value
mixed
值。
响应
$this
setIgnore
ignore 参数的设置器
setIgnore( value) :
抛出 |
|
---|---|
已弃用 |
4.4.0 将在 6.0 中移除 使用带有 onSet 前缀的对应项 |
参数
- value
mixed
要设置的值
响应
mixed
setSrc
src 参数的设置器
setSrc( value) :
抛出 |
|
---|---|
已弃用 |
4.4.0 将在 6.0 中移除 使用带有 onSet 前缀的对应项 |
参数
- value
mixed
要设置的值
响应
mixed
setSubject
subject 参数的设置器
setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
抛出 |
|
---|---|
已弃用 |
4.4.0 将在 6.0 中移除 使用带有 onSet 前缀的对应项 |
参数
- value
TableInterface
要设置的值
响应
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于事件名称不变的事件。事件名称可变的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
自版本 |
4.2.0 |
---|
类型
array<string|int, mixed>
已构造
一个标志,用于查看是否已调用构造函数。
自版本 |
4.0.0 |
---|
类型
bool