FormHelper
表单助手类。
提供一个存储表单实体所在的文件系统路径的存储空间，以及创建这些实体的方法。 还存储具有实体原型的对象，以供进一步重用。
| 自 |
1.7.0 |
|---|---|
| 包 |
Joomla CMS |
方法
addFieldPath
将路径添加到字段包含路径列表的方法。
addFieldPath(string|string[] new = null) : string||string|int
| 自 |
1.7.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的路径或路径数组。
响应
array<string|int, string>已添加的路径列表。
addFieldPrefix
将命名空间前缀添加到字段查找列表的方法。
addFieldPrefix(string|string[] new = null) : string||string|int
| 自 |
3.8.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的命名空间或命名空间数组。
响应
array<string|int, string>已添加的命名空间列表。
addFilterPath
将路径添加到过滤器包含路径列表的方法。
addFilterPath(string|string[] new = null) : string||string|int
| 自 |
4.0.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的路径或路径数组。
响应
array<string|int, string>已添加的路径列表。
addFilterPrefix
将命名空间添加到过滤器查找列表的方法。
addFilterPrefix(string|string[] new = null) : string||string|int
| 自 |
4.0.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的命名空间或命名空间数组。
响应
array<string|int, string>已添加的命名空间列表。
addFormPath
将路径添加到表单包含路径列表的方法。
addFormPath(string|string[] new = null) : string||string|int
| 自 |
1.7.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的路径或路径数组。
响应
array<string|int, string>已添加的路径列表。
addFormPrefix
将命名空间添加到表单查找列表的方法。
addFormPrefix(string|string[] new = null) : string||string|int
| 自 |
3.8.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的命名空间或命名空间数组。
响应
array<string|int, string>已添加的命名空间列表。
addPath
将路径添加到表单实体之一的包含路径列表的方法。
addPath( entity, string|string[] new = null) : string||string|int
当前支持的实体：字段、规则和表单。 您可以在子类中自由支持自己的实体。
| 自 |
1.7.0 |
|---|
参数
- 实体
string将添加路径的表单实体名称。- 新
string|array<string|int, string>要添加的路径或路径数组。
响应
array<string|int, string>已添加的路径列表。
addPrefix
将命名空间添加到表单实体之一的命名空间列表的方法。
addPrefix( entity, string|string[] new = null) : string||string|int
当前支持的实体：字段、规则和表单。 您可以在子类中自由支持自己的实体。
| 自 |
3.8.0 |
|---|
参数
- 实体
string将添加路径的表单实体名称。- 新
string|array<string|int, string>要添加的命名空间或命名空间数组。
响应
array<string|int, string>已添加的命名空间列表。
addRulePath
将路径添加到规则包含路径列表的方法。
addRulePath(string|string[] new = null) : string||string|int
| 自 |
1.7.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的路径或路径数组。
响应
array<string|int, string>已添加的路径列表。
addRulePrefix
将命名空间添加到规则查找列表的方法。
addRulePrefix(string|string[] new = null) : string||string|int
| 自 |
3.8.0 |
|---|
参数
- 新
string|array<string|int, string>要添加的命名空间或命名空间数组。
响应
array<string|int, string>已添加的命名空间列表。
loadClass
加载特定类型表单实体之一的类。
loadClass( entity, type) : string|bool
目前，对“字段”和“规则”实体使用此方法是有意义的（但您可以在子类中支持更多实体）。
| 自 |
1.7.0 |
|---|
参数
- 实体
string表单实体之一（字段或规则）。- 类型
string实体的类型。
响应
string|bool成功时的类名，否则为 false。
loadFieldClass
尝试导入 FormField 类文件（如果尚未导入）。
loadFieldClass( type) : string|bool
您可以在 Form 之外使用此方法来加载用于继承或组合的字段。
| 自 |
1.7.0 |
|---|
参数
- 类型
string应加载其类的字段类型。
响应
string|bool成功时的类名，否则为 false。
loadFieldType
加载给定类型表单字段对象的方法。
loadFieldType( type, new = true) : \Joomla\CMS\Form\FormField|bool
loadFilterClass
尝试导入 FormFilter 类文件（如果尚未导入）。
loadFilterClass( type) : string|bool
您可以在 Form 之外使用此方法来加载用于继承或组合的过滤器。
| 自 |
4.0.0 |
|---|
参数
- 类型
string应加载其类的过滤器类型。
响应
string|bool成功时的类名，否则为 false。
loadFilterType
加载给定类型表单过滤器对象的方法。
loadFilterType( type, new = true) : \Joomla\CMS\Form\FormFilterInterface|bool
| 自 |
4.0.0 |
|---|
参数
- 类型
string规则类型。- 新
bool标志用于切换是否应该获取对象的新实例。
响应
FormFilterInterface|bool成功时的 FormRule 对象，否则为 false。
loadRuleClass
尝试导入 FormRule 类文件（如果尚未导入）。
loadRuleClass( type) : string|bool
您可以在 Form 之外使用此方法来加载用于继承或组合的规则。
| 自 |
1.7.0 |
|---|
参数
- 类型
string应加载其类的规则类型。
响应
string|bool成功时的类名，否则为 false。
loadRuleType
加载给定类型表单规则对象的方法。
loadRuleType( type, new = true) : \Joomla\CMS\Form\FormRule|bool
loadType
加载给定类型表单实体对象的方法。
loadType( entity, type, new = true) :
每种类型仅加载一次，然后用作相同类型其他对象的原型。 请仅对支持类型的那些实体使用此方法（表单不支持它们）。
| 自 |
1.7.0 |
|---|
参数
- 实体
string实体。- 类型
string实体类型。- 新
bool标志用于切换是否应该获取对象的新实例。
响应
mixed成功时的实体对象，否则为 false。
parseShowOnConditions
解析显示条件
parseShowOnConditions( showOn, formControl = null, group = null) : array||string|int
| 自 |
3.7.0 |
|---|
参数
- showOn
string显示条件。- formControl
string表单名称。- group
string以点分隔的表单组路径。
响应
array<string|int, array<string|int, mixed>>包含显示条件的数组。
属性
paths
包含可以找到实体（字段、规则、表单）的路径的数组。
数组结构
paths: {ENTITY_NAME}
- /path/1
- /path/2
| 自 |
1.7.0 |
|---|
类型
array<string|int, array<string|int, mixed>>
prefixes
类命名空间。
| 自 |
3.8.0 |
|---|
类型
array<string|int, array<string|int, mixed>>
entities
用于重用的 Form 实体对象的静态数组。
所有字段和规则的原型都在这里。
数组结构：entities: {ENTITY_NAME}: {KEY}: {OBJECT}
| 自 |
1.7.0 |
|---|
类型
array<string|int, array<string|int, mixed>>