PHP Class FOF30\Form\Field\Components

Inheritance: extends JFormFieldList, implements FOF30\Form\FieldInterface
Show file Open project: akeeba/fof

Public Properties

Property Type Description
$client_ids string Override for the list of client IDs. Comma separated list, e.g. "0,1"
$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.
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).
translate ( stdClass $item, string $type ) : string Translate a list of objects with JText::_().

Protected Methods

Method Description
getOptions ( ) : array Get a list of all installed components and also translates them.

Method Details

__get() public method

Method to get certain otherwise inaccessible properties from the form field object.
Since: 2.1
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

getOptions() protected method

The manifest_cache is used to get the extension names, since JInstaller is also translating those names in stead of the name column. Else some of the translations fails.
Since: 2.1
protected getOptions ( ) : array
return array An array of JHtml options.

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.1
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.1
public getStatic ( ) : string
return string The field HTML

translate() public method

Translate a list of objects with JText::_().
Since: 2.1
public translate ( stdClass $item, string $type ) : string
$item stdClass The component object
$type string The extension type (e.g. component)
return string $text The translated name of the extension

Property Details

$client_ids public property

Override for the list of client IDs. Comma separated list, e.g. "0,1"
public string $client_ids
return string

$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