GridFieldExportReportButton
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
Properties
| protected | array | $exportColumns | from GridFieldExportButton | |
| protected | string | $csvSeparator | from GridFieldExportButton | |
| protected | bool | $csvHasHeader | from GridFieldExportButton | |
| protected | $targetFragment | Fragment to write the button to |
from GridFieldExportButton |
Methods
Handle an action on the given GridField.
Handle the export, for both the action button and the URL
Details
__construct(string $targetFragment = "after", array $exportColumns = null)
No description
array
getHTMLFragments($gridField)
Place the export button in a
tag below the field
array
getActions($gridField)
export is an action button
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.
getURLHandlers($gridField)
it is also a URL
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
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()
array
getExportColumns()
No description
setExportColumns($cols)
No description
string
getCsvSeparator()
No description
setCsvSeparator($separator)
No description
bool
getCsvHasHeader()
No description
setCsvHasHeader($bool)
No description