ModifyFileReferenceControlsEvent¶

New in version 12.0

Listeners to the PSR-14 event \TYPO3\CMS\Backend\Form\Event\ModifyFileReferenceControlsEvent are able to modify the controls of a single file reference of a TCA type file field. This event is similar to the ModifyInlineElementControlsEvent, which is only available for TCA type inline.

Example¶

Note

Currently, we do not have an example for this event. If you can provide a useful one, please open an issue with your code snippets or a pull request.

API¶

class ModifyFileReferenceControlsEvent ¶

Fully qualified name: \TYPO3\CMS\Backend\Form\Event\ModifyFileReferenceControlsEvent

Listeners to this Event will be able to modify the controls of a single file reference of a TCA type=file field.

getControls ( ) ¶

Returns all controls with their markup

Returns: array

setControls ( array $controls) ¶

Overwrite the controls

param $controls: the controls

getControl ( string $identifier) ¶

Returns the markup for the requested control

param $identifier: the identifier

Returns: string

setControl ( string $identifier, string $markup) ¶

Set a control with the given identifier and markup IMPORTANT: Overwrites an existing control with the same identifier

param $identifier: the identifier
param $markup: the markup

hasControl ( string $identifier) ¶

Returns whether a control exists for the given identifier

param $identifier: the identifier

Returns: bool

removeControl ( string $identifier) ¶

Removes a control from the file reference, if it exists

param $identifier: the identifier
Return description: Whether the control could be removed

Returns: bool

getElementData ( ) ¶

Returns the whole element data

Returns: array

getRecord ( ) ¶

Returns the current record, the controls are created for

Returns: array

getParentUid ( ) ¶

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

Returns: string

getForeignTable ( ) ¶

Returns the table (foreign_table) the controls are created for

Returns: string

getFieldConfiguration ( ) ¶

Returns the TCA configuration of the TCA type=file field

Returns: array

isVirtual ( ) ¶

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

Returns: bool