Gallery
extends Field
in package
Table of Contents
Properties
- $multiple : mixed
Methods
- isAValue() : bool
- this function tells to the form if this element is a value that needs to be included into parent values() function call result
- isMultiple() : bool
- preRender() : mixed
- {@inheritdoc}
- renderField() : string|BaseElement
- The function that actually renders the html field
- getCollection() : BaseCollection
- renderMediaElement() : string
Properties
$multiple
protected
mixed
$multiple
= false
Methods
isAValue()
this function tells to the form if this element is a value that needs to be included into parent values() function call result
public
isAValue() : bool
Return values
bool —include_me
isMultiple()
public
isMultiple([bool|null $multiple = null ]) : bool
Parameters
- $multiple : bool|null = null
Return values
boolpreRender()
{@inheritdoc}
public
preRender(Form $form) : mixed
Parameters
- $form : Form
-
form object
renderField()
The function that actually renders the html field
public
renderField(Form $form) : string|BaseElement
Parameters
- $form : Form
-
form object
Return values
string|BaseElement —the field html
getCollection()
protected
getCollection(int|null $parent_id) : BaseCollection
Parameters
- $parent_id : int|null
Return values
BaseCollectionrenderMediaElement()
protected
renderMediaElement(MediaElement|null $media[, string|null $labelText = null ][, int $maxLength = 12 ]) : string
Parameters
- $media : MediaElement|null
- $labelText : string|null = null
- $maxLength : int = 12