BulkAction
extends AbstractHelper
in package
Uses
BulkActionTrait
Bulk action view helper
Tags
Table of Contents
- $bulkActionConfig : Config
- Config
- $bulkActionExportConfig : Config
- Export Config
- $buttonClass : string|null
- CSS class for button
- $configLoader : PluginManager
- Configuration loader
- $export : Export
- Export support class
- __construct() : mixed
- Constructor
- button() : string
- Get a bulk action button
- getBulkActionLimit() : int
- Get the limit of a bulk action.
- getExportActionLimit() : int
- Get the limit of the export action for a specific format.
- getBulkActionConfig() : Config
- Get Config.
- getBulkActionExportConfig() : Config
- Get Export Config.
Properties
$bulkActionConfig
Config
protected
Config
$bulkActionConfig
$bulkActionExportConfig
Export Config
protected
Config
$bulkActionExportConfig
$buttonClass
CSS class for button
protected
string|null
$buttonClass
= null
$configLoader
Configuration loader
protected
PluginManager
$configLoader
$export
Export support class
protected
Export
$export
Methods
__construct()
Constructor
public
__construct(Export $export, PluginManager $configLoader) : mixed
Parameters
- $export : Export
-
Export support class
- $configLoader : PluginManager
-
Configuration loader
Return values
mixed —button()
Get a bulk action button
public
button(string $action, string $icon, string $content[, array<string|int, mixed> $attributes = [] ]) : string
Parameters
- $action : string
-
Action name
- $icon : string
-
Icon identifier
- $content : string
-
Content of the button
- $attributes : array<string|int, mixed> = []
-
Button element attributes
Return values
string —getBulkActionLimit()
Get the limit of a bulk action.
public
getBulkActionLimit(string $action) : int
Parameters
- $action : string
-
Name of the bulk action
Return values
int —getExportActionLimit()
Get the limit of the export action for a specific format.
public
getExportActionLimit(string $format) : int
Parameters
- $format : string
-
Name of the format
Return values
int —getBulkActionConfig()
Get Config.
protected
getBulkActionConfig() : Config
Return values
Config —getBulkActionExportConfig()
Get Export Config.
protected
getBulkActionExportConfig() : Config