Joomla! API

下载
启动

AfterTitleEvent

扩展自 ContentPrepareEvent 实现 ResultAwareInterface

内容事件的类。

示例：new AfterTitleEvent('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

参数

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

上下文参数的 Getter。

getContext() :
继承
自版本

5.0.0

返回值

string

getEventClassByEventName

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

getEventClassByEventName( eventName) :
继承 静态

如果事件名称对此特性未知，则此方法将回退到通用 Joomla\Event\Event 类。

自版本

4.2.0

参数

eventName

string事件名称

返回值

string事件类名称

getItem

项目参数的 Getter。

getItem() :
继承
自版本

5.0.0

返回值

object

getPage

页面参数的 Getter。

getPage() : int
继承
自版本

5.0.0

返回值

int|null

getParams

项目参数的 Getter。

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

5.0.0

返回值

Registry

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自版本

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

value

mixed参数值。

返回值

void

offsetUnset

移除事件参数。

offsetUnset( name) :
继承
自版本

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

返回值

void

onSetContext

上下文参数的 Setter。

onSetContext( value) :
继承
自版本

5.0.0

参数

value

string要设置的值

返回值

string

onSetPage

页面参数的 Setter。

onSetPage(int value) : int
继承
自版本

5.0.0

参数

value

int|null要设置的值

返回值

int|null

onSetParams

params 参数的 Setter。

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

5.0.0

参数

value

Registry要设置的值

返回值

Registry

onSetResult

处理直接设置结果参数。

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

参数

value

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

返回值

array<string|int, mixed>

onSetSubject

主题参数的 Setter。

onSetSubject( value) :
继承
自版本

5.0.0

参数

value

object要设置的值

返回值

object

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 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用通用事件类而不是此包中实现的具体事件。这允许在 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

类型(s)

array<string|int, mixed>

constructed

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

继承
自版本

4.0.0

类型(s)

bool

legacyArgumentsOrder

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

继承 已弃用
自版本

5.0.0
已弃用

5.0 将在 6.0 中移除

类型(s)

array<string|int, mixed>

resultIsNullable

结果属性值也可以为 NULL 吗？

继承
自版本

4.2.0

类型(s)

bool

resultIsFalseable

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

继承 已弃用
自版本

4.2.0
已弃用

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

类型(s)

bool

preventSetArgumentResult

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

继承 已弃用

您应该仅对在 Joomla 4.2.0 之前不存在的事件名称或您是第三方开发人员为仅在您的软件中使用而引入的新事件名称将其设置为 true。

自版本

4.2.0
已弃用

4.3 将在 6.0 中移除。对于结果参数，将始终不允许使用 setResult()。

类型(s)

bool
  • \ Joomla
  • \ CMS
  • \ Event
  • \ Content
  • \ AfterTitleEvent