Référence de la classe Select

Fonctions membres publiques statiques
static	booleanlist ($name, $attribs=array(), $selected=null, $yes='JYES', $no='JNO', $id=false)
static	genericlist ( $data, $name, $attribs=null, $optKey='value', $optText='text', $selected=null, $idtag=false, $translate=false)
static	groupedlist ($data, $name, $options=array())
static	integerlist ($start, $end, $inc, $name, $attribs=null, $selected=null, $format='')
static	option ($value, $text='', $optKey='value', $optText='text', $disable=false)
static	options ($arr, $optKey='value', $optText='text', $selected=null, $translate=false)
static	radiolist ( $data, $name, $attribs=null, $optKey='value', $optText='text', $selected=null, $idtag=false, $translate=false)

Attributs protégés statiques
static	$optionDefaults

Description détaillée

Utility class for creating HTML select lists

Depuis

1.5

Documentation des fonctions membres

booleanlist()

static booleanlist (   $name,   $attribs = array(),   $selected = null,   $yes = 'JYES',   $no = 'JNO',   $id = false  )

static

Generates a yes/no radio list.

Paramètres

string	$name	The value of the HTML name attribute
array	$attribs	Additional HTML attributes for the <select> tag
string	$selected	The key that is selected
string	$yes	Language key for Yes
string	$no	Language key for no
mixed	$id	The id for the field or false for no id

Renvoie

string HTML for the radio list

Depuis

1.5

Voir également

Références $attribs, $id, $name, $selected, Text\_(), et HTMLHelper\_().

genericlist()

static genericlist (   $data,   $name,   $attribs = null,   $optKey = 'value',   $optText = 'text',   $selected = null,   $idtag = false,   $translate = false  )

static

Generates an HTML selection list.

Paramètres

array	$data	An array of objects, arrays, or scalars.
string	$name	The value of the HTML name attribute.
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 {

Voir également

HTMLHelper::$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.

Paramètres

string	$optKey	The name of the object variable for the option value. If set to null, the index of the value array is used.
string	$optText	The name of the object variable for the option text.
mixed	$selected	The key that is selected (accepts an array or a string).
mixed	$idtag	Value of the field id or null by default
boolean	$translate	True to translate

Renvoie

string HTML for the select list.

Depuis

1.5

Références $attribs, $data, HTMLHelper\$formatOptions, $html, $id, $name, $options, $selected, Factory\getDocument(), et ArrayHelper\toString().

groupedlist()

static groupedlist (   $data,   $name,   $options = array()  )

static

Generates a grouped HTML selection list from nested arrays.

Paramètres

array	$data	An array of groups, each of which is an array of options.
string	$name	The value of the HTML name attribute
array	$options	Options, an array of key/value pairs. Valid options are: Format options, {

Voir également

HTMLHelper::$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 Text::_().

Renvoie

string HTML for the select list

Depuis

1.5

Exceptions

Références $attribs, $data, HTMLHelper\$formatOptions, $html, $id, $label, $name, $options, elseif, null, et ArrayHelper\toString().

integerlist()

static integerlist (   $start,   $end,   $inc,   $name,   $attribs = null,   $selected = null,   $format = ''  )

static

Generates a selection list of integers.

Paramètres

integer	$start	The start integer
integer	$end	The end integer
integer	$inc	The increment
string	$name	The value of the HTML name attribute
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.
mixed	$selected	The key that is selected
string	$format	The printf format to be applied to the number

Renvoie

string HTML for the select list

Depuis

1.5

Références $attribs, $data, $format, HTMLHelper\$formatOptions, $i, $name, $options, $selected, $start, HTMLHelper\_(), et null.

option()

static option (   $value,   $text = '',   $optKey = 'value',   $optText = 'text',   $disable = false  )

static

Create an object that represents an option in an option list.

Paramètres

string	$value	The value of the option
string	$text	The text for the option
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.
string	$optText	The property that will hold the the displayed text. This parameter is ignored if an options array is passed.
boolean	$disable	Not used.

Renvoie

Depuis

1.5

Références $options, et null.

options()

static options (   $arr,   $optKey = 'value',   $optText = 'text',   $selected = null,   $translate = false  )

static

Generates the option tags for an HTML select list (with no select tag surrounding the options).

Paramètres

array	$arr	An array of objects, arrays, or values.
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, {

Voir également

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.

Paramètres

string	$optText	The name of the object variable for the option text.
mixed	$selected	The key that is selected (accepts an array or a string)
boolean	$translate	Translate the option values.

Renvoie

string HTML for the select list

Depuis

1.5

Références $attr, HTMLHelper\$formatOptions, $html, $id, $key, $label, $options, $selected, $text, elseif, et null.

radiolist()

static radiolist (   $data,   $name,   $attribs = null,   $optKey = 'value',   $optText = 'text',   $selected = null,   $idtag = false,   $translate = false  )

static

Generates an HTML radio list.

Paramètres

array	$data	An array of objects
string	$name	The value of the HTML name attribute
string	$attribs	Additional HTML attributes for the <select> tag
mixed	$optKey	The key that is selected
string	$optText	The name of the object variable for the option value
string	$selected	The name of the object variable for the option text
boolean	$idtag	Value of the field id or null by default
boolean	$translate	True if options will be translated

Renvoie

string HTML for the select list

Depuis

1.5

Références $attribs, $data, $html, $id, $name, $selected, $val, Text\_(), null, et ArrayHelper\toString().

Documentation des champs

$optionDefaults

$optionDefaults

staticprotected

Valeur initiale :

= array(
        'option' => array(
            'option.attr' => null,
            'option.disable' => 'disable',
            'option.id' => null,
            'option.key' => 'value',
            'option.key.toHtml' => true,
            'option.label' => null,
            'option.label.toHtml' => true,
            'option.text' => 'text',
            'option.text.toHtml' => true,
            'option.class' => 'class',
            'option.onclick' => 'onclick',
        ),
    )

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Select.php