Select
Utility class for creating HTML select lists
since |
1.5 |
---|---|
package |
Joomla CMS |
Methods
booleanlist
Generates a yes/no radio list.
booleanlist(string name, array attribs = array(), string selected = null, string yes = 'JYES', string no = 'JNO', mixed id = false) : string
since |
1.5 |
---|---|
see | RadioField |
Arguments
- name
string
The value of the HTML name attribute- attribs
array
Additional HTML attributes for the<select>
tag- selected
string
The key that is selected- yes
string
Language key for Yes- no
string
Language key for no- id
mixed
The id for the field or false for no id
Response
string
HTML for the radio list
genericlist
Generates an HTML selection list.
genericlist(array data, string name, mixed attribs = null, string optKey = 'value', string optText = 'text', mixed selected = null, mixed idtag = false, bool translate = false) : string
since |
1.5 |
---|
Arguments
- data
array
An array of objects, arrays, or scalars.- name
string
The value of the HTML name attribute.- attribs
mixed
Additional 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
string
The name of the object variable for the option value. If set to null, the index of the value array is used.- optText
string
The name of the object variable for the option text.- selected
mixed
The key that is selected (accepts an array or a string).- idtag
mixed
Value of the field id or null by default- translate
bool
True to translate
Response
string
HTML for the select list.
groupedlist
Generates a grouped HTML selection list from nested arrays.
groupedlist(array data, string name, array options = array()) : string
since |
1.5 |
---|---|
throws |
|
Arguments
- data
array
An array of groups, each of which is an array of options.- name
string
The value of the HTML name attribute- options
array
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
string
HTML for the select list
integerlist
Generates a selection list of integers.
integerlist(int start, int end, int inc, string name, mixed attribs = null, mixed selected = null, string format = '') : string
since |
1.5 |
---|
Arguments
- start
int
The start integer- end
int
The end integer- inc
int
The increment- name
string
The value of the HTML name attribute- attribs
mixed
Additional 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
mixed
The key that is selected- format
string
The printf format to be applied to the number
Response
string
HTML for the select list
option
Create an object that represents an option in an option list.
option(string value, string text = '', mixed optKey = 'value', string optText = 'text', bool disable = false) : \stdClass
since |
1.5 |
---|
Arguments
- value
string
The value of the option- text
string
The text for the option- optKey
mixed
If 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 the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars.- optText
string
The property that will hold the the displayed text. This parameter is ignored if an options array is passed.- disable
bool
Not used.
Response
\stdClass
options
Generates the option tags for an HTML select list (with no select tag surrounding the options).
options(array arr, mixed optKey = 'value', string optText = 'text', mixed selected = null, bool translate = false) : string
since |
1.5 |
---|
Arguments
- arr
array
An array of objects, arrays, or values.- optKey
mixed
If 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 the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars.- optText
string
The name of the object variable for the option text.- selected
mixed
The key that is selected (accepts an array or a string)- translate
bool
Translate the option values.
Response
string
HTML for the select list
radiolist
Generates an HTML radio list.
radiolist(array data, string name, string attribs = null, mixed optKey = 'value', string optText = 'text', string selected = null, bool idtag = false, bool translate = false) : string
since |
1.5 |
---|
Arguments
- data
array
An array of objects- name
string
The value of the HTML name attribute- attribs
string
Additional HTML attributes for the<select>
tag- optKey
mixed
The key that is selected- optText
string
The name of the object variable for the option value- selected
string
The name of the object variable for the option text- idtag
bool
Value of the field id or null by default- translate
bool
True if options will be translated
Response
string
HTML for the select list
Properties
optionDefaults
Default values for options. Organized by option group.