GridFieldExportButton
class GridFieldExportButton extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler (View source)
Adds an "Export list" button to the bottom of a GridField.
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | array | $exportColumns | ||
| protected | string | $csvSeparator | ||
| protected | string | $csvEnclosure | ||
| protected | bool | $csvHasHeader | ||
| protected | $targetFragment | Fragment to write the button to |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Handle an action on the given GridField.
Handle the export, for both the action button and the URL
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();
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).
__construct(string $targetFragment = "after", array $exportColumns = null)
No description
array
getHTMLFragments(GridField $gridField)
Place the export button in a
tag below the field
array
getActions(GridField $gridField)
export is an action button
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.
array
getURLHandlers(GridField $gridField)
it is also a URL
HTTPResponse
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
string
generateExportFileData(GridField $gridField)
Generate export fields for CSV.
array
getExportColumns()
No description
$this
setExportColumns(array $cols)
No description
string
getCsvSeparator()
No description
$this
setCsvSeparator(string $separator)
No description
string
getCsvEnclosure()
No description
$this
setCsvEnclosure(string $enclosure)
No description
bool
getCsvHasHeader()
No description
$this
setCsvHasHeader(bool $bool)
No description