Joomla! API

下载
启动

CategoryField

继承自 ListField

Joomla 平台的表单字段类。

支持类别 HTML 选择列表

自

1.6
包

Joomla CMS

方法

__construct

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

__construct(\Joomla\CMS\Form\Form form = null) :
继承
自

1.7.0

参数

form

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

返回值

混合

__get

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

__get( name) :
继承
自

3.7.0

参数

name

string要获取值的属性名称。

返回值

mixed属性值或 null。

__set

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

__set( name,  value) :
继承
自

3.2

参数

name

string要设置值的属性名称。

value

mixed属性的值。

返回值

void

addOption

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

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

3.7.0

参数

text

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

attributes

array<string|int, string>属性数组（'name' => 'value'）格式

返回值

ListField用于链式调用。

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

参数

value

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

group

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

input

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

返回值

mixed已过滤的值。

getAttribute

获取字段属性的方法

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

3.2

参数

name

string要获取的属性名称

default

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

返回值

mixed属性值/默认值

getCurrentUser

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

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

4.2.0

返回值

User

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() :
继承

使用 multiple 属性启用多选。

自

3.7.0

返回值

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

获取类别字段选项的方法。使用表单中的 extension 属性指定应显示类别的特定扩展。

getOptions() : object||string|int

使用 show_root 属性指定是否在列表中显示全局类别根。

自

1.6

返回值

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

postProcess

后处理字段值的方法。

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

4.0.0

参数

value

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

group

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

input

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

返回值

mixed已处理的值。

render

渲染此字段的布局

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

3.5

参数

layoutId

string布局标识符

data

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

返回值

string

renderDataAttributes

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

renderDataAttributes() :
继承
自

4.0.0

返回值

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

renderField

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

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

3.2

参数

options

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

返回值

string包含控件组 html 的字符串

setCurrentUser

设置当前用户。

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

4.2.0

参数

currentUser

User当前用户对象

返回值

void

setForm

将表单对象附加到字段的方法。

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

1.7.0

参数

form

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

返回值

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

setup

将表单对象附加到字段的方法。

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

5.1.0

参数

element

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

value

mixed要验证的表单字段值。

group

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

返回值

bool成功时为真。

setValue

设置值的方法

setValue( value) :
继承
自

3.2

参数

value

mixed要设置的值

返回值

void

validate

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

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

4.0.0
抛出

InvalidArgumentException

UnexpectedValueException

参数

value

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

group

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

input

Registry|null一个可选的 Registry 对象，其中包含要根据整个表单验证的整个数据集。

返回值

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

属性

currentUser

当前用户对象。

继承
自

4.2.0

类型(s)

User

描述

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

继承
自

1.7.0

类型(s)

string

hint

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

继承
自

3.2

类型(s)

string

autocomplete

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

继承
自

3.2

类型(s)

混合

spellcheck

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

继承
自

3.2

类型(s)

bool

autofocus

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

继承
自

3.2

类型(s)

bool

element

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

继承
自

1.7.0

类型(s)

SimpleXMLElement

form

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

继承
自

1.7.0

类型(s)

Form

formControl

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

继承
自

1.7.0

类型(s)

string

hidden

表单字段的隐藏状态。

继承
自

1.7.0

类型(s)

bool

hiddenLabel

渲染表单字段时是否应隐藏标签？如果您在表单字段本身的图例中渲染标签（例如字段集中单选按钮），这可能很有用。

继承

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

自

4.0.0

类型(s)

bool

hiddenDescription

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

继承
自

4.0.0

类型(s)

bool

translateLabel

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

继承
自

1.7.0

类型(s)

bool

translateDescription

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

继承
自

1.7.0

类型(s)

bool

translateHint

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

继承
自

3.2

类型(s)

bool

id

表单字段的文档 id。

继承
自

1.7.0

类型(s)

string

input

表单字段的输入。

继承
自

1.7.0

类型(s)

string

label

表单字段的标签。

继承
自

1.7.0

类型(s)

string

multiple

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

继承
自

1.7.0

类型(s)

bool

repeat

允许扩展创建重复元素

继承
自

3.2

类型(s)

混合

pattern

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

继承
自

1.7.0

类型(s)

string

validationtext

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

继承
自

4.0.0

类型(s)

string

name

表单字段的名称。

继承
自

1.7.0

类型(s)

string

fieldname

字段的名称。

继承
自

1.7.0

类型(s)

string

group

字段的组。

继承
自

1.7.0

类型(s)

string

required

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

继承
自

1.7.0

类型(s)

bool

disabled

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

继承
自

3.2

类型(s)

bool

readonly

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

继承
自

3.2

类型(s)

bool

type

表单字段类型。

自

1.6

类型(s)

string

validate

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

继承
自

1.7.0

类型(s)

string

value

表单字段的值。

继承
自

1.7.0

类型(s)

混合

default

表单字段的默认值。

继承
自

1.7.0

类型(s)

混合

size

表单字段的大小。

继承
自

3.2

类型(s)

int

class

表单字段的类

继承
自

3.2

类型(s)

混合

labelclass

表单字段的标签的 CSS 类

继承
自

1.7.0

类型(s)

混合

onchange

表单字段的 javascript onchange。

继承
自

3.2

类型(s)

string

onclick

表单字段的 javascript onclick。

继承
自

3.2

类型(s)

string

showon

显示/隐藏字段的条件。

继承
自

3.7.0

类型(s)

string

parentclass

字段的父类

继承
自

4.0.0

类型(s)

string

count

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

继承 静态
自

1.7.0

类型(s)

int

generated_fieldname

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

继承 静态
自

1.7.0

类型(s)

string

layout

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

继承
自

4.0.0

类型(s)

string

layoutData

布局渲染的缓存数据

继承
自

5.1.0

类型(s)

array<string|int, mixed>

渲染布局

用于渲染表单字段的布局

继承

类型(s)

string

渲染标签布局

用于渲染标签的布局

继承

类型(s)

string

数据属性

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

继承

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

自

4.0.0

类型(s)

array<string|int, mixed>

标题

标题。

继承
自

5.1.0

类型(s)

混合
  • \ Joomla
  • \ 内容管理系统
  • \ 表单
  • \ 字段
  • \ 类别字段