选择
用于创建 HTML 选择列表的实用程序类
自 |
1.5 |
---|---|
包 |
Joomla CMS |
方法
布尔列表
生成是/否单选按钮列表。
booleanlist( name, mixed||string|int attribs = [], selected = null, yes = 'JYES', no = 'JNO', id = false) :
自 |
1.5 |
---|---|
参见 | RadioField |
参数
- 名称
string
HTML name 属性的值- 属性
array<string|int, mixed>
<select>
标签的其他 HTML 属性- 选中
string
选中的键- 是
string
“是”的语言键- 否
string
“否”的语言键- ID
mixed
字段的 ID 或 false 表示没有 ID
响应
string
单选按钮列表的 HTML
通用列表
生成 HTML 选择列表。
genericlist(mixed||string|int data, name, attribs = null, optKey = 'value', optText = 'text', selected = null, idtag = false, translate = false) :
自 |
1.5 |
---|
参数
- 数据
array<string|int, mixed>
对象、数组或标量的数组。- 名称
string
HTML name 属性的值。- 属性
mixed
<select>
标签的其他 HTML 属性。这可以是属性数组,也可以是选项数组。如果它是传递的最后一个参数,则视为选项。有效选项:格式选项,请参见 {@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}。选择选项,请参见 {@see \Joomla\CMS\HTML\Helpers\JHtmlSelect::options()}。list.attr,string|array:选择元素的其他属性。id,string:用作选择元素 id 属性的值。默认为与名称相同。list.select,string|array:根据选项键值标识一个或多个要选择的选项元素。- optKey
string
选项值的 object 变量的名称。如果设置为 null,则使用值数组的索引。- optText
string
选项文本的 object 变量的名称。- 选中
mixed
选中的键(接受数组或字符串)。- idtag
mixed
字段 ID 的值或默认情况下为 null- 翻译
bool
是否翻译
响应
string
选择列表的 HTML。
分组列表
从嵌套数组生成分组 HTML 选择列表。
groupedlist(mixed||string|int data, name, mixed||string|int options = []) :
自 |
1.5 |
---|---|
抛出 |
|
参数
- 数据
array<string|int, mixed>
组的数组,每个组都是选项的数组。- 名称
string
HTML name 属性的值- 选项
array<string|int, mixed>
选项,键/值对的数组。有效选项:格式选项,{@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}。选择选项。请参见 {@see \Joomla\CMS\HTML\Helpers\JHtmlSelect::options()}。group.id:每个组中用作组 id 属性的属性。默认为无。group.label:每个组中用作组标签的属性。默认为“text”。如果设置为 null,则使用数据数组索引键。group.items:每个组中用作组中项目数组的属性。默认为“items”。如果设置为 null,则 group.id 和 group.label 被强制为 null,并且数据元素被假定为选择列表。id:用作选择元素 id 属性的值。默认为与名称相同。list.attr:选择元素的属性。可以是字符串或键/值对的数组。默认为无。list.select:一个选定选项的值或选定选项的数组。默认值:无。list.translate:布尔值。如果设置,则通过 Text::_() 翻译文本和标签。
响应
string
选择列表的 HTML
整数列表
生成整数的选择列表。
integerlist( start, end, inc, name, attribs = null, selected = null, format = '') :
自 |
1.5 |
---|
参数
- 开始
int
起始整数- 结束
int
结束整数- 增量
int
增量- 名称
string
HTML name 属性的值- 属性
mixed
<select>
标签的其他 HTML 属性,属性数组或选项数组。如果它是传递的最后一个参数,则视为选项。- 选中
mixed
选中的键- 格式
string
要应用于数字的 printf 格式
响应
string
选择列表的 HTML
选项
创建一个表示选项列表中选项的对象。
option( value, text = '', optKey = 'value', optText = 'text', disable = false) : \stdClass
自 |
1.5 |
---|
参数
- 值
string
选项的值- 文本
string
选项的文本- optKey
mixed
如果为字符串,则为返回的对象属性的名称。如果为数组,则为选项。有效选项为:attr:String|array。此选项的其他属性。默认为无。disable:Boolean。如果设置,则此选项被禁用。label:String。选项标签的值。option.attr:每个选项数组中用作其他选择属性的属性。默认为无。option.disable:将保存禁用状态的属性。默认为“disable”。option.key:将保存选择值的属性。默认为“value”。option.label:每个选项数组中用作选择标签属性的属性。如果提供了“label”选项,则默认为“label”,如果未给出标签,则默认为 null(无)。option.text:将保存显示文本的属性。默认为“text”。如果设置为 null,则选项数组被假定为可显示标量的列表。- optText
string
将保存显示文本的属性。如果传递了选项数组,则忽略此参数。- 禁用
bool
未使用。
响应
stdClass
选项
生成 HTML 选择列表的选项标签(选项周围没有选择标签)。
options(mixed||string|int arr, optKey = 'value', optText = 'text', selected = null, translate = false) :
自 |
1.5 |
---|
参数
- arr
array<string|int, mixed>
对象、数组或值的数组。- optKey
mixed
如果为字符串,则为选项值的 object 变量的名称。如果为 null,则使用对象数组的索引。如果为数组,则为一组选项,作为键/值对。有效选项为:-格式选项,{@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}。-groups:Boolean。如果设置,则查找值为“<optgroup>”的键并从中合成组。已弃用。默认为 true 以确保向后兼容。-list.select:一个选定选项的值或选定选项的数组。默认值:无。-list.translate:Boolean。如果设置,则通过 Text::_() 翻译文本和标签。默认为 false。-option.id:每个选项数组中用作选择 id 属性的属性。默认为无。-option.key:每个选项数组中用作选择值的属性。默认为“value”。如果设置为 null,则使用选项数组的索引。-option.label:每个选项数组中用作选择标签属性的属性。默认为 null(无)。-option.text:每个选项数组中用作显示文本的属性。默认为“text”。如果设置为 null,则选项数组被假定为可显示标量的列表。-option.attr:每个选项数组中用作其他选择属性的属性。默认为无。-option.disable:将保存禁用状态的属性。默认为“disable”。-option.key:将保存选择值的属性。默认为“value”。-option.text:将保存显示文本的属性。默认为“text”。如果设置为 null,则选项数组被假定为可显示标量的列表。- optText
string
选项文本的 object 变量的名称。- 选中
mixed
选中的键(接受数组或字符串)- 翻译
bool
翻译选项值。
响应
string
选择列表的 HTML
单选按钮列表
生成 HTML 单选按钮列表。
radiolist(mixed||string|int data, name, attribs = null, optKey = 'value', optText = 'text', selected = null, idtag = false, translate = false) :
自 |
1.5 |
---|
参数
- 数据
array<string|int, mixed>
对象的数组- 名称
string
HTML name 属性的值- 属性
string
<select>
标签的其他 HTML 属性- optKey
mixed
选中的键- optText
string
选项值的 object 变量的名称- 选中
string
选项文本的 object 变量的名称- idtag
bool
字段 ID 的值或默认情况下为 null- 翻译
bool
如果选项将被翻译,则为 true
响应
string
选择列表的 HTML
属性
optionDefaults
选项的默认值。按选项组组织。
自 |
1.5 |
---|
类型
array<string|int, mixed>