OnGetApiFields
扩展 AbstractImmutableEvent用于获取与实体一起渲染的额外 API 字段和关系的事件
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必填参数：type string 字段类型。应为 static::VIEW_TYPE 中的常量 fields 字段将在 API 中渲染的字段列表。
| 抛出 |
|
|---|
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
mixed
addFields
允许用户添加将被解释为关系的属性名称。请注意，如果存在现有数据属性，它也将显示，以及关系，由于内部实现（此行为不是此 API 的一部分，不应保证）。
addFields(string||string|int fields) :
参数
- fields
array<string|int, string>要添加到属性数据的附加字段数组
响应
void
addRelations
允许用户添加将被解释为关系的属性名称。请注意，如果存在现有数据属性，它也将显示，以及关系，由于内部实现（此行为不是此 API 的一部分，不应保证）。
addRelations(string||string|int fields) :
参数
- fields
array<string|int, string>要添加为关系的附加字段数组
响应
void
create
为给定事件名称和主题创建新的 CMS 事件对象。必须提供以下参数：subject 对象 事件主题。这是您将要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass string 事件类名称。如果您不提供它，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- eventName
string事件名称，例如 onTableBeforeLoad- arguments
array<string|int, mixed>要传递给事件的附加参数
响应
static
getAllPropertiesToRender
获取要渲染的属性。
getAllPropertiesToRender() : mixed||string|int
响应
array<string|int, mixed>
getAllRelationsToRender
获取要渲染的属性。
getAllRelationsToRender() : mixed||string|int
响应
array<string|int, mixed>
getArgument
获取事件参数值。
getArgument( name, default = null) :
它将使用预处理方法（如果存在）。该方法的签名为
onGet<ArgumentName>($value): mixed
其中
$value 是当前存储在事件的 $arguments 数组中的值 它返回要返回给调用者的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
响应
mixed参数值或默认值。
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果此特征不认识事件名称，此方法将回退到通用的 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
void
setArgument
将参数添加到事件。
setArgument( name, value) :
它将使用预处理方法（如果存在）。该方法的签名为
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setFields
fields 参数的 setter
setFields( value) : mixed||string|int
| 抛出 |
|
|---|
参数
- value
mixed要设置的值
响应
array<string|int, mixed>
setRelations
relations 参数的 setter
setRelations( value) : mixed||string|int
| 抛出 |
|
|---|
参数
- value
mixed要设置的值
响应
array<string|int, mixed>
setType
type 参数的 setter
setType( value) :
| 抛出 |
|
|---|
参数
- value
intVIEW_TYPE 中的常量
响应
mixed
常量
LIST
支持的视图类型的列表
| 值 | 'list' |
|---|---|
| 自 |
4.0.0 |
ITEM
支持的视图类型的列表
| 值 | 'item' |
|---|---|
| 自 |
4.0.0 |
属性
eventNameToConcreteClass
将事件名称映射到具体的 Event 类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已经被调用。
| 自 |
4.0.0 |
|---|
类型
bool
extraRelations
将被渲染为关系的属性名称列表
| 自 |
4.0.0 |
|---|
类型
array<string|int, string>
extraAttributes
将被渲染为数据的属性名称列表
| 自 |
4.0.0 |
|---|
类型
array<string|int, string>