UserstateField

Extends \JFormFieldPredefinedList

Field to load a list of available users statuses

Supports a generic list of options.

since

3.2

Methods

__get

Method to get certain otherwise inaccessible properties from the form field object.

__get(string $name) : mixed
inherited
since

3.7.0

Arguments

$name

stringThe property name for which to get the value.

Response

mixedThe property value or null.

addOption

Method to add an option to the list field.

addOption(string $text, array $attributes = array()) : \JFormFieldList
inherited
since

3.7.0

Arguments

$text

stringText/Language variable of the option.

$attributes

arrayArray of attributes ('name' => 'value' format)

Response

\JFormFieldListFor chaining.

getInput

Method to get the field input markup for a generic list.

getInput() : string
inherited

Use the multiple attribute to enable multiselect.

since

3.7.0

Response

stringThe field input markup.

getOptions

Method to get the field options.

getOptions() : array
inherited
since

3.7.0

Response

arrayThe field option objects.

Properties

type

The form field type.

inherited
since

1.7.0

Type(s)

string

predefinedOptions

Available predefined options

inherited
since

3.2

Type(s)

array

options

Cached array of the category items.

inherited static
since

3.2

Type(s)

array

translate

Translate options labels ?

inherited
since

3.2

Type(s)

boolean