ProcessFileListActionsEvent
Event fired to modify icons rendered for the file listings
Table of Contents
Methods
- __construct() : mixed
- getAction() : ComponentInterface|null
- Get action by its name. In case the action exists in both groups and none or an invalid $group is provided, the action from the "primary" group will be returned.
- getActionGroup() : ComponentGroup
- Get the actions of a specific group
- getRequest() : RequestInterface
- getResource() : ResourceInterface
- hasAction() : bool
- Whether the action exists in the given group. In case none or an invalid $group is provided, both groups will be checked.
- isFile() : bool
- moveActionTo() : void
- removeAction() : void
- Remove action by its name. In case the action exists in both groups and none or an invalid $group is provided, the action will be removed from both groups.
- setAction() : void
- Add a new action or override an existing one. Latter is only possible, in case $columnName is given. Otherwise, the column 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.
Methods
__construct()
public
__construct(ComponentGroup $primary, ComponentGroup $secondary, ResourceInterface $fileOrFolder, RequestInterface $request) : mixed
Parameters
- $primary : ComponentGroup
- $secondary : ComponentGroup
- $fileOrFolder : ResourceInterface
- $request : RequestInterface
getAction()
Get action by its name. In case the action exists in both groups and none or an invalid $group is provided, the action from the "primary" group will be returned.
public
getAction(string $actionName[, ActionGroup|null $group = null ]) : ComponentInterface|null
Parameters
- $actionName : string
- $group : ActionGroup|null = null
Return values
ComponentInterface|nullgetActionGroup()
Get the actions of a specific group
public
getActionGroup(ActionGroup $group) : ComponentGroup
Parameters
- $group : ActionGroup
Return values
ComponentGroupgetRequest()
public
getRequest() : RequestInterface
Return values
RequestInterfacegetResource()
public
getResource() : ResourceInterface
Return values
ResourceInterfacehasAction()
Whether the action exists in the given group. In case none or an invalid $group is provided, both groups will be checked.
public
hasAction(string $actionName[, ActionGroup|null $group = null ]) : bool
Parameters
- $actionName : string
- $group : ActionGroup|null = null
Return values
boolisFile()
public
isFile() : bool
Return values
boolmoveActionTo()
public
moveActionTo(string $actionName, ActionGroup $group[, string $before = '' ][, string $after = '' ]) : void
Parameters
- $actionName : string
- $group : ActionGroup
- $before : string = ''
- $after : string = ''
removeAction()
Remove action by its name. In case the action exists in both groups and none or an invalid $group is provided, the action will be removed from both groups.
public
removeAction(string $actionName[, ActionGroup|null $group = null ]) : void
Parameters
- $actionName : string
- $group : ActionGroup|null = null
setAction()
Add a new action or override an existing one. Latter is only possible, in case $columnName is given. Otherwise, the column 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(ComponentInterface|null $action, string $actionName[, ActionGroup $group = ActionGroup::secondary ][, string $before = '' ][, string $after = '' ]) : void
Note: In case none or an invalid $group is provided, the new action will be added to the secondary group.
Parameters
- $action : ComponentInterface|null
- $actionName : string
- $group : ActionGroup = ActionGroup::secondary
- $before : string = ''
- $after : string = ''