ModifyFileReferenceEnabledControlsEvent

FinalYes

Listeners to this Event will be able to modify the state (enabled or disabled) for controls of a file reference

Dispatched by

Table of Contents

Methods

__construct()  : mixed
disableControl()  : bool
Disable a control, if it exists
enableControl()  : bool
Enable a control, if it exists
getControlsState()  : array
Returns all controls with their state (enabled or disabled)
getElementData()  : array
Returns the whole element data
getEnabledControls()  : array
Returns all enabled controls
getFieldConfiguration()  : array
Returns the TCA configuration of the TCA type=file field
getForeignTable()  : string
Returns the table (foreign_table) the controls are created for
getParentUid()  : string
Returns the uid of the parent (embedding) record (uid or NEW...)
getRecord()  : array
Returns the current record of the controls are created for
hasControl()  : bool
Returns whether a control exists for the given identifier
isControlEnabled()  : bool
Returns whether the control is enabled.
isVirtual()  : bool
Returns whether the current records is only virtually shown and not physically part of the parent record

Methods

__construct()

public __construct(array $data, array $record) : mixed
Parameters
$data : array
$record : array

disableControl()

Disable a control, if it exists

public disableControl(string $identifier) : bool
Parameters
$identifier : string
Return values
bool —

Whether the control could be disabled

enableControl()

Enable a control, if it exists

public enableControl(string $identifier) : bool
Parameters
$identifier : string
Return values
bool —

Whether the control could be enabled

getControlsState()

Returns all controls with their state (enabled or disabled)

public getControlsState() : array
Return values
array

getElementData()

Returns the whole element data

public getElementData() : array
Return values
array

getEnabledControls()

Returns all enabled controls

public getEnabledControls() : array
Return values
array

getFieldConfiguration()

Returns the TCA configuration of the TCA type=file field

public getFieldConfiguration() : array
Return values
array

getForeignTable()

Returns the table (foreign_table) the controls are created for

public getForeignTable() : string
Return values
string

getParentUid()

Returns the uid of the parent (embedding) record (uid or NEW...)

public getParentUid() : string
Return values
string

getRecord()

Returns the current record of the controls are created for

public getRecord() : array
Return values
array

hasControl()

Returns whether a control exists for the given identifier

public hasControl(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

isControlEnabled()

Returns whether the control is enabled.

public isControlEnabled(string $identifier) : bool

Note: Will also return FALSE in case no control exists for the requested identifier

Parameters
$identifier : string
Return values
bool

isVirtual()

Returns whether the current records is only virtually shown and not physically part of the parent record

public isVirtual() : bool
Return values
bool
On this page

Search results