Class FOFFormFieldList

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

JFormField

FOFFormFieldList implements FOFFormField

Direct known subclasses

FOFFormFieldModel, FOFFormFieldRelation

Package: FrameworkOnFramework\form
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.0
Located at fof/form/field/list.php

Methods summary

`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 2.0 Overrides `JFormFieldList::__get`
`public string`	# `getStatic( )` Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task). Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task). Returns `string` - The field HTML Since 2.0 Implementation of `FOFFormField::getStatic()`
`public string`	# `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) Get the rendering of this field type for a repeatable (grid) display, e.g. in a view listing many item (typically a "browse" task) Returns `string` - The field HTML Since 2.0 Implementation of `FOFFormField::getRepeatable()`
`public static mixed`	# `getOptionName( array $data, mixed $selected = null, string $optKey = 'value', string $optText = 'text' )` Gets the active option's label given an array of JHtml options Gets the active option's label given an array of JHtml options Parameters `$data` `array` - $data The JHtml options to parse `$selected` `mixed` - $selected The currently selected value `$optKey` `string` - $optKey Key name `$optText` `string` - $optText Value name Returns `mixed` - The label of the currently selected option
`protected array`	# `getOptions( )` Method to get the field options. 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) Returns `array` - The field option objects. Since Ordering is available since FOF 2.1.b2. Overrides `JFormFieldList::getOptions`
`protected string`	# `parseFieldTags( string $text )` Replace string with tags that reference fields Replace string with tags that reference fields Parameters `$text` `string` - $text Text to process Returns `string` - Text with tags replace

Methods inherited from JFormFieldList

addOption(), getInput()

Methods inherited from JFormField

__construct(), __set(), getAttribute(), getControlGroup(), getFieldName(), getId(), getLabel(), getLayoutData(), getLayoutPaths(), getName(), getRenderer(), getTitle(), isDebugEnabled(), render(), renderField(), setForm(), setValue(), setup()

Magic methods summary

Properties summary

`protected mixed`	`$static`	#
`protected mixed`	`$repeatable`	#
`public FOFTable`	`$item`	# The item being rendered in a repeatable form field The item being rendered in a repeatable form field
`public integer`	`$rowid`	# A monotonically increasing number, denoting the row number in a repeatable view A monotonically increasing number, denoting the row number in a repeatable view

Properties inherited from JFormFieldList

$type

Properties inherited from JFormField

$autocomplete, $autofocus, $class, $count, $default, $description, $disabled, $element, $fieldname, $form, $formControl, $generated_fieldname, $group, $hidden, $hint, $id, $input, $label, $labelclass, $layout, $multiple, $name, $onchange, $onclick, $pattern, $readonly, $renderLabelLayout, $renderLayout, $repeat, $required, $showon, $size, $spellcheck, $translateDescription, $translateHint, $translateLabel, $validate, $value

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFFormFieldList

Direct known subclasses

Methods summary

Parameters

Returns

Since

Overrides

Returns

Since

Implementation of

Returns

Since

Implementation of

Parameters

Returns

Returns

Since

Overrides

Parameters

Returns

Methods inherited from JFormFieldList

Methods inherited from JFormField

Magic methods summary

Properties summary

Properties inherited from JFormFieldList

Properties inherited from JFormField