Craft Themes (4.x)

DisplayInterface

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>

getHandle()

Get the display's item handle

public getHandle() : string
Return values
string

getName()

Get the display's item name

public getName() : string
Return values
string

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

Search results