Joomla! API

下载
启动

TagField

继承自 ListField

标签列表字段。

自

3.1
包

Joomla CMS

方法

__construct

构造函数

__construct() :
自

3.1

响应

混合

__get

用于从表单字段对象中获取某些其他无法访问的属性的方法。

__get( name) :
继承
自

3.7.0

参数

名称

string要获取其值的属性名称。

响应

mixed属性值或 null。

__set

用于设置表单字段对象中某些其他无法访问的属性的方法。

__set( name,  value) :
继承
自

3.2

参数

名称

string要设置其值的属性名称。

值

mixed属性的值。

响应

void

addOption

用于向列表字段添加选项的方法。

addOption( text, string||string|int attributes = []) : \Joomla\CMS\Form\Field\ListField
继承
自

3.7.0

参数

文本

string选项的文本/语言变量。

属性

array<string|int, string>属性的数组（'名称' => '值'）格式

响应

ListField用于链接。

allowCustom

确定字段是否允许或拒绝自定义值

allowCustom() :

响应

bool

collectLayoutData

用于获取要传递到布局以进行渲染的数据的方法。

collectLayoutData() : mixed||string|int
继承

数据缓存在内存中。

自

5.1.0

响应

array<string|int, mixed>

filter

用于过滤字段值的方法。

filter( value,  group = null, \Joomla\Registry\Registry input = null) :
继承
自

4.0.0
抛出

UnexpectedValueException

参数

值

mixed要作为字段默认值使用的可选值。

组

string用于查找字段的可选点分隔表单组路径。

输入

Registry|null包含要过滤整个表单的整个数据集的可选 Registry 对象。

响应

mixed过滤后的值。

getAttribute

用于获取字段属性的方法

getAttribute( name,  default = null) :
继承
自

3.2

参数

名称

string要获取的属性的名称

默认

mixed如果未找到属性，则要返回的可选值

响应

mixed属性的值 / 默认值

getCurrentUser

返回当前用户，如果没有设置，则返回全局应用程序的身份。这将在 6.0 中更改，并将返回空用户。

getCurrentUser() : \Joomla\CMS\User\User
继承
自

4.2.0

响应

用户

getDataAttributes

用于获取数据属性的方法。例如，data-user-type

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

4.0.0

响应

array<string|int, mixed>数据属性列表

getFieldName

用于获取所用字段名称的方法。

getFieldName( fieldName) :
继承
自

1.7.0

参数

fieldName

string字段元素名称。

响应

string字段名称

getId

用于获取用于字段输入标签的 id 的方法。

getId( fieldId,  fieldName) :
继承
自

1.7.0

参数

fieldId

string字段元素 id。

fieldName

string字段元素名称。

响应

string要用于字段输入标签的 id。

getInput

用于获取标签字段的字段输入的方法。

getInput() :
自

3.1

响应

string字段输入。

getLabel

用于获取字段标签标记的方法。

getLabel() :
继承
自

1.7.0

响应

string字段标签标记。

getLayoutData

用于获取要传递到布局以进行渲染的数据的方法。

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

3.5

响应

array<string|int, mixed>

getLayoutPaths

允许在子字段中覆盖渲染器包含路径

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

3.5

响应

array<string|int, mixed>

getName

用于获取用于字段输入标签的名称的方法。

getName( fieldName) :
继承
自

1.7.0

参数

fieldName

string字段元素名称。

响应

string要用于字段输入标签的名称。

getOptions

用于获取标签列表的方法

getOptions() : object||string|int
自

3.1

响应

array<string|int, object>字段选项对象。

getRenderer

获取渲染器

getRenderer( layoutId = 'default') : \Joomla\CMS\Layout\FileLayout
继承
自

3.5

参数

layoutId

string要加载的 Id

响应

FileLayout

getTitle

用于获取字段标题的方法。

getTitle() :
继承
自

1.7.0

响应

string字段标题。

isDebugEnabled

是否为该字段启用了调试

isDebugEnabled() :
继承
自

3.5

响应

bool

isNested

确定字段是否需要进行标签嵌套

