OnGetApiAttributes
扩展 AbstractImmutableEvent获取 API 实体额外数据属性的事件
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必填参数：属性数组 对象的主要数据。上下文字符串 API 资源的内容类型。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string事件名称。- 参数
array<string|int, mixed>事件参数。
响应
混合
addAttribute
设置要在 API 中呈现的命名属性。
addAttribute( name, value) :
| 自 |
4.0.0 |
|---|
参数
- 名称
string要在 API 中呈现的属性的名称- 值
mixed要在 API 中呈现的命名属性的值。
响应
void
addAttributes
设置要在 API 中呈现的属性。
addAttributes(mixed||string|int value) :
| 自 |
4.0.0 |
|---|
参数
- 值
array<string|int, mixed>要添加到 API 的属性的键值对数组。
响应
void
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须给出以下参数：主题对象 事件的主题。这是您要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
事件类字符串 事件类名称。如果您没有提供它，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 事件名称
string事件的名称，例如 onTableBeforeLoad- 参数
array<string|int, mixed>要传递给事件的附加参数
响应
static
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在，它将使用预处理方法。该方法的签名为
onGet<ArgumentName>($value): mixed
其中
$value 是当前存储在事件的 $arguments 数组中的值 它返回要返回给调用者的值。
| 自 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 默认
mixed如果未找到，则为默认值。
响应
mixed参数值或默认值。
getAttributes
要呈现的属性。
getAttributes() : mixed||string|int
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果事件名称对该特质未知，此方法将回退到通用 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- 事件名称
string事件名称
响应
string事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
void
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
| 自 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 值
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型
bool
属性
属性
| 自 |
4.0.0 |
|---|
类型
array<string|int, mixed>