CustomFileControlsEvent
FinalYes
Listeners to this Event will be able to add custom controls to a TCA type="file" field in FormEngine
Table of Contents
Methods
- __construct() : mixed
- addControl() : void
- getControls() : array<string|int, mixed>
- getDatabaseRow() : array<string|int, mixed>
- getFieldConfig() : array<string|int, mixed>
- getFieldName() : string
- getFormFieldIdentifier() : string
- getFormFieldName() : string
- getResultArray() : array<string|int, mixed>
- getTableName() : string
- removeControl() : bool
- setControls() : void
- setResultArray() : void
- WARNING: Modifying the result array should be used with care. It mostly only exists to allow additional $resultArray['javaScriptModules'].
Methods
__construct()
public
__construct(array<string|int, mixed> $resultArray, string $tableName, string $fieldName, array<string|int, mixed> $databaseRow, array<string|int, mixed> $fieldConfig, string $formFieldIdentifier, string $formFieldName) : mixed
Parameters
- $resultArray : array<string|int, mixed>
- $tableName : string
- $fieldName : string
- $databaseRow : array<string|int, mixed>
- $fieldConfig : array<string|int, mixed>
- $formFieldIdentifier : string
- $formFieldName : string
addControl()
public
addControl(string $control[, string $identifier = '' ]) : void
Parameters
- $control : string
- $identifier : string = ''
getControls()
public
getControls() : array<string|int, mixed>
Return values
array<string|int, mixed>getDatabaseRow()
public
getDatabaseRow() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldConfig()
public
getFieldConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldName()
public
getFieldName() : string
Return values
stringgetFormFieldIdentifier()
public
getFormFieldIdentifier() : string
Return values
stringgetFormFieldName()
public
getFormFieldName() : string
Return values
stringgetResultArray()
public
getResultArray() : array<string|int, mixed>
Return values
array<string|int, mixed>getTableName()
public
getTableName() : string
Return values
stringremoveControl()
public
removeControl(string $identifier) : bool
Parameters
- $identifier : string
Return values
boolsetControls()
public
setControls(array<string|int, mixed> $controls) : void
Parameters
- $controls : array<string|int, mixed>
setResultArray()
WARNING: Modifying the result array should be used with care. It mostly only exists to allow additional $resultArray['javaScriptModules'].
public
setResultArray(array<string|int, mixed> $resultArray) : void
Parameters
- $resultArray : array<string|int, mixed>