AfterCheckoutEvent

继承自 BeforeCheckoutEvent

\Joomla\CMS\Table\Table onAfterCheckout 事件的事件类

4.0.0

Joomla CMS

方法

__construct

构造函数。

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

必填参数:subject \Joomla\CMS\Table\TableInterface 我们正在操作的表格 userId integer 签出该行的用户 ID。pk mixed 可选的用于签出的主键值。

抛出

BadMethodCallException

参数

name

string事件名称。

arguments

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

响应

mixed

create

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

create( eventName, mixed||string|int arguments = []) : 
继承 static

eventClass string 事件类名称。如果您未提供它,将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。

4.0.0

抛出

BadMethodCallException如果您未提供主体参数

参数

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) : 
继承 static

如果该特性不识别事件名称,此方法将回退到通用 Joomla\Event\Event 类。

4.2.0

参数

eventName

string事件名称

响应

string事件类名称

offsetSet

设置事件参数的值。

offsetSet( name,  value) : 
继承

4.0.0

抛出

BadMethodCallException

参数

name

string参数名称。

value

mixed参数值。

响应

void

offsetUnset

删除事件参数。

offsetUnset( name) : 
继承

4.0.0

抛出

BadMethodCallException

参数

name

string参数名称。

响应

void

onSetSubject

主体参数的设置器

onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
继承
抛出

BadMethodCallException如果参数不是预期的类型。

4.4.0

参数

value

TableInterface要设置的值

响应

TableInterface

onSetUserId

userId 参数的设置器

onSetUserId( value) : 
继承
抛出

BadMethodCallException如果参数不是预期的类型

4.4.0

参数

value

mixed要设置的值

响应

mixed

setArgument

向事件添加参数。

setArgument( name,  value) : 
继承

如果存在,它将使用预处理方法。该方法的签名为

onSet<ArgumentName>($value): mixed

其中

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

4.0.0

参数

name

string参数名称。

value

mixed值。

响应

$this

setSubject

主体参数的设置器

setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
继承 已弃用
抛出

BadMethodCallException如果参数不是预期的类型。

已弃用

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

参数

value

TableInterface要设置的值

响应

TableInterface

setUserId

userId 参数的设置器

setUserId( value) : 
继承 已弃用
抛出

BadMethodCallException如果参数不是预期的类型

已弃用

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

参数

value

mixed要设置的值

响应

mixed

属性

eventNameToConcreteClass

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

继承 static

这仅适用于事件名称不变的事件。具有可变名称的事件通过 getEventClassByEventName 类中的 PHP 逻辑进行处理。

4.2.0

类型

array<string|int, mixed>

constructed

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

继承

4.0.0

类型

bool