class GridFieldExportButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler (View source)

Adds an "Export list" button to the bottom of a GridField.

Properties

protected array $exportColumns
protected string $csvSeparator
protected bool $csvHasHeader
protected $targetFragment

Fragment to write the button to

Methods

public
__construct(string $targetFragment = "after", array $exportColumns = null)

No description

public
array
getHTMLFragments($gridField)

Place the export button in a

tag below the field

public
array
getActions($gridField)

export is an action button

public
handleAction(GridField $gridField, $actionName, $arguments, $data)

Handle an action on the given GridField.

public
getURLHandlers($gridField)

it is also a URL

public
handleExport($gridField, $request = null)

Handle the export, for both the action button and the URL

protected
array
getExportColumnsForGridField(GridField $gridField)

Return the columns to export

public
string
generateExportFileData(GridField $gridField)

Generate export fields for CSV.

public
array
getExportColumns()

No description

public
setExportColumns($cols)

No description

public
string
getCsvSeparator()

No description

public
setCsvSeparator($separator)

No description

public
bool
getCsvHasHeader()

No description

public
setCsvHasHeader($bool)

No description

Details

__construct(string $targetFragment = "after", array $exportColumns = null)

No description

Parameters

string $targetFragment

The HTML fragment to write the button into

array $exportColumns

The columns to include in the export

array getHTMLFragments($gridField)

Place the export button in a

tag below the field

Parameters

$gridField

Return Value

array

array getActions($gridField)

export is an action button

Parameters

$gridField

Return Value

array

with action identifier strings.

handleAction(GridField $gridField, $actionName, $arguments, $data)

Handle an action on the given GridField.

Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.

Parameters

GridField $gridField
$actionName
$arguments
$data

getURLHandlers($gridField)

it is also a URL

Parameters

$gridField

handleExport($gridField, $request = null)

Handle the export, for both the action button and the URL

Parameters

$gridField
$request

protected array getExportColumnsForGridField(GridField $gridField)

Return the columns to export

Parameters

GridField $gridField

Return Value

array

string generateExportFileData(GridField $gridField)

Generate export fields for CSV.

Parameters

GridField $gridField

Return Value

string

array getExportColumns()

No description

Return Value

array

setExportColumns($cols)

No description

Parameters

$cols

string getCsvSeparator()

No description

Return Value

string

setCsvSeparator($separator)

No description

Parameters

$separator

bool getCsvHasHeader()

No description

Return Value

bool

setCsvHasHeader($bool)

No description

Parameters

$bool