Joomla! API

下载
启动

BeforeValidateDataEvent

扩展 FormEvent

模型表单事件的类。

示例：new BeforeValidateDataEvent('onEventName', ['subject' => $form, 'data' => $data]);

自

5.0.0
包

Joomla CMS

方法

__construct

构造函数。

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

BadMethodCallException
自

5.0.0

参数

名称

string事件名称。

参数

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

响应

混合

create

为给定的事件名称和主题创建新的 CMS 事件对象。必须给出以下参数：主题对象事件的主题。这是您要操作的核心对象。

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

eventClass 字符串事件类名称。如果您不提供它，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。

自

4.0.0
抛出

BadMethodCallException如果您没有提供主题参数

参数

eventName

string事件的名称，例如 onTableBeforeLoad

参数

array<string|int, mixed>要传递给事件的额外参数

响应

静态

getArgument

获取事件参数值。

getArgument( name,  default = null) :
继承

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

onGet<ArgumentName>($value): mixed

其中

$value 是当前存储在事件 $arguments 数组中的值 它返回要返回给调用者的值。

自

4.0.0

参数

名称

string参数名称。

默认

mixed如果未找到，则为默认值。

响应

mixed参数值或默认值。

getContext

上下文参数的 Getter。

getContext() :
继承
自

5.0.0

响应

字符串

getData

数据的 Getter。

getData() : object|array
继承
自

5.0.0

响应

对象 | 数组<字符串 | 整数，混合>

getEventClassByEventName

获取给定事件名称的具体事件类名称。

getEventClassByEventName( eventName) :
继承 静态

如果此特征不认识事件名称，此方法将回退到通用的 Joomla\Event\Event 类。

自

4.2.0

参数

eventName

string事件名称

响应

string事件类名称

getForm

表单的 Getter。

getForm() : \Joomla\CMS\Form\Form
继承
自

5.0.0

响应

表单

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

名称

string参数名称。

值

mixed参数值。

响应

空

offsetUnset

删除事件参数。

offsetUnset( name) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

名称

string参数名称。

响应

空

onSetContext

上下文参数的 Setter。

onSetContext( value) :
继承
自

5.0.0

参数

值

string要设置的值

响应

字符串

onSetData

数据参数的 Setter。

onSetData(object|array value) : object|array
继承
自

5.0.0

参数

值

object|array<string|int, mixed>要设置的值

响应

对象 | 数组<字符串 | 整数，混合>

onSetSubject

主题参数的 Setter。

onSetSubject(\Joomla\CMS\Form\Form value) : \Joomla\CMS\Form\Form
继承
自

5.0.0

参数

值

Form要设置的值

响应

表单

reshapeArguments

重塑参数数组以保留与传统监听器的向后兼容性

reshapeArguments(mixed||string|int arguments, mixed||string|int argumentNames, mixed||string|int defaults = []) : mixed||string|int
继承
自

4.2.0

参数

参数

array<string|int, mixed>传递给构造函数的命名参数数组。

argumentNames

array<string|int, mixed>允许的参数名称（必填和可选）。

默认值

array<string|int, mixed>可选参数的默认值。

响应

array<string|int, mixed>重塑的参数。

setArgument

将参数添加到事件中。

setArgument( name,  value) :
继承

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

onSet<ArgumentName>($value): mixed

其中

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

自

4.0.0

参数

名称

string参数名称。

值

mixed值。

响应

$this

updateData

更新数据。

updateData(object|array value) :
自

5.0.0

参数

值

object|array<string|int, mixed>要设置的值

响应

静态

属性

eventNameToConcreteClass

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

继承 静态

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

自

4.2.0

类型

数组<字符串 | 整数，混合>

已构建

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

继承
自

4.0.0

类型

布尔值

legacyArgumentsOrder

参数名称，按传统插件期望的顺序排列。

继承 已弃用
自

5.0.0
已弃用

5.0 将在 6.0 中删除

类型

数组<字符串 | 整数，混合>
  • \ Joomla
  • \ CMS
  • \ 事件
  • \ 模型
  • \ BeforeValidateDataEvent