Display
extends Model
in package
implements
DisplayInterface
Interfaces, Classes and Traits
- DisplayInterface
- A display is assigned to a view mode, it has an `item` which can be a field or a group
Table of Contents
- $dateCreated : DateTime
- $dateUpdated : DateTime
- $group_id : int
- $id : int
- $order : int
- $type : string
- $uid : string
- $viewMode_id : int
- $_group : GroupInterface
- $_item : DisplayItemInterface
- $_viewMode : ViewModeInterface
- afterValidate() : mixed
- defineRules() : array<string|int, mixed>
- fields() : mixed
- getConfig() : array<string|int, mixed>
- Get project config
- getErrors() : mixed
- 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
- hasErrors() : mixed
- 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
Properties
$dateCreated
public
DateTime
$dateCreated
$dateUpdated
public
DateTime
$dateUpdated
$group_id
public
int
$group_id
$id
public
int
$id
$order
public
int
$order
= 0
$type
public
string
$type
$uid
public
string
$uid
$viewMode_id
public
int
$viewMode_id
$_group
protected
GroupInterface
$_group
$_item
protected
DisplayItemInterface
$_item
$_viewMode
protected
ViewModeInterface
$_viewMode
Methods
afterValidate()
public
afterValidate() : mixed
Tags
Return values
mixed —defineRules()
public
defineRules() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —fields()
public
fields() : mixed
Tags
Return values
mixed —getConfig()
Get project config
public
getConfig() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getErrors()
public
getErrors([mixed $attribute = null ]) : mixed
Parameters
- $attribute : mixed = null
Tags
Return values
mixed —getGroup()
Group getter
public
getGroup() : GroupInterface|null
Tags
Return values
GroupInterface|null —getHandle()
Get the display's item handle
public
getHandle() : string
Tags
Return values
string —getItem()
Item getter
public
getItem() : DisplayItemInterface
Tags
Return values
DisplayItemInterface —getLayout()
Layout getter
public
getLayout() : LayoutInterface
Tags
Return values
LayoutInterface —getName()
Get the display's item name
public
getName() : string
Tags
Return values
string —getViewMode()
View mode interface
public
getViewMode() : ViewModeInterface
Tags
Return values
ViewModeInterface —hasErrors()
public
hasErrors([mixed $attribute = null ]) : mixed
Parameters
- $attribute : mixed = null
Tags
Return values
mixed —isGroup()
Is this display a group
public
isGroup() : bool
Tags
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
Tags
Return values
Markup —setGroup()
Group setter
public
setGroup(GroupInterface|null $group) : mixed
Parameters
- $group : GroupInterface|null
Tags
Return values
mixed —setItem()
Item setter
public
setItem(DisplayItemInterface $item) : mixed
Parameters
- $item : DisplayItemInterface
Tags
Return values
mixed —setViewMode()
View mode setter
public
setViewMode(ViewModeInterface|null $viewMode) : mixed
Parameters
- $viewMode : ViewModeInterface|null