GridFieldQueuedExportButton
class GridFieldQueuedExportButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler (View source)
A button you can add to a GridField to export that GridField as a CSV. Should work with any sized GridField, as the export is done using a queuedjob in the background.
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | array | $exportColumns | ||
| protected | string | $csvSeparator | ||
| 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.
No description
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)
This class is an action button
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
No description
HTTPResponse
startExport(GridField $gridField)
No description
array
getURLHandlers(GridField $gridField)
This class is also a URL handler
protected
getExportPath($id)
No description
HTTPResponse|DBHTMLText
checkExport(GridField $gridField, HTTPRequest $request = null)
Handle the export, for both the action button and the URL
HTTPResponse
downloadExport(GridField $gridField, HTTPRequest $request = null)
No description
array
getExportColumns()
No description
$this
setExportColumns($cols)
No description
string
getCsvSeparator()
No description
$this
setCsvSeparator($separator)
No description
bool
getCsvHasHeader()
No description
$this
setCsvHasHeader($bool)
No description