CustomFileControlsEvent¶
New in version 12.0: This event replaces the customControls
hook option, which is only available for TCA type
inline.
Listeners to the PSR-14 event
\TYPO3\CMS\Backend\Form\Event\CustomFileControlsEvent
are able to add custom controls to a TCA type
file field in form engine.
Custom controls are always displayed below the file references. In contrast
to the selectors, e.g. Select & upload files are custom controls
independent of the readonly and showFileSelectors options.
This means, you have full control in which scenario your custom controls
are being displayed.
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 TYPO3\CMS\Backend\Form\Event\CustomFileControlsEvent¶
Listeners to this Event will be able to add custom controls to a TCA type="file" field in FormEngine
- getResultArray()¶
- Return type
array
- setResultArray(array $resultArray)¶
WARNING: Modifying the result array should be used with care. It mostly only exists to allow additional $resultArray['javaScriptModules'].
- Parameters
$resultArray (
array) -- the resultArray
- getControls()¶
- Return type
array
- setControls(array $controls)¶
- Parameters
$controls (
array) -- the controls
- addControl(string $control, string $identifier = '')¶
- Parameters
$control (
string) -- the control$identifier (
string) -- the identifier, default: ''
- removeControl(string $identifier)¶
- Parameters
$identifier (
string) -- the identifier
- Return type
bool
- getTableName()¶
- Return type
string
- getFieldName()¶
- Return type
string
- getDatabaseRow()¶
- Return type
array
- getFieldConfig()¶
- Return type
array
- getFormFieldIdentifier()¶
- Return type
string
- getFormFieldName()¶
- Return type
string