public static
string
|
#
booleanlist( string $name, array $attribs = array(), string $selected = null, string $yes = 'JYES', string $no = 'JNO', mixed $id = false )
Generates a yes/no radio list.
Generates a yes/no radio list.
Parameters
- $name
string - $name The value of the HTML name attribute- $attribs
array - $attribs Additional HTML attributes for the <select> tag- $selected
string - $selected The key that is selected- $yes
string - $yes Language key for Yes- $no
string - $no Language key for no- $id
mixed - $id The id for the field or false for no id Returns
string - HTML for the radio list
Since
1.5
See
|
public static
string
|
#
genericlist( array $data, string $name, mixed $attribs = null, string $optKey = 'value', string $optText = 'text', mixed $selected = null, mixed $idtag = false, boolean $translate = false )
Generates an HTML selection list.
Generates an HTML selection list.
Parameters
- $data
array - $data An array of objects, arrays, or scalars.- $name
string - $name The value of the HTML name attribute.- $attribs
mixed - $attribs 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 JHtml::$formatOptions. Selection options, see 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 - $optKey The name of the object variable for the option value. If set to null,
the index of the value array is used.- $optText
string - $optText The name of the object variable for the option text.- $selected
mixed - $selected The key that is selected (accepts an array or a string).- $idtag
mixed - $idtag Value of the field id or null by default- $translate
boolean - $translate True to translate Returns
string - HTML for the select list.
Since
1.5
|
public static
string
|
#
suggestionlist( array $data, string $optKey = 'value', string $optText = 'text', mixed $idtag = null, boolean $translate = false )
Method to build a list with suggestions
Method to build a list with suggestions
Deprecated
4.0 Just create the <datalist> directly instead
Parameters
- $data
array - $data An array of objects, arrays, or values.- $optKey
string - $optKey The name of the object variable for the option value. If set to null,
the index of the value array is used.- $optText
string - $optText The name of the object variable for the option text.- $idtag
mixed - $idtag Value of the field id or null by default- $translate
boolean - $translate True to translate Returns
string - HTML for the select list
Since
3.2
|
public static
string
|
#
groupedlist( array $data, string $name, array $options = array() )
Generates a grouped HTML selection list from nested arrays.
Generates a grouped HTML selection list from nested arrays.
Parameters
- $data
array - $data An array of groups, each of which is an array of options.- $name
string - $name The value of the HTML name attribute- $options
array - $options Options, an array of key/value pairs. Valid options are: Format
options, JHtml::$formatOptions. Selection options. See 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 JText::_(). Returns
string - HTML for the select list
Throws
Since
1.5
|
public static
string
|
#
integerlist( integer $start, integer $end, integer $inc, string $name, mixed $attribs = null, mixed $selected = null, string $format = '' )
Generates a selection list of integers.
Generates a selection list of integers.
Parameters
- $start
integer - $start The start integer- $end
integer - $end The end integer- $inc
integer - $inc The increment- $name
string - $name The value of the HTML name attribute- $attribs
mixed - $attribs 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 - $selected The key that is selected- $format
string - $format The printf format to be applied to the number Returns
string - HTML for the select list
Since
1.5
|
public static
stdClass
|
#
optgroup( string $text, string $optKey = 'value', string $optText = 'text' )
Create a placeholder for an option group.
Create a placeholder for an option group.
Deprecated
4.0 Use JHtmlSelect::groupedList()
Parameters
- $text
string - $text The text for the option- $optKey
string - $optKey The returned object property name for the value- $optText
string - $optText The returned object property name for the text Returns
Since
1.5
See
JHtmlSelect::groupedList()
|
public static
stdClass
|
#
option( string $value, string $text = '', mixed $optKey = 'value', string $optText = 'text', boolean $disable = false )
Create an object that represents an option in an option list.
Create an object that represents an option in an option list.
Parameters
- $value
string - $value The value of the option- $text
string - $text The text for the option- $optKey
mixed - $optKey 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 - $optText The property that will hold the the displayed text. This parameter is
ignored if an options array is passed.- $disable
boolean - $disable Not used. Returns
Since
1.5
|
public static
string
|
#
options( array $arr, mixed $optKey = 'value', string $optText = 'text', mixed $selected = null, boolean $translate = false )
Generates the option tags for an HTML select list (with no select tag
surrounding the options).
Generates the option tags for an HTML select list (with no select tag
surrounding the options).
Parameters
- $arr
array - $arr An array of objects, arrays, or values.- $optKey
mixed - $optKey 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, JHtml::$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 JText::_(). 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 - $optText The name of the object variable for the option text.- $selected
mixed - $selected The key that is selected (accepts an array or a string)- $translate
boolean - $translate Translate the option values. Returns
string - HTML for the select list
Since
1.5
|
public static
string
|
#
radiolist( array $data, string $name, string $attribs = null, mixed $optKey = 'value', string $optText = 'text', string $selected = null, boolean $idtag = false, boolean $translate = false )
Generates an HTML radio list.
Generates an HTML radio list.
Parameters
- $data
array - $data An array of objects- $name
string - $name The value of the HTML name attribute- $attribs
string - $attribs Additional HTML attributes for the <select> tag- $optKey
mixed - $optKey The key that is selected- $optText
string - $optText The name of the object variable for the option value- $selected
string - $selected The name of the object variable for the option text- $idtag
boolean - $idtag Value of the field id or null by default- $translate
boolean - $translate True if options will be translated Returns
string - HTML for the select list
Since
1.5
|
