BeforeStoreEvent

扩展自 AbstractEvent

用于 \Joomla\CMS\Table\Table onBeforeStore 事件的事件类

自版本

4.0.0

Joomla CMS

方法

__construct

构造函数。

__construct( name, mixed||string|int arguments = []) : 

必填参数:subject \Joomla\CMS\Table\TableInterface 我们正在操作的表格updateNulls 布尔值 如果字段为 null,则更新字段。k 混合 表格中主键字段的名称(字符串或字符串数组)。

抛出

BadMethodCallException

参数

name

string事件名称。

arguments

array<string|int, mixed>事件参数。

响应

mixed

create

为给定的事件名称和主题创建一个新的 CMS 事件对象。必须提供以下参数:subject 对象 事件的主题。这是您将要操作的核心对象。

create( eventName, mixed||string|int arguments = []) : 
继承 静态

eventClass string 事件类名称。如果您未提供,将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。

自版本

4.0.0

抛出

BadMethodCallException如果您未提供主题参数

参数

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

抛出

BadMethodCallException

参数

name

string参数名称。

value

mixed参数值。

响应

void

offsetUnset

删除事件参数。

offsetUnset( name) : 
继承
自版本

4.0.0

抛出

BadMethodCallException

参数

name

string参数名称。

响应

void

onSetSubject

主题参数的 Setter

onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
继承
抛出

BadMethodCallException如果参数不是预期的类型。

自版本

4.4.0

参数

value

TableInterface要设置的值

响应

TableInterface

onSetUpdateNulls

updateNulls 属性的 Setter

onSetUpdateNulls( value) : 
自版本

4.4.0

参数

value

mixed要设置的值

响应

bool规范化值

setArgument

将参数添加到事件。

setArgument( name,  value) : 
继承

如果存在,它将使用预处理方法。该方法具有以下签名

onSet<ArgumentName>($value): mixed

其中

$value 是用户设置的值 它返回要返回以设置在事件的 $arguments 数组中的值。

自版本

4.0.0

参数

name

string参数名称。

value

mixed值。

响应

$this

setSubject

主题参数的 Setter

setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
继承 已弃用
抛出

BadMethodCallException如果参数不是预期的类型。

已弃用

4.4.0 将在 6.0 中删除 使用带 onSet 前缀的对应项

参数

value

TableInterface要设置的值

响应

TableInterface

setUpdateNulls

updateNulls 属性的 Setter

setUpdateNulls( value) : 
已弃用
已弃用

4.4.0 将在 6.0 中删除 使用带 onSet 前缀的对应项

参数

value

mixed要设置的值

响应

bool规范化值

属性

eventNameToConcreteClass

将事件名称映射到具体的事件类。

继承 静态

这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。

自版本

4.2.0

类型

array<string|int, mixed>

已构造

一个标志,用于查看构造函数是否已被调用。

继承
自版本

4.0.0

类型

bool