isNested() :
自

3.1

响应

bool

isRemoteSearch

检查是否需要启用 AJAX 搜索

isRemoteSearch() :
自

4.0.0

响应

bool

postProcess

用于对字段值进行后处理的方法。

postProcess( value,  group = null, \Joomla\Registry\Registry input = null) :
继承
自

4.0.0

参数

值

mixed要作为字段默认值使用的可选值。

组

string用于查找字段的可选点分隔表单组路径。

输入

Registry|null包含要过滤整个表单的整个数据集的可选 Registry 对象。

响应

mixed处理后的值。

prepareOptionsNested

根据级别在嵌套标签之前添加 "-"

prepareOptionsNested(object||string|int &options) : object||string|int
自

3.1

参数

选项

array<string|int, object>标签数组

响应

array<string|int, object>字段选项对象。

render

渲染该字段的布局

render( layoutId, mixed||string|int data = []) :
继承
自

3.5

参数

layoutId

string布局标识符

数据

array<string|int, mixed>布局的可选数据

响应

string

renderDataAttributes

用于将数据属性渲染为 html 的方法。

renderDataAttributes() :
继承
自

4.0.0

响应

string数据属性的 HTML 标签属性字符串

renderField

用于获取包含标签和输入的控制组的方法。

renderField(mixed||string|int options = []) :
继承
自

3.2

参数

选项

array<string|int, mixed>要传递到字段渲染中的选项

响应

string包含控制组 html 的字符串

setCurrentUser

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :
继承
自

4.2.0

参数

currentUser

User当前用户对象

响应

void

setForm

用于将 Form 对象附加到字段的方法。

setForm(\Joomla\CMS\Form\Form form) : \Joomla\CMS\Form\FormField
继承
自

1.7.0

参数

表格

Form要附加到表单字段的 Form 对象。

响应

FormField表单字段对象，以便该方法可以在链中使用。

setup

用于将 Form 对象附加到字段的方法。

setup(\SimpleXMLElement element,  value,  group = null) :
继承
见 FormField::setup()
自

5.1.0

参数

元素

SimpleXMLElement表示表单字段对象的 <field> 标签的 SimpleXMLElement 对象。

值

mixed要验证的表单字段值。

组

string字段名称组控制值。它充当字段的数组容器。例如，如果字段的名称为 "foo"，并且组值为 "bar"，则完整字段名称将最终变为 "bar[foo]"。

响应

bool成功时为 True。

setValue

用于设置值的简单方法

setValue( value) :
继承
自

3.2

参数

值

mixed要设置的值

响应

void

validate

用于根据字段数据验证 FormField 对象的方法。

validate( value,  group = null, \Joomla\Registry\Registry input = null) : bool|\Exception
继承
自

4.0.0
抛出

InvalidArgumentException

UnexpectedValueException

参数

值

mixed要作为字段默认值使用的可选值。

组

string用于查找字段的可选点分隔表单组路径。

输入

Registry|null包含要针对整个表单验证的整个数据集的可选 Registry 对象。

响应

bool|Exception如果字段值为有效值，则为布尔值 True，如果失败，则为 Exception。

属性

currentUser

当前用户对象。

继承
自

4.2.0

类型

用户

描述

表单字段的描述文本。通常用于工具提示。

继承
自

1.7.0

类型

string

提示

用于在字段内显示提示的表单字段的提示文本。

继承
自

3.2

类型

string

自动完成

表单字段的自动完成状态。如果为 'off'，则元素不会被浏览器自动完成。

继承
自

3.2

类型

混合

拼写检查

表单字段的拼写检查状态。

继承
自

3.2

类型

bool

自动对焦

表单字段的自动对焦请求。如果为 True，则元素将在文档加载时自动获得焦点。

继承
自

3.2

类型

bool

元素

描述表单字段的 <field> XML 元素的 SimpleXMLElement 对象。

继承
自

1.7.0

类型

SimpleXMLElement

表格

附加到表单字段的表单的 Form 对象。

继承
自

1.7.0

类型

表格

formControl

附加到表单字段的 Form 对象中字段名称的表单控件前缀。

