DisplayInterface
in
A display is assigned to a view mode, it has an `item` which can be a field or a group
Table of Contents
- getConfig() : array<string|int, mixed>
- Get project config
- getGroup() : GroupInterface|null
- Group getter
- getHandle() : string
- Get the display's item handle
- getItem() : DisplayItemInterface
- Item getter
- getLayout() : LayoutInterface
- Layout getter
- getName() : string
- Get the display's item name
- getViewMode() : ViewModeInterface
- View mode interface
- isGroup() : bool
- Is this display a group
- render() : Markup
- Render this display
- setGroup() : mixed
- Group setter
- setItem() : mixed
- Item setter
- setViewMode() : mixed
- View mode setter
Methods
getConfig()
Get project config
public
getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getGroup()
Group getter
public
getGroup() : GroupInterface|null
Return values
GroupInterface|null —getHandle()
Get the display's item handle
public
getHandle() : string
Return values
string —getItem()
Item getter
public
getItem() : DisplayItemInterface
Return values
DisplayItemInterface —getLayout()
Layout getter
public
getLayout() : LayoutInterface
Return values
LayoutInterface —getName()
Get the display's item name
public
getName() : string
Return values
string —getViewMode()
View mode interface
public
getViewMode() : ViewModeInterface
Return values
ViewModeInterface —isGroup()
Is this display a group
public
isGroup() : bool
Return values
bool —render()
Render this display
public
render([array<string|int, mixed> $params = [] ]) : Markup
Parameters
- $params : array<string|int, mixed> = []
-
Parameters forwarded to display's item render method
Return values
Markup —setGroup()
Group setter
public
setGroup(GroupInterface $group) : mixed
Parameters
- $group : GroupInterface
Return values
mixed —setItem()
Item setter
public
setItem(DisplayItemInterface $item) : mixed
Parameters
- $item : DisplayItemInterface
Return values
mixed —setViewMode()
View mode setter
public
setViewMode(ViewModeInterface $viewMode) : mixed
Parameters
- $viewMode : ViewModeInterface