Select
Utility class for creating HTML select lists
| since |
1.5 |
|---|---|
| package |
Joomla CMS |
Methods
booleanlist
Generates a yes/no radio list.
booleanlist( name, mixed||string|int attribs = [], selected = null, yes = 'JYES', no = 'JNO', id = false) :
| since |
1.5 |
|---|---|
| see | RadioField |
Arguments
- name
stringThe value of the HTML name attribute- attribs
array<string|int, mixed>Additional HTML attributes for the<select>tag- selected
stringThe key that is selected- yes
stringLanguage key for Yes- no
stringLanguage key for no- id
mixedThe id for the field or false for no id
Response
stringHTML for the radio list
genericlist
Generates an HTML selection list.
genericlist(mixed||string|int data, name, attribs = null, optKey = 'value', optText = 'text', selected = null, idtag = false, translate = false) :
| since |
1.5 |
|---|
Arguments
- data
array<string|int, mixed>An array of objects, arrays, or scalars.- name
stringThe value of the HTML name attribute.- attribs
mixedAdditional HTML attributes for the<select>tag. This can be an array of attributes, or an array of options. Treated as options if it is the last argument passed. Valid options are: Format options, see {@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}. Selection options, see {@see \Joomla\CMS\HTML\Helpers\JHtmlSelect::options()}. list.attr, string|array: Additional attributes for the select element. id, string: Value to use as the select element id attribute. Defaults to the same as the name. list.select, string|array: Identifies one or more option elements to be selected, based on the option key values.- optKey
stringThe name of the object variable for the option value. If set to null, the index of the value array is used.- optText
stringThe name of the object variable for the option text.- selected
mixedThe key that is selected (accepts an array or a string).- idtag
mixedValue of the field id or null by default- translate
boolTrue to translate
Response
stringHTML for the select list.
groupedlist
Generates a grouped HTML selection list from nested arrays.
groupedlist(mixed||string|int data, name, mixed||string|int options = []) :
| since |
1.5 |
|---|---|
| throws |
|
Arguments
- data
array<string|int, mixed>An array of groups, each of which is an array of options.- name
stringThe value of the HTML name attribute- options
array<string|int, mixed>Options, an array of key/value pairs. Valid options are: Format options, {@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}. Selection options. See {@see \Joomla\CMS\HTML\Helpers\JHtmlSelect::options()}. group.id: The property in each group to use as the group id attribute. Defaults to none. group.label: The property in each group to use as the group label. Defaults to "text". If set to null, the data array index key is used. group.items: The property in each group to use as the array of items in the group. Defaults to "items". If set to null, group.id and group. label are forced to null and the data element is assumed to be a list of selections. id: Value to use as the select element id attribute. Defaults to the same as the name. list.attr: Attributes for the select element. Can be a string or an array of key/value pairs. Defaults to none. list.select: either the value of one selected option or an array of selected options. Default: none. list.translate: Boolean. If set, text and labels are translated via Text::_().
Response
stringHTML for the select list
integerlist
Generates a selection list of integers.
integerlist( start, end, inc, name, attribs = null, selected = null, format = '') :
| since |
1.5 |
|---|
Arguments
- start
intThe start integer- end
intThe end integer- inc
intThe increment- name
stringThe value of the HTML name attribute- attribs
mixedAdditional HTML attributes for the<select>tag, an array of attributes, or an array of options. Treated as options if it is the last argument passed.- selected
mixedThe key that is selected- format
stringThe printf format to be applied to the number
Response
stringHTML for the select list
option
Create an object that represents an option in an option list.
option( value, text = '', optKey = 'value', optText = 'text', disable = false) : \stdClass
| since |
1.5 |
|---|
Arguments
- value
stringThe value of the option- text
stringThe text for the option- optKey
mixedIf a string, the returned object property name for the value. If an array, options. Valid options are: attr: String|array. Additional attributes for this option. Defaults to none. disable: Boolean. If set, this option is disabled. label: String. The value for the option label. option.attr: The property in each option array to use for additional selection attributes. Defaults to none. option.disable: The property that will hold the disabled state. Defaults to "disable". option.key: The property that will hold the selection value. Defaults to "value". option.label: The property in each option array to use as the selection label attribute. If a "label" option is provided, defaults to "label", if no label is given, defaults to null (none). option.text: The property that will hold the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars.- optText
stringThe property that will hold the displayed text. This parameter is ignored if an options array is passed.- disable
boolNot used.
Response
stdClass
options
Generates the option tags for an HTML select list (with no select tag surrounding the options).
options(mixed||string|int arr, optKey = 'value', optText = 'text', selected = null, translate = false) :
| since |
1.5 |
|---|
Arguments
- arr
array<string|int, mixed>An array of objects, arrays, or values.- optKey
mixedIf a string, this is the name of the object variable for the option value. If null, the index of the array of objects is used. If an array, this is a set of options, as key/value pairs. Valid options are: -Format options, {@see \Joomla\CMS\HTML\HTMLHelper::$formatOptions}. -groups: Boolean. If set, looks for keys with the value "<optgroup>" and synthesizes groups from them. Deprecated. Defaults true for backwards compatibility. -list.select: either the value of one selected option or an array of selected options. Default: none. -list.translate: Boolean. If set, text and labels are translated via Text::_(). Default is false. -option.id: The property in each option array to use as the selection id attribute. Defaults to none. -option.key: The property in each option array to use as the selection value. Defaults to "value". If set to null, the index of the option array is used. -option.label: The property in each option array to use as the selection label attribute. Defaults to null (none). -option.text: The property in each option array to use as the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars. -option.attr: The property in each option array to use for additional selection attributes. Defaults to none. -option.disable: The property that will hold the disabled state. Defaults to "disable". -option.key: The property that will hold the selection value. Defaults to "value". -option.text: The property that will hold the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars.- optText
stringThe name of the object variable for the option text.- selected
mixedThe key that is selected (accepts an array or a string)- translate
boolTranslate the option values.
Response
stringHTML for the select list
radiolist
Generates an HTML radio list.
radiolist(mixed||string|int data, name, attribs = null, optKey = 'value', optText = 'text', selected = null, idtag = false, translate = false) :
| since |
1.5 |
|---|
Arguments
- data
array<string|int, mixed>An array of objects- name
stringThe value of the HTML name attribute- attribs
stringAdditional HTML attributes for the<select>tag- optKey
mixedThe key that is selected- optText
stringThe name of the object variable for the option value- selected
stringThe name of the object variable for the option text- idtag
boolValue of the field id or null by default- translate
boolTrue if options will be translated
Response
stringHTML for the select list
Properties
optionDefaults
Default values for options. Organized by option group.
| since |
1.5 |
|---|
Type(s)
array<string|int, mixed>