继承
自

1.7.0

类型

string

隐藏

表单字段的隐藏状态。

继承
自

1.7.0

类型

bool

hiddenLabel

渲染表单字段时是否应隐藏标签？这在您在表单字段本身中渲染标签以用于字段集中的单选按钮等情况下可能很有用。

继承

如果您使用此标志，则应确保在您的表单中显示标签（以实现 a11y 等）。

自

4.0.0

类型

bool

hiddenDescription

渲染表单字段时是否应隐藏描述？这在您在表单字段本身中渲染描述以用于例如注释字段的情况下可能很有用。

继承
自

4.0.0

类型

bool

translateLabel

如果要翻译字段标签字符串，则为 True。

继承
自

1.7.0

类型

bool

translateDescription

如果要翻译字段描述字符串，则为 True。

继承
自

1.7.0

类型

bool

translateHint

如果要翻译字段提示字符串，则为 True。

继承
自

3.2

类型

bool

id

表单字段的文档 id。

继承
自

1.7.0

类型

string

输入

表单字段的输入。

继承
自

1.7.0

类型

string

标签

表单字段的标签。

继承
自

1.7.0

类型

string

多选

表单字段的多选状态。如果为 True，则字段允许使用多个值。最常用于列表字段类型。

继承
自

1.7.0

类型

bool

重复

允许扩展创建重复元素

继承
自

3.2

类型

混合

模式

表单字段值的模式（正则表达式）。

继承
自

1.7.0

类型

string

validationtext

表单字段无效值的验证文本。

继承
自

4.0.0

类型

string

名称

表单字段的名称。

继承
自

1.7.0

类型

string

fieldname

字段的名称。

继承
自

1.7.0

类型

string

组

字段的组。

继承
自

1.7.0

类型

string

必需

表单字段的必需状态。如果为 True，则字段必须存在值才能被视为有效值。

继承
自

1.7.0

类型

bool

禁用

表单字段的禁用状态。如果为 True，则字段将被禁用，并且用户无法与字段交互。

继承
自

3.2

类型

bool

只读

表单字段的只读状态。如果为 True，则字段将为只读状态。

继承
自

3.2

类型

bool

类型

一个灵活的标签列表，它尊重访问控制

自

3.1

类型

string

validate

表单字段的验证方法。此值将确定用于验证字段值的哪种方法。

继承
自

1.7.0

类型

string

值

表单字段的值。

继承
自

1.7.0

类型

混合

默认

表单字段的默认值。

继承
自

1.7.0

类型

混合

大小

表单字段的大小。

继承
自

3.2

类型

int

类

表单字段的类

继承
自

3.2

类型

混合

labelclass

表单字段的标签 CSS 类

继承
自

1.7.0

类型

混合

onchange

表单字段的 javascript onchange。

继承
自

3.2

类型

string

onclick

表单字段的 javascript onclick。

继承
自

3.2

类型

string

showon

显示/隐藏字段的条件。

继承
自

3.7.0

类型

string

父类

字段的父类

继承
自

4.0.0

类型

string

计数

为生成的名称字段设置的计数值

继承的 静态的
自

1.7.0

类型

int

generated_fieldname

用于生成字段名称的字符串

继承的 静态的
自

1.7.0

类型

string

布局

用于渲染字段的布局名称

自

4.0.0

类型

string

layoutData

布局渲染的缓存数据

继承
自

5.1.0

类型

array<string|int, mixed>

renderLayout

用于渲染表单字段的布局

继承

类型

string

renderLabelLayout

用于渲染标签的布局

继承

类型

string

dataAttributes

表单字段的 data-attribute 名称和值。

继承

例如，data-action-type="click" data-action-type="change"

自

4.0.0

类型

array<string|int, mixed>

标题

标题。

继承
自

5.1.0

类型

混合

isNested

用于处理嵌套标签字段的标志

自

3.1

类型

bool

comParams

com_tags 参数

自

3.1

类型

注册表
  • \ Joomla
  • \ CMS
  • \ 表单
  • \ 字段
  • \ 标签字段