Joomla! CMS 5.1.x API » \Joomla\CMS\Form\Field\CheckboxField

链接
参见	CheckboxField
自	1.7.0
包	Joomla CMS

用于实例化表单字段对象的方法。

__construct(\Joomla\CMS\Form\Form form = null) :

继承

自	1.7.0

参数

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

响应

混合

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

__get( name) :

自	3.2

参数

名称: 字符串要获取其值的属性名称。

响应

混合属性值或 null。

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

__set( name,  value) :

自	3.2

参数

名称: 字符串要设置其值的属性名称。
值: 混合属性的值。

响应

空

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

collectLayoutData() : mixed||string|int

继承

数据缓存在内存中。

自	5.1.0

响应

array<string|int, mixed>

用于过滤字段值的方法。

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

继承

自	4.0.0
抛出	`UnexpectedValueException`

参数

值: 混合用作字段默认值的可选值。
组: 字符串要查找字段的可选点分隔表单组路径。
输入: Registry|null一个可选的 Registry 对象，其中包含要针对整个表单进行过滤的整个数据集。

响应

混合过滤后的值。

用于获取字段属性的方法

getAttribute( name,  default = null) :

继承

自	3.2

参数

名称: 字符串要获取的属性名称
默认: 混合如果未找到属性，则返回可选值

响应

混合属性的值/默认值

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

getCurrentUser() : \Joomla\CMS\User\User

继承

自	4.2.0

响应

用户

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

getDataAttributes() : mixed||string|int

继承

自	4.0.0

响应

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

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

getFieldName( fieldName) :

继承

自	1.7.0

参数

字段名称: 字符串字段元素名称。

响应

字符串字段名称

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

getId( fieldId,  fieldName) :

继承

自	1.7.0

参数

字段 ID: 字符串字段元素 ID。
字段名称: 字符串字段元素名称。

响应

字符串要用于字段输入标签的 ID。

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

getInput() :

继承

自	1.7.0

响应

字符串字段输入标记。

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

getLabel() :

继承

自	1.7.0

响应

字符串字段标签标记。

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

getLayoutData() : mixed||string|int

自	4.0.0

响应

array<string|int, mixed>

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

getLayoutPaths() : mixed||string|int

继承

自	3.5

响应

array<string|int, mixed>

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

getName( fieldName) :

继承

自	1.7.0

参数

字段名称: 字符串字段元素名称。

响应

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

获取渲染器

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

继承

自	3.5

参数

布局 ID: 字符串要加载的 ID

响应

FileLayout

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

getTitle() :

继承

自	1.7.0

响应

字符串字段标题。

是否为该字段启用了调试

isDebugEnabled() :

继承

自	3.5

响应

布尔值

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

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

继承

自	4.0.0

参数

值: 混合用作字段默认值的可选值。
组: 字符串要查找字段的可选点分隔表单组路径。
输入: Registry|null一个可选的 Registry 对象，其中包含要针对整个表单进行过滤的整个数据集。

响应

混合已处理的值。

渲染该字段的布局

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

继承

自	3.5

参数

布局 ID: 字符串布局标识符
数据: array<string|int, mixed>布局的可选数据

响应

字符串

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

renderDataAttributes() :

继承

自	4.0.0

响应

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

用于获取带有标签和输入的控件组的方法。

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

继承

自	3.2

参数

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

响应

字符串包含控件组 html 的字符串

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :

继承

自	4.2.0

参数

currentUser: User当前用户对象

响应

空

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

setForm(\Joomla\CMS\Form\Form form) : \Joomla\CMS\Form\FormField

继承

自	1.7.0

参数

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

响应

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

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

setup(\SimpleXMLElement element,  value,  group = null) :

参见	FormField::setup()
自	3.2

参数

元素: SimpleXMLElement表示表单字段对象的 <field> 标记的 SimpleXMLElement 对象。
值: 混合要验证的表单字段值。
组: 字符串字段名称组控件值。它充当字段的数组容器。例如，如果字段的名称为“foo”并且组值为“bar”，则完整的字段名称最终将为“bar[foo]”。

