Craft Themes (4.x)

DisplayerInterface

Base interface for displayers

Table of Contents

eagerLoad()  : array<string|int, string>
Modify eager load map
getCanBeCached()  : bool
Can this displayer be cached
getDescription()  : string
Description/helper shown in CP
getField()  : FieldInterface
Field getter
getHandle()  : string
Get handle
getHasOptions()  : bool
Does this displayer define options
getName()  : string
Get name

Methods

eagerLoad()

Modify eager load map

public eagerLoad(array<string|int, string> $eagerLoad[, string $prefix = '' ], int $level) : array<string|int, string>
Parameters
$eagerLoad : array<string|int, string>
$prefix : string = ''
$level : int
Return values
array<string|int, string>

getCanBeCached()

Can this displayer be cached

public getCanBeCached() : bool
Return values
bool

getDescription()

Description/helper shown in CP

public getDescription() : string
Return values
string

getHandle()

Get handle

public static getHandle() : string
Return values
string

getHasOptions()

Does this displayer define options

public getHasOptions() : bool
Return values
bool

Search results