GridFieldBulkManager

class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnProvider, GridField_URLHandler (View source)

GridField component for editing attached models in bulk.

Properties

protected array $config

component configuration.

Methods

public
__construct(array $editableFields = null, bool $defaultActions = true)

GridFieldBulkManager component constructor.

public
setConfig(string $reference, mixed $value)

Sets the component configuration parameter.

public
mixed
getConfig(string $reference = false)

Returns one $config parameter of the full $config.

public
GridFieldBulkManager
addBulkAction(string $name, string $label = null, string $handler = null, array $config = null)

Lets you add custom bulk actions to the bulk manager interface.

public
GridFieldBulkManager
removeBulkAction(string $name)

Removes a bulk actions from the bulk manager interface.

public
augmentColumns(GridField $gridField, array $columns)

Add bulk select column.

public
array
getColumnsHandled(GridField $gridField)

Which columns are handled by the component.

public
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

Sets the column's content.

public
array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Set the column's HTML attributes.

public
array
getColumnMetadata(GridField $gridField, string $columnName)

Set the column's meta data.

public
array
getHTMLFragments($gridField)

No description

public
getURLHandlers($gridField)

Returns an action => handler list.

public
mixed
handleBulkAction(GridField $gridField, SS_HTTPRequest $request)

Pass control over to the RequestHandler loop through the handlers provided in config['actions'] and find matching url_handlers.

Details

at line 28
__construct(array $editableFields = null, bool $defaultActions = true)

GridFieldBulkManager component constructor.

Parameters

array $editableFields

List of editable fields
bool $defaultActions

Use default actions list. False to start fresh.

at line 77
setConfig(string $reference, mixed $value)

Sets the component configuration parameter.

Parameters

string $reference
mixed $value

at line 103
mixed getConfig(string $reference = false)

Returns one $config parameter of the full $config.

Parameters

string $reference

$congif parameter to return

Return Value

mixed

at line 124
GridFieldBulkManager addBulkAction(string $name, string $label = null, string $handler = null, array $config = null)

Lets you add custom bulk actions to the bulk manager interface.

add config options for front-end: isAjax, icon

Parameters

string $name

Bulk action's name. Used by RequestHandler.
string $label

Dropdown menu action's label. Default to ucfirst($name).
string $handler

RequestHandler class name for this action. Default to 'GridFieldBulkAction'.ucfirst($name).'Handler'
array $config

Front-end configuration array( 'isAjax' => true, 'icon' => 'accept', 'isDestructive' => false )

Return Value

GridFieldBulkManager

Current GridFieldBulkManager instance

at line 168
GridFieldBulkManager removeBulkAction(string $name)

Removes a bulk actions from the bulk manager interface.

Parameters

string $name

Bulk action's name

Return Value

GridFieldBulkManager

Current GridFieldBulkManager instance

at line 189
augmentColumns(GridField $gridField, array $columns)

Add bulk select column.

Parameters

GridField $gridField
array $columns

List of columns

at line 203
array getColumnsHandled(GridField $gridField)

Which columns are handled by the component.

Parameters

GridField $gridField

Return Value

array

at line 217
string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

Sets the column's content.

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

at line 235
array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Set the column's HTML attributes.

Parameters

GridField $gridField
DataObject $record

displayed in this row
string $columnName

Return Value

array

at line 248
array getColumnMetadata(GridField $gridField, string $columnName)

Set the column's meta data.

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

at line 264
array getHTMLFragments($gridField)

No description

Parameters

$gridField

Return Value

array

at line 322
getURLHandlers($gridField)

Returns an action => handler list.

Parameters

$gridField

at line 342
mixed handleBulkAction(GridField $gridField, SS_HTTPRequest $request)

Pass control over to the RequestHandler loop through the handlers provided in config['actions'] and find matching url_handlers.

$url_handlers rule should not use wildcards like '$Action' => '$Action' but have more specific path defined

Parameters

GridField $gridField
SS_HTTPRequest $request

Return Value

mixed