响应

布尔值成功时为 true。

用于设置值简单方法

setValue( value) :

继承

自	3.2

参数

值: 混合要设置的值

响应

空

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

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

继承

自

4.0.0

抛出

InvalidArgumentException

UnexpectedValueException

参数

值: 混合用作字段默认值的可选值。
组: 字符串要查找字段的可选点分隔表单组路径。
输入: Registry|null一个可选的 Registry 对象，其中包含要针对整个表单进行验证的整个数据集。

响应

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

当前用户对象。

继承

自	4.2.0

类型(s)

用户

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

继承

自	1.7.0

类型(s)

字符串

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

继承

自	3.2

类型(s)

字符串

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

继承

自	3.2

类型(s)

混合

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

继承

自	3.2

类型(s)

布尔值

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

继承

自	3.2

类型(s)

布尔值

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

继承

自	1.7.0

类型(s)

SimpleXMLElement

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

继承

自	1.7.0

类型(s)

表单

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

继承

自	1.7.0

类型(s)

字符串

表单字段的隐藏状态。

继承

自	1.7.0

类型(s)

布尔值

渲染表单字段时是否应隐藏标签？如果表单字段本身的字段集中有单选按钮的图例中呈现了标签，则这可能很有用等。

继承

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

自	4.0.0

类型(s)

布尔值

渲染表单字段时是否应隐藏描述？这可能很有用，例如，如果在表单字段本身中呈现了说明，例如注释字段。

继承

自	4.0.0

类型(s)

布尔值

是否翻译字段标签字符串。

继承

自	1.7.0

类型(s)

布尔值

是否翻译字段描述字符串。

继承

自	1.7.0

类型(s)

布尔值

是否翻译字段提示字符串。

继承

自	3.2

类型(s)

布尔值

表单字段的文档 ID。

继承

自	1.7.0

类型(s)

字符串

表单字段的输入。

继承

自	1.7.0

类型(s)

字符串

表单字段的标签。

继承

自	1.7.0

类型(s)

字符串

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

继承

自	1.7.0

类型(s)

布尔值

允许扩展创建重复元素

继承

自	3.2

类型(s)

混合

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

继承

自	1.7.0

类型(s)

字符串

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

继承

自	4.0.0

类型(s)

字符串

表单字段的名称。

继承

自	1.7.0

类型(s)

字符串

字段的名称。

继承

自	1.7.0

类型(s)

字符串

字段的组。

继承

自	1.7.0

类型(s)

字符串

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

继承

自	1.7.0

类型(s)

布尔值

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

继承

自	3.2

类型(s)

布尔值

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

继承

自	3.2

类型(s)

布尔值

表单字段类型。

自	1.7.0

类型(s)

字符串

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

继承

自	1.7.0

类型(s)

字符串

表单字段的值。

继承

自	1.7.0

类型(s)

混合

表单字段的默认值。

继承

自	1.7.0

类型(s)

混合

表单字段的大小。

继承

自	3.2

类型(s)

整数

表单字段的类

继承

自	3.2

类型(s)

混合

表单字段的标签的 CSS 类

继承

自	1.7.0

类型(s)

混合

表单字段的 javascript onchange。

继承

自	3.2

类型(s)

字符串

表单字段的 javascript onclick。

继承

自	3.2

类型(s)

字符串

显示/隐藏字段的条件。

继承

自	3.7.0

类型(s)

字符串

字段的父类

继承

自	4.0.0

类型(s)

字符串

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

继承静态

自	1.7.0

类型(s)

整数

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

继承静态

自	1.7.0

类型(s)

字符串

用于渲染字段的布局的名称

自	4.0.0

类型(s)

字符串

布局渲染的缓存数据

继承

自	5.1.0

类型(s)

array<string|int, mixed>

渲染表单字段的布局

继承

类型(s)

字符串

渲染标签的布局

继承

类型(s)

字符串

表单字段的数据属性名称和值。

继承

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

自	4.0.0

类型(s)

array<string|int, mixed>

复选框字段的选中状态。

自	3.2

类型(s)

布尔值