Joomla! API

下载
启动

LoginEvent

继承自 AbstractLoginEvent 实现 ResultAwareInterface

用户事件类。

示例：new LoginEvent('onEventName', ['subject' => $authenticationResponseArray, 'options' => $options]);

自

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

getAuthenticationResponse

响应的获取器。

getAuthenticationResponse() : mixed||string|int
继承
自

5.0.0

响应

array<string|int, mixed>

getEventClassByEventName

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

getEventClassByEventName( eventName) :
继承 静态

如果此特征不知道事件名称，则此方法会回退到通用的 Joomla\Event\Event 类。

自

4.2.0

参数

eventName

string事件名称

响应

string事件类名

getOptions

选项的获取器。

getOptions() : mixed||string|int
继承
自

5.0.0

响应

array<string|int, mixed>

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

value

mixed参数值。

响应

void

offsetUnset

删除事件参数。

offsetUnset( name) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

string参数名称。

响应

void

onSetOptions

选项参数的设置器。

onSetOptions(mixed||string|int value) : mixed||string|int
继承
自

5.0.0

参数

value

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

响应

array<string|int, mixed>

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

主题参数的设置器。

onSetSubject(mixed||string|int value) : mixed||string|int
继承
自

5.0.0

参数

value

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

响应

array<string|int, mixed>

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

处理直接设置结果参数。

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

类型(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

preventSetArgumentResult

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

继承 已弃用

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

自

4.2.0
已弃用

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

类型(s)

bool
  • \ Joomla
  • \ CMS
  • \ Event
  • \ User
  • \ LoginEvent