ModifyRecordListTableActionsEvent

final class \TYPO3\CMS\Recordlist\Event\ModifyRecordListTableActionsEvent

An event to modify the multi record selection actions (e.g.

"edit", "copy to clipboard") for a table in the RecordList.

Table of Contents

Methods

__construct()  : mixed
getAction()  : string|null
Get action by its name
getActions()  : array
getNoActionLabel()  : string
Get the label, which will be displayed, in case no action is available for the current user. Note: If this returns an empty string, this only means that no other listener set a label before. TYPO3 will always fall back to a default if this remains empty.
getRecordIds()  : array
getRecordList()  : DatabaseRecordList
Returns the current DatabaseRecordList instance.
getTable()  : string
hasAction()  : bool
Whether the action exists
removeAction()  : bool
Remove action by its name
setAction()  : void
Add a new action or override an existing one. Latter is only possible, in case $actionName is given. Otherwise, the action will be added with a numeric index, which is generally not recommended. It's also possible to define the position of an action with either the "before" or "after" argument, while their value must be an existing action.
setActions()  : void
setNoActionLabel()  : void

Methods

getAction()

Get action by its name

public getAction(string $actionName) : string|null

Parameters

$actionName : string

Return values

string|null —

The action or NULL if the action does not exist

getActions()

public getActions() : array

Return values

array

getNoActionLabel()

Get the label, which will be displayed, in case no action is available for the current user. Note: If this returns an empty string, this only means that no other listener set a label before. TYPO3 will always fall back to a default if this remains empty.

public getNoActionLabel() : string

Return values

string

getRecordIds()

public getRecordIds() : array

Return values

array

getTable()

public getTable() : string

Return values

string

hasAction()

Whether the action exists

public hasAction(string $actionName) : bool

Parameters

$actionName : string

Return values

bool

removeAction()

Remove action by its name

public removeAction(string $actionName) : bool

Parameters

$actionName : string

Return values

bool —

Whether the action could be removed - Will therefore return FALSE if the action to remove does not exist.

setAction()

Add a new action or override an existing one. Latter is only possible, in case $actionName is given. Otherwise, the action will be added with a numeric index, which is generally not recommended. It's also possible to define the position of an action with either the "before" or "after" argument, while their value must be an existing action.

public setAction(string $action[, string $actionName = '' ][, string $before = '' ][, string $after = '' ]) : void

Parameters

$action : string
$actionName : string = ''
$before : string = ''
$after : string = ''

setActions()

public setActions(array $actions) : void

Parameters

$actions : array

setNoActionLabel()

public setNoActionLabel(string $noActionLabel) : void

Parameters

$noActionLabel : string
On this page