FileFile
extends FieldDisplayer
in package
implements
FileFieldDisplayerInterface
Renders an asset file
Interfaces, Classes and Traits
- FileFieldDisplayerInterface
- Interface for field displayers that render files (Assets, user photo etc)
Table of Contents
- $handle : mixed
- $_displayerMapping : array<string|int, 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() : mixed
- getAllowedFileKinds() : array<string|int, mixed>
- Get available file kinds
- getCanBeCached() : bool
- getDescription() : string
- getDisplayerForKind() : FileDisplayerInterface|null
- getErrors() : mixed
- getField() : FieldInterface
- getFieldTargets() : array<string|int, mixed>
- getHandle() : string
- getHasOptions() : bool
- getName() : string
- getOptions() : FieldDisplayerOptions
- Get options
- getTheme() : ThemeInterface
- Theme getter
- hasErrors() : mixed
- 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
= 'file-file'
Tags
$_displayerMapping
protected
array<string|int, mixed>
$_displayerMapping
$_field
protected
Field
$_field
$_options
protected
Model
$_options
Methods
afterValidate()
public
afterValidate() : mixed
Tags
Return values
mixed —beforeRender()
Callback before rendering, returning false will skip the field rendering.
public
beforeRender(mixed &$value) : bool
Parameters
- $value : mixed
Tags
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
Return values
array<string|int, mixed> —fields()
public
fields() : mixed
Tags
Return values
mixed —getAllowedFileKinds()
Get available file kinds
public
getAllowedFileKinds() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCanBeCached()
public
getCanBeCached() : bool
Tags
Return values
bool —getDescription()
public
getDescription() : string
Tags
Return values
string —getDisplayerForKind()
public
getDisplayerForKind(string $kind) : FileDisplayerInterface|null
Parameters
- $kind : string
Tags
Return values
FileDisplayerInterface|null —getErrors()
public
getErrors([mixed $attribute = null ]) : mixed
Parameters
- $attribute : mixed = null
Tags
Return values
mixed —getField()
public
getField() : FieldInterface
Tags
Return values
FieldInterface —getFieldTargets()
public
static getFieldTargets() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getHandle()
public
static getHandle() : string
Tags
Return values
string —getHasOptions()
public
getHasOptions() : bool
Tags
Return values
bool —getName()
public
getName() : string
Tags
Return values
string —getOptions()
Get options
public
getOptions() : FieldDisplayerOptions
Tags
Return values
FieldDisplayerOptions —getTheme()
Theme getter
public
getTheme() : ThemeInterface
Tags
Return values
ThemeInterface —hasErrors()
public
hasErrors([mixed $attribute = null ]) : mixed
Parameters
- $attribute : mixed = null
Tags
Return values
mixed —isDefault()
Is this displayer the default for a field class
public
static isDefault(string $fieldClass) : bool
Parameters
- $fieldClass : string
Tags
Return values
bool —setField()
Field setter
public
setField(FieldInterface $field) : mixed
Parameters
- $field : FieldInterface
Tags
Return values
mixed —setOptions()
Options setter
public
setOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
Tags
Return values
mixed —getOptionsModel()
Get options model class
protected
getOptionsModel() : string