ModifyFileReferenceControlsEvent

FinalYes

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

Table of Contents

Methods

__construct()  : mixed
getControl()  : string
Returns the markup for the requested control
getControls()  : array<string|int, mixed>
Returns all controls with their markup
getElementData()  : array<string|int, mixed>
Returns the whole element data
getFieldConfiguration()  : array<string|int, mixed>
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<string|int, mixed>
Returns the current record, the controls are created for
hasControl()  : bool
Returns whether a control exists for the given identifier
isVirtual()  : bool
Returns whether the current records is only virtually shown and not physically part of the parent record
removeControl()  : bool
Removes a control from the file reference, if it exists
setControl()  : void
Set a control with the given identifier and markup IMPORTANT: Overwrites an existing control with the same identifier
setControls()  : void
Overwrite the controls

Methods

__construct()

public __construct(array<string|int, mixed> $controls, array<string|int, mixed> $data, array<string|int, mixed> $record) : mixed
Parameters
$controls : array<string|int, mixed>
$data : array<string|int, mixed>
$record : array<string|int, mixed>

getControl()

Returns the markup for the requested control

public getControl(string $identifier) : string
Parameters
$identifier : string
Return values
string

getControls()

Returns all controls with their markup

public getControls() : array<string|int, mixed>
Return values
array<string|int, mixed>

getElementData()

Returns the whole element data

public getElementData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFieldConfiguration()

Returns the TCA configuration of the TCA type=file field

public getFieldConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>

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, the controls are created for

public getRecord() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasControl()

Returns whether a control exists for the given identifier

public hasControl(string $identifier) : bool
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

removeControl()

Removes a control from the file reference, if it exists

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

Whether the control could be removed

setControl()

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

public setControl(string $identifier, string $markup) : void
Parameters
$identifier : string
$markup : string

setControls()

Overwrite the controls

public setControls(array<string|int, mixed> $controls) : void
Parameters
$controls : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results