TagField

Extends \JFormFieldList

List of Tags field.

Supports a generic list of options.

since

3.1

Methods

__construct

Constructor

__construct() 
since

3.1

__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.

allowCustom

Determines if the field allows or denies custom values

allowCustom() : boolean

Response

boolean

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.

isNested

Determine if the field has to be tagnested

isNested() : boolean
since

3.1

Response

boolean

prepareOptionsNested

Add "-" before nested tags, depending on level

prepareOptionsNested( &$options) : array
since

3.1

Arguments

$options

Response

arrayThe field option objects.

Properties

type

The form field type.

inherited
since

1.7.0

Type(s)

string

isNested

Flag to work with nested tag field

since

3.1

Type(s)

boolean

comParams

com_tags parameters

since

3.1

Type(s)

\Joomla\Registry\Registry