Craft Themes (4.x)

EmailEmail extends FieldDisplayer
in package

Renders an email field

Table of Contents

$handle  : mixed
$_field  : Field
$_options  : Model
afterValidate()  : mixed
beforeRender()  : bool
Callback before rendering, returning false will skip the field rendering.
eagerLoad()  : array<string|int, mixed>
fields()  : array<string|int, mixed>
getCanBeCached()  : bool
getDescription()  : string
getErrors()  : mixed
getField()  : FieldInterface
getFieldTargets()  : array<string|int, mixed>
getHandle()  : string
getHasOptions()  : bool
getName()  : string
getOptions()  : FieldDisplayerOptions
Get options
getTheme()  : ThemeInterface
Theme getter
hasErrors()  : bool
isDefault()  : bool
Is this displayer the default for a field class
setField()  : mixed
Field setter
setOptions()  : mixed
Options setter
getOptionsModel()  : string
Get options model class

Properties

$handle

public static mixed $handle = 'email-email'
Tags
inheritDoc

Methods

afterValidate()

public afterValidate() : mixed
Tags
inheritDoc
Return values
mixed

beforeRender()

Callback before rendering, returning false will skip the field rendering.

public beforeRender(mixed &$value) : bool
Parameters
$value : mixed
Tags
inheritDoc
Return values
bool

eagerLoad()

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

fields()

public fields() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getCanBeCached()

public getCanBeCached() : bool
Tags
inheritDoc
Return values
bool

getDescription()

public getDescription() : string
Tags
inheritDoc
Return values
string

getErrors()

public getErrors([mixed $attribute = null ]) : mixed
Parameters
$attribute : mixed = null
Tags
inheritDoc
Return values
mixed

getFieldTargets()

public static getFieldTargets() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getHandle()

public static getHandle() : string
Tags
inheritDoc
Return values
string

getHasOptions()

public getHasOptions() : bool
Tags
inheritDoc
Return values
bool

getName()

public getName() : string
Tags
inheritDoc
Return values
string

hasErrors()

public hasErrors([mixed $attribute = null ]) : bool
Parameters
$attribute : mixed = null
Tags
inheritDoc
Return values
bool

isDefault()

Is this displayer the default for a field class

public static isDefault(string $fieldClass) : bool
Parameters
$fieldClass : string
Tags
inheritDoc
Return values
bool

setOptions()

Options setter

public setOptions(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>
Tags
inheritDoc
Return values
mixed

getOptionsModel()

Get options model class

protected getOptionsModel() : string
Tags
inheritDoc
Return values
string

Search results