FormTabs
Form Tabs definition
A translation of the form field tab configuration
class Backend\Classes\FormTabs
implements
IteratorAggregate,
ArrayAccessConstants
| Constant | Type | Value | Description |
|---|---|---|---|
SECTION_OUTSIDE
|
string |
"outside"
|
string
"outside"
|
SECTION_PRIMARY
|
string |
"primary"
|
string
"primary"
|
SECTION_SECONDARY
|
string |
"secondary"
|
string
"secondary"
|
Properties
public $cssClass : string
Specifies a CSS class to attach to the tab container.
public
$defaultTab
:
string
= "backend::lang.form.undefined_tab"
Default tab label to use when none is specified.
public
$fields
:
array
= []
Collection of panes fields to these tabs.
public
$icons
:
array
= []
List of icons for their corresponding tabs.
public
$lazy
:
array
= []
Names of tabs to lazy load.
public
$linkable
:
bool
= true
Each tab gets url fragment to be linkable.
public $paneCssClass : array
Specifies a CSS class to an individual tab pane.
public
$section
:
string
= "outside"
Specifies the form section these tabs belong to.
public $stretch : bool
Should these tabs stretch to the bottom of the page layout.
public
$suppressTabs
:
bool
= false
If set to TRUE, fields will not be displayed in tabs.
Methods
public
__construct (string $section, array $config = [])
Constructor.
Specifies a tabs rendering section. Supported sections are:
- outside - stores a section of "tabless" fields.
- primary - tabs section for primary fields.
- secondary - tabs section for secondary fields.
| Property | Type | Description |
|---|---|---|
| $section | string |
string
Specifies a section as described above. |
| $config | array |
array
A list of render mode specific config. |
public
addField (string $name, Backend\Classes\FormField $field, string $tab = null)
Add a field to the collection of tabs.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
| $field | Backend\Classes\FormField |
Backend\Classes\FormField
|
| $tab | string |
string
|
public getAllFields () : array
Returns an array of the registered fields, without tabs.
public getFields () : array
Returns an array of the registered fields, including tabs.
public getIcon (string $name) : string
Returns an icon for the tab based on the tab's name.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
public getIterator () : Traversable
Get an iterator for the items.
public
getPaneCssClass (string $index = null, string $label = null)
: string
Returns a tab pane CSS class.
| Property | Type | Description |
|---|---|---|
| $index | string |
string
|
| $label | string |
string
|
public hasFields () : bool
Returns true if any fields have been registered for these tabs
public offsetExists ($offset) : bool
ArrayAccess implementation
| Property | Type | Description |
|---|---|---|
| $offset | mixed |
mixed
|
public offsetGet ($offset)
ArrayAccess implementation
| Property | Type | Description |
|---|---|---|
| $offset | mixed |
mixed
|
public offsetSet ($offset, $value) : void
ArrayAccess implementation
| Property | Type | Description |
|---|---|---|
| $offset | mixed |
mixed
|
| $value | mixed |
mixed
|
public offsetUnset ($offset) : void
ArrayAccess implementation
| Property | Type | Description |
|---|---|---|
| $offset | mixed |
mixed
|
public removeField (string $name) : bool
Remove a field from all tabs by name.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
protected evalConfig (array $config) : array
Process options and apply them to this object.
| Property | Type | Description |
|---|---|---|
| $config | array |
array
|