Class FOFFormFieldGroupedlist

Description

Implements interfaces:

Form Field class for FOF Supports a generic list of options.

  • since: 2.0

Located in /libraries/fof/form/field/groupedlist.php (line 23)

JFormField
   |
   --JFormFieldGroupedList
      |
      --FOFFormFieldGroupedlist
Variable Summary
Method Summary
 static mixed getOptionName (array $data, [mixed $selected = null], [string $groupKey = 'items'], [string $optKey = 'value'], [string $optText = 'text'])
 string getRepeatable ()
 string getStatic ()
 mixed __get (string $name)
Variables
Methods
static getOptionName (line 142)

Gets the active option's label given an array of JHtml options

  • return: The label of the currently selected option
  • access: public
static mixed getOptionName (array $data, [mixed $selected = null], [string $groupKey = 'items'], [string $optKey = 'value'], [string $optText = 'text'])
  • array $data: The JHtml options to parse
  • mixed $selected: The currently selected value
  • string $groupKey: Group name
  • string $optKey: Key name
  • string $optText: Value name
getRepeatable (line 109)

Get the rendering of this field type for a repeatable (grid) display, e.g. in a view listing many item (typically a "browse" task)

  • return: The field HTML
  • since: 2.0
  • access: public
string getRepeatable ()

Implementation of:
FOFFormField::getRepeatable()
Get the rendering of this field type for a repeatable (grid) display, e.g. in a view listing many item (typically a "browse" task)
getStatic (line 79)

Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).

  • return: The field HTML
  • since: 2.0
  • access: public
string getStatic ()

Implementation of:
FOFFormField::getStatic()
Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).
__get (line 44)

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

  • return: The property value or null.
  • since: 2.0
  • access: public
mixed __get (string $name)
  • string $name: The property name for which to the the value.

Redefinition of:
JFormField::__get()
Method to get certain otherwise inaccessible properties from the form field object.

Inherited Methods

Inherited From JFormFieldGroupedList

 JFormFieldGroupedList::getGroups()
 JFormFieldGroupedList::getInput()

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:04:07 +0100 by phpDocumentor 1.4.3