Joomla! API

下载
启动

UserField

继承自 FormField

从模态列表中选择用户 ID 的字段。

自

1.6
包

Joomla CMS

方法

__construct

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

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

1.7.0

参数

form

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

响应

混合

__get

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

__get( name) :
继承
自

1.7.0

参数

name

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

响应

mixed属性值或 null。

__set

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

__set( name,  value) :
继承
自

3.2

参数

name

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

value

mixed属性的值。

响应

void

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>数据属性列表

getExcluded

用于获取要从用户列表中排除的用户的方法

getExcluded() : string||string|int
自

1.6

响应

array<string|int, string>要排除的用户数组，或 null 表示不排除他们

getFieldName

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

getFieldName( fieldName) :
继承
自

1.7.0

参数

fieldName

string字段元素名称。

响应

string字段名称

getGroups

用于获取过滤组的方法（null 表示不进行过滤）

getGroups() : string||string|int
自

1.6

响应

array<string|int, string>过滤组数组或 null。

getId

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

getId( fieldId,  fieldName) :
继承
自

1.7.0

参数

fieldId

string字段元素 id。

fieldName

string字段元素名称。

响应

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

getInput

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

getInput() :
自

1.6

响应

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要用于字段输入标记的名称。

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

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

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

1.7.0

参数

form

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

响应

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

setup

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

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

3.7.0
参见 FormField::setup()

参数

element

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

value

mixed要验证的表单字段值。

group

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

响应

bool成功时为 True。

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，如果失败则为 Exception。

属性

currentUser

当前用户对象。

继承
自

4.2.0

类型

User

description

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

继承
自

1.7.0

类型

string

hint

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

继承
自

3.2

类型

string

autocomplete

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

继承
自

3.2

类型

混合

spellcheck

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

继承
自

3.2

类型

bool

autofocus

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

继承
自

3.2

类型

bool

element

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

继承
自

1.7.0

类型

SimpleXMLElement

form

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

继承
自

1.7.0

类型

Form

formControl

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

继承
自

1.7.0

类型

string

hidden

表单字段的隐藏状态。

继承
自

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

input

表单字段的输入。

继承
自

1.7.0

类型

string

label

表单字段的标签。

继承
自

1.7.0

类型

string

multiple

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

继承
自

1.7.0

类型

bool

repeat

允许扩展创建重复元素

继承
自

3.2

类型

混合

pattern

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

继承
自

1.7.0

类型

string

validationtext

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

继承
自

4.0.0

类型

string

name

表单字段的名称。

继承
自

1.7.0

类型

string

fieldname

字段的名称。

继承
自

1.7.0

类型

string

group

字段的组。

继承
自

1.7.0

类型

string

required

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

继承
自

1.7.0

类型

bool

disabled

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

继承
自

3.2

类型

bool

readonly

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

继承
自

3.2

类型

bool

type

表单字段类型。

自

1.6

类型

string

validate

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

继承
自

1.7.0

类型

string

value

表单字段的值。

继承
自

1.7.0

类型

混合

default

表单字段的默认值。

继承
自

1.7.0

类型

混合

size

表单字段的大小。

继承
自

3.2

类型

int

class

表单字段的类

继承
自

3.2

类型

混合

labelclass

表单字段的标签的 CSS 类

继承
自

1.7.0

类型

混合

onchange

表单字段的 javascript onchange。

继承
自

3.2

类型

string

onclick

表单字段的 javascript onclick。

继承
自

3.2

类型

string

showon

显示/隐藏字段的条件。

继承
自

3.7.0

类型

string

parentclass

字段的父类

继承
自

4.0.0

类型

string

count

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

继承 静态
自

1.7.0

类型

int

generated_fieldname

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

继承 静态
自

1.7.0

类型

string

layout

要渲染的布局

自

3.5

类型

string

layoutData

用于布局渲染的缓存数据

继承
自

5.1.0

类型

array<string|int, mixed>

renderLayout

用于渲染表单字段的布局

继承

类型

string

renderLabelLayout

用于渲染标签的布局

继承

类型

string

dataAttributes

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

继承

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

自

4.0.0

类型

array<string|int, mixed>

组

过滤组

已弃用
自

3.5
已弃用

4.4 将在 6.0 中被移除，没有替代方案

类型

array<string|int, mixed>

排除

要从用户列表中排除的用户

已弃用
自

3.5
已弃用

4.4 将在 6.0 中被移除，没有替代方案

类型

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ 表单
  • \ 字段
  • \ 用户字段