PHP Class FOF30\Form\Field\GroupedList

Inheritance: extends JFormFieldGroupedList, implements FOF30\Form\FieldInterface
Show file Open project: akeeba/fof Class Usage Examples

Public Properties

Property Type Description
$item FOF30\Model\DataModel The item being rendered in a repeatable form field
$rowid integer A monotonically increasing number, denoting the row number in a repeatable view

Protected Properties

Property Type Description
$form FOF30\Form\Form The Form object of the form attached to the form field.
$repeatable Repeatable field output
$static Static field output

Public Methods

Method Description
__get ( string $name ) : mixed Method to get certain otherwise inaccessible properties from the form field object.
getFieldContents ( array $fieldOptions = [] ) : string Method to get the field input markup.
getOptionName ( array $data, mixed $selected = null, string $groupKey = 'items', string $optKey = 'value', string $optText = 'text' ) : mixed Gets the active option's label given an array of JHtml options
getRepeatable ( ) : string 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 ( ) : string Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).

Method Details

__get() public method

Method to get certain otherwise inaccessible properties from the form field object.
Since: 2.0
public __get ( string $name ) : mixed
$name string The property name for which to the the value.
return mixed The property value or null.

getFieldContents() public method

Method to get the field input markup.
public getFieldContents ( array $fieldOptions = [] ) : string
$fieldOptions array Options to be passed into the field
return string The field HTML

getOptionName() public static method

Gets the active option's label given an array of JHtml options
public static getOptionName ( array $data, mixed $selected = null, string $groupKey = 'items', string $optKey = 'value', string $optText = 'text' ) : mixed
$data array The JHtml options to parse
$selected mixed The currently selected value
$groupKey string Group name
$optKey string Key name
$optText string Value name
return mixed The label of the currently selected option

getRepeatable() public method

Get the rendering of this field type for a repeatable (grid) display, e.g. in a view listing many item (typically a "browse" task)
Since: 2.0
public getRepeatable ( ) : string
return string The field HTML

getStatic() public method

Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).
Since: 2.0
public getStatic ( ) : string
return string The field HTML

Property Details

$form protected property

The Form object of the form attached to the form field.
protected Form,FOF30\Form $form
return FOF30\Form\Form

$item public property

The item being rendered in a repeatable form field
public DataModel,FOF30\Model $item
return FOF30\Model\DataModel

$repeatable protected property

Repeatable field output
protected $repeatable

$rowid public property

A monotonically increasing number, denoting the row number in a repeatable view
public int $rowid
return integer

$static protected property

Static field output
protected $static