class GridFieldExportReportButton extends GridFieldExportButton (View source)

An extension to GridFieldExportButton to support downloading a custom Report as a CSV file

This code was adapted from a solution posted in SilverStripe.org forums: http://www.silverstripe.org/customising-the-cms/show/38202

Traits

A class that can be instantiated or replaced via DI

Properties

protected array $exportColumns from  GridFieldExportButton
protected string $csvSeparator from  GridFieldExportButton
protected string $csvEnclosure from  GridFieldExportButton
protected bool $csvHasHeader from  GridFieldExportButton
protected $targetFragment

Fragment to write the button to

from  GridFieldExportButton

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

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

No description

public
array
getHTMLFragments(GridField $gridField)

Place the export button in a

tag below the field

public
array
getActions(GridField $gridField)

export is an action button

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

Handle an action on the given GridField.

public
array
getURLHandlers(GridField $gridField)

it is also a URL

public
handleExport(GridField $gridField, HTTPRequest $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
$this
setExportColumns(array $cols)

No description

public
string
getCsvSeparator()

No description

public
$this
setCsvSeparator(string $separator)

No description

public
string
getCsvEnclosure()

No description

public
$this
setCsvEnclosure(string $enclosure)

No description

public
bool
getCsvHasHeader()

No description

public
$this
setCsvHasHeader(bool $bool)

No description

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__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 $gridField)

Place the export button in a

tag below the field

Parameters

GridField $gridField

Return Value

array

array getActions(GridField $gridField)

export is an action button

Parameters

GridField $gridField

Return Value

array

with action identifier strings.

handleAction(GridField $gridField, string $actionName, array $arguments, array $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
string $actionName

Action identifier, see getActions().

array $arguments

Arguments relevant for this

array $data

All form data

array getURLHandlers(GridField $gridField)

it is also a URL

Parameters

GridField $gridField

Return Value

array

HTTPResponse handleExport(GridField $gridField, HTTPRequest $request = null)

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

Parameters

GridField $gridField
HTTPRequest $request

Return Value

HTTPResponse

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.

Replaces the definition in GridFieldExportButton, this is the same as original except it sources the List from $gridField->getList() instead of $gridField->getManipulatedList()

Parameters

GridField $gridField

Return Value

string

array getExportColumns()

No description

Return Value

array

$this setExportColumns(array $cols)

No description

Parameters

array $cols

Return Value

$this

string getCsvSeparator()

No description

Return Value

string

$this setCsvSeparator(string $separator)

No description

Parameters

string $separator

Return Value

$this

string getCsvEnclosure()

No description

Return Value

string

$this setCsvEnclosure(string $enclosure)

No description

Parameters

string $enclosure

Return Value

$this

bool getCsvHasHeader()

No description

Return Value

bool

$this setCsvHasHeader(bool $bool)

No description

Parameters

bool $bool

Return Value

$this