Class JFormFieldTag

Description

Form Field class for the Joomla Framework.

  • since: 3.1

Located in /libraries/cms/form/field/tag.php (line 21)

JFormField
   |
   --JFormFieldList
      |
      --JFormFieldTag
Direct descendents
Class Description
 class FOFFormFieldTag Form Field class for FOF Tag Fields
Variable Summary
Method Summary
 JFormFieldTag __construct ()
 boolean allowCustom ()
 string getInput ()
 array getOptions ()
 boolean isNested ()
 array prepareOptionsNested (array &$options)
Variables
Methods
Constructor __construct (line 52)

Constructor

  • since: 3.1
  • access: public
JFormFieldTag __construct ()

Redefinition of:
JFormField::__construct()
Method to instantiate the form field object.
allowCustom (line 241)

Determines if the field allows or denies custom values

  • access: public
boolean allowCustom ()
getInput (line 67)

Method to get the field input for a tag field.

  • return: The field input.
  • since: 3.1
  • access: protected
string getInput ()

Redefinition of:
JFormFieldList::getInput()
Method to get the field input markup for a generic list.
getOptions (line 113)

Method to get a list of tags

  • return: The field option objects.
  • since: 3.1
  • access: protected
array getOptions ()

Redefinition of:
JFormFieldList::getOptions()
Method to get the field options.

Redefined in descendants as:
isNested (line 221)

Determine if the field has to be tagnested

  • since: 3.1
  • access: public
boolean isNested ()
prepareOptionsNested (line 200)

Add "-" before nested tags, depending on level

  • return: The field option objects.
  • since: 3.1
  • access: protected
array prepareOptionsNested (array &$options)
  • array &$options: Array of tags

Inherited Methods

Inherited From JFormFieldList

 JFormFieldList::getInput()
 JFormFieldList::getOptions()

Inherited From JFormField

 JFormField::__construct()
 JFormField::getAttribute()
 JFormField::getControlGroup()
 JFormField::getFieldName()
 JFormField::getId()
 JFormField::getInput()
 JFormField::getLabel()
 JFormField::getName()
 JFormField::getTitle()
 JFormField::setForm()
 JFormField::setup()
 JFormField::setValue()
 JFormField::__get()
 JFormField::__set()

Documentation generated on Tue, 19 Nov 2013 15:15:07 +0100 by phpDocumentor 1.4.3