Joomla! API

下载
启动

BeforeDisplayEvent

扩展 ContentPrepareEvent 实现 ResultAwareInterface

内容事件类。

示例：new BeforeDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);

自

5.0.0
包

Joomla CMS

方法

__construct

构造函数。

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

BadMethodCallException
自

5.0.0

参数

名称

string事件名称。

参数

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

响应

混合

addResult

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

addResult( data) :
继承
自

4.2.0

参数

数据

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

响应

void

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

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

getPage

page 参数的获取器。

getPage() : int
继承
自

5.0.0

响应

int|null

getParams

item 参数的获取器。

getParams() : \Joomla\Registry\Registry
继承
自

5.0.0

响应

注册表

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

名称

string参数名称。

值

mixed参数值。

响应

void

offsetUnset

删除事件参数。

offsetUnset( name) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

名称

string参数名称。

响应

void

onSetContext

context 参数的设置器。

onSetContext( value) :
继承
自

5.0.0

参数

值

string要设置的值

响应

string

onSetPage

page 参数的设置器。

onSetPage(int value) : int
继承
自

5.0.0

参数

值

int|null要设置的值

响应

int|null

onSetParams

params 参数的设置器。

onSetParams(\Joomla\Registry\Registry value) : \Joomla\Registry\Registry
继承
自

5.0.0

参数

值

Registry要设置的值

响应

注册表

onSetResult

处理直接设置 result 参数。

onSetResult(mixed||string|int value) : mixed||string|int
继承

此方法有两个目的：向后兼容性和强制使用 addResult。

当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容性垫片，这些处理程序期望使用通用事件类而不是此包中实现的具体事件。这允许在 Joomla 4.x 的整个生命周期内迁移到具体事件类。

当 $this->preventSetArgumentResult 为 false 时（这在 Joomla 5.0 上始终是这种情况），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。

自

4.4.0

参数

值

array<string|int, mixed>新的结果数组。

响应

array<string|int, mixed>

onSetSubject

subject 参数的设置器。

onSetSubject( value) :
继承
自

5.0.0

参数

值

object要设置的值

响应

object

reshapeArguments

重塑参数数组以保留与旧版侦听器的 b/c

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>允许的参数名称（强制和可选）。

defaults

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

响应

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

setArgument

将参数添加到事件。

setArgument( name,  value) :
继承

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

onSet<ArgumentName>($value): mixed

其中

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

自

4.0.0

参数

名称

string参数名称。

值

mixed值。

响应

$this

setResult

处理直接设置 result 参数。

setResult(mixed||string|int value) : mixed||string|int
继承 已弃用

此方法有两个目的：向后兼容性和强制使用 addResult。

当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容性垫片，这些处理程序期望使用通用事件类而不是此包中实现的具体事件。这允许在 Joomla 4.x 的整个生命周期内迁移到具体事件类。

当 $this->preventSetArgumentResult 为 false 时（这在 Joomla 5.0 上始终是这种情况），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。

自

4.2.0
已弃用

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

参数

值

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

resultIsFalseable

result 属性值也可以为布尔值 FALSE 吗？

继承 已弃用
自

4.2.0
已弃用

4.3 将在 6.0 中删除。你应该使用可空值或异常，而不是返回布尔值 false 结果。

类型

bool

preventSetArgumentResult

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

继承 已弃用

你应该仅对在 Joomla 4.2.0 之前不存在的事件名称设置此值，或者如果你是一个第三方开发人员为仅在你的软件中使用而引入了新的事件名称。

自

4.2.0
已弃用

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

类型

bool
  • \ Joomla
  • \ CMS
  • \ 事件
  • \ 内容
  • \ BeforeDisplayEvent