HtmlAudio
extends FileDisplayer
in package
Renders an audio file
Table of Contents
- $handle : string
- $_displayer : FieldDisplayerInterface
- $_options : FileDisplayerOptions
- beforeRender() : bool
- Callback before rendering, returning false will skip the file rendering
- eagerLoad() : array<string|int, mixed>
- fields() : array<string|int, mixed>
- getCanBeCached() : bool
- getDescription() : string
- getDisplayer() : FieldDisplayerInterface
- Displayer getter
- getField() : FieldInterface
- getHandle() : string
- getHasOptions() : bool
- getKindTargets() : array<string|int, mixed>
- getName() : string
- getOptions() : Model
- Get options
- getTheme() : ThemeInterface
- Get theme associated to this displayer
- isDefault() : bool
- Is this displayer the default for an asset kind
- setDisplayer() : mixed
- Displayer setter
- getOptionsModel() : string
- Get options model class
Properties
$handle
public
static string
$handle
= 'html-audio'
$_displayer
protected
FieldDisplayerInterface
$_displayer
$_options
protected
FileDisplayerOptions
$_options
Methods
beforeRender()
Callback before rendering, returning false will skip the file rendering
public
beforeRender(Asset $asset) : bool
Parameters
- $asset : Asset
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() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getCanBeCached()
public
getCanBeCached() : bool
Tags
Return values
bool —getDescription()
public
getDescription() : string
Tags
Return values
string —getDisplayer()
Displayer getter
public
getDisplayer() : FieldDisplayerInterface
Tags
Return values
FieldDisplayerInterface —getField()
public
getField() : FieldInterface
Tags
Return values
FieldInterface —getHandle()
public
static getHandle() : string
Tags
Return values
string —getHasOptions()
public
getHasOptions() : bool
Tags
Return values
bool —getKindTargets()
public
static getKindTargets() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getName()
public
getName() : string
Tags
Return values
string —getOptions()
Get options
public
getOptions() : Model
Tags
Return values
Model —getTheme()
Get theme associated to this displayer
public
getTheme() : ThemeInterface
Return values
ThemeInterface —isDefault()
Is this displayer the default for an asset kind
public
static isDefault(string $kind) : bool
Parameters
- $kind : string
Tags
Return values
bool —setDisplayer()
Displayer setter
public
setDisplayer(FieldDisplayerInterface $displayer) : mixed
Parameters
- $displayer : FieldDisplayerInterface
Tags
Return values
mixed —getOptionsModel()
Get options model class
protected
getOptionsModel() : string