DisplayItemInterface
in
Generic interface for display items.
An item belongs to a display, it can be a group or a field.
Table of Contents
- eagerLoad() : array<string|int, string>
- Eager load fields
- getConfig() : array<string|int, mixed>
- Get project vonfig
- getDisplay() : DisplayInterface|null
- Display getter
- getHandle() : string
- Handle getter
- getLayout() : LayoutInterface
- Layout getter
- getName() : string
- Name getter
- getType() : string
- Type getter
- getViewMode() : ViewModeInterface
- View mode getter
- isVisible() : bool
- Is this item visible
- setDisplay() : mixed
- Display setter
Methods
eagerLoad()
Eager load fields
public
eagerLoad([string $prefix = '' ], int $level[, array<string|int, string> &$dependencies = [] ]) : array<string|int, string>
Parameters
- $prefix : string = ''
- $level : int
- $dependencies : array<string|int, string> = []
-
cache tags
Return values
array<string|int, string> —getConfig()
Get project vonfig
public
getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDisplay()
Display getter
public
getDisplay() : DisplayInterface|null
Return values
DisplayInterface|null —getHandle()
Handle getter
public
getHandle() : string
Return values
string —getLayout()
Layout getter
public
getLayout() : LayoutInterface
Return values
LayoutInterface —getName()
Name getter
public
getName() : string
Return values
string —getType()
Type getter
public
static getType() : string
Return values
string —getViewMode()
View mode getter
public
getViewMode() : ViewModeInterface
Return values
ViewModeInterface —isVisible()
Is this item visible
public
isVisible() : bool
Return values
bool —setDisplay()
Display setter
public
setDisplay(DisplayInterface $display) : mixed
Parameters
- $display : DisplayInterface