Class FOFFormFieldList

Description

Implements interfaces:

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

  • since: 2.0

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

JFormField
   |
   --JFormFieldList
      |
      --FOFFormFieldList
Direct descendents
Class Description
 class FOFFormFieldModel Form Field class for FOF Generic list from a model's results
Variable Summary
Method Summary
 static mixed getOptionName (array $data, [mixed $selected = null], [string $optKey = 'value'], [string $optText = 'text'])
 array getOptions ()
 string getRepeatable ()
 string getStatic ()
 mixed __get (string $name)
Variables
Methods
static getOptionName (line 176)

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 $optKey = 'value'], [string $optText = 'text'])
  • array $data: The JHtml options to parse
  • mixed $selected: The currently selected value
  • string $optKey: Key name
  • string $optText: Value name
getOptions (line 226)

Method to get the field options.

Ordering is disabled by default. You can enable ordering by setting the 'order' element in your form field. The other order values are optional.

  • order What to order. Possible values: 'name' or 'value' (default = false)
  • order_dir Order direction. Possible values: 'asc' = Ascending or 'desc' = Descending (default = 'asc')
  • order_case_sensitive Order case sensitive. Possible values: 'true' or 'false' (default = false)

  • return: The field option objects.
  • since: Ordering is available since FOF 2.1.b2.
  • access: protected
array getOptions ()

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

Redefined in descendants as:
getRepeatable (line 96)

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)

Redefined in descendants as:
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).

Redefined in descendants as:
__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.

Redefined in descendants as:

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