CanRemoveDataEvent
扩展 PrivacyEvent 实现 ResultAwareInterface隐私事件的类。
示例：new CanRemoveDataEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
| 自 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自 |
5.0.0 |
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
mixed
addResult
将数据追加到事件的结果数组。
addResult( data) :
| 自 |
4.2.0 |
|---|
参数
- data
mixed要添加到结果数组的内容。
响应
void
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须提供以下参数：subject 对象 事件的主题。这是您将要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass string 事件类名称。如果您没有提供，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- eventName
string事件名称，例如 onTableBeforeLoad- arguments
array<string|int, mixed>传递给事件的附加参数
响应
static
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事件类名称
getRequest
请求的 Getter。
getRequest() : \Joomla\Component\Privacy\Administrator\Table\RequestTable
| 自 |
5.0.0 |
|---|
响应
RequestTable
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
void
onSetResult
处理直接设置结果参数。
onSetResult(mixed||string|int value) : mixed||string|int
此方法有两个目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望通用事件类而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的整个生命周期中迁移到具体事件类。
当 $this->preventSetArgumentResult 为 false 时（在 Joomla 5.0 上总是如此），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.4.0 |
|---|
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
onSetSubject
主题参数的 Setter。
onSetSubject(\Joomla\Component\Privacy\Administrator\Table\RequestTable value) : \Joomla\Component\Privacy\Administrator\Table\RequestTable
| 自 |
5.0.0 |
|---|
参数
- value
RequestTable要设置的值
响应
RequestTable
onSetUser
用户参数的 Setter。
onSetUser(\Joomla\CMS\User\User value) : \Joomla\CMS\User\User
reshapeArguments
重塑参数数组以保持与遗留侦听器的向后兼容性
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
setResult
处理直接设置结果参数。
setResult(mixed||string|int value) : mixed||string|int
此方法有两个目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望通用事件类而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的整个生命周期中迁移到具体事件类。
当 $this->preventSetArgumentResult 为 false 时（在 Joomla 5.0 上总是如此），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除。使用带 onSet 前缀的对应项 |
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
属性
eventNameToConcreteClass
将事件名称映射到具体 Event 类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 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>
preventSetArgumentResult
禁止使用 setArgument() 直接设置结果参数，而不是通过 addResult() 设置。
您应该仅对 Joomla 4.2.0 之前不存在的事件名称或如果您是第三方开发人员为仅在您的软件中使用引入新的事件名称，才将此设置为 true。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除。使用 setResult() 设置结果参数将始终被禁止。 |
类型
bool