Joomla! API

下载
启动

BeforeDeleteEvent

扩展 DeleteEvent 实现 ResultAwareInterface

模型事件类。

示例：new BeforeDeleteEvent('onEventName', ['context' => 'com_example.example', 'subject' => $itemObjectToDelete]);

自

5.0.0
包

Joomla CMS

方法

__construct

构造函数。

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

BadMethodCallException
自

5.0.0

参数

name

string事件名称。

arguments

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

响应

mixed

addResult

将数据追加到事件的结果数组中。

addResult( data) :
继承
自

4.2.0

参数

data

mixed要添加到结果数组中的内容。

响应

void

create

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

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参数值或默认值。

getContext

context 参数的获取器。

getContext() :
继承
自

5.0.0

响应

string

getEventClassByEventName

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

getEventClassByEventName( eventName) :
继承 静态

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

自

4.2.0

参数

eventName

string事件名称

响应

string事件类名称

getItem

item 的获取器。

getItem() :
继承
自

5.0.0

响应

object

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

value

mixed参数值。

响应

void

offsetUnset

删除事件参数。

offsetUnset( name) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

响应

void

onSetContext

context 参数的设置器。

onSetContext( value) :
继承
自

5.0.0

参数

value

string要设置的值

响应

string

onSetResult

处理直接设置 result 参数。

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

subject 参数的设置器。

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

setResult

处理直接设置 result 参数。

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

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

继承 静态

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

自

4.2.0

类型

array<string|int, mixed>

构造

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

继承
自

4.0.0

类型

bool

legacyArgumentsOrder

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

继承 已弃用
自

5.0.0
已弃用

5.0 将在 6.0 中删除

类型

array<string|int, mixed>

resultIsNullable

result 属性值也可以为 NULL 吗？

继承
自

4.2.0

类型

bool

preventSetArgumentResult

禁止使用 setArgument() 直接设置 result 参数，而不是使用 addResult()。

继承 已弃用

你应该只为在 Joomla 4.2.0 之前不存在的事件名称或如果你是一个第三方开发者正在引入新的事件名称供你的软件使用，将此设置为 true。

自

4.2.0
已弃用

4.3 将在 6.0 中删除，使用 setResult() 设置 result 参数将始终被禁止。

类型

bool
  • \ Joomla
  • \ CMS
  • \ Event
  • \ Model
  • \ BeforeDeleteEvent