Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH Improve GridFieldExportButton csv export filename #11459

Open
wants to merge 1 commit into
base: 5
Choose a base branch
from
Open

ENH Improve GridFieldExportButton csv export filename #11459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 94 additions & 6 deletions src/Forms/GridField/GridFieldExportButton.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
use LogicException;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\View\ViewableData;

/**
Expand Down Expand Up @@ -42,6 +42,16 @@ class GridFieldExportButton extends AbstractGridFieldComponent implements GridFi
*/
protected $targetFragment;

/**
* Export file name
*/
protected $exportFileName = '[classname]-export-[timestamp].csv';

/**
* Export file name timestamp format
*/
protected $timeStampFormat = 'yyyy-MM-dd-HH-mm-ss';

/**
* Set to true to disable XLS sanitisation
* [SS-2017-007] Ensure all cells with leading [@=+] have a leading tab
Expand All @@ -54,11 +64,25 @@ class GridFieldExportButton extends AbstractGridFieldComponent implements GridFi
/**
* @param string $targetFragment The HTML fragment to write the button into
* @param array $exportColumns The columns to include in the export
* @param string $exportFileName Export file name
* @param string $timeStampFormat Export file name timestamp format
*/
public function __construct($targetFragment = "after", $exportColumns = null)
{
public function __construct(
$targetFragment = 'after',
$exportColumns = null,
$exportFileName = null,
$timeStampFormat = null
) {
$this->targetFragment = $targetFragment;
$this->exportColumns = $exportColumns;

if ($exportFileName) {
$this->exportFileName = $exportFileName;
}

if ($timeStampFormat) {
$this->timeStampFormat = $timeStampFormat;
}
}

/**
Expand Down Expand Up @@ -128,8 +152,7 @@ public function getURLHandlers($gridField)
*/
public function handleExport($gridField, $request = null)
{
$now = date("d-m-Y-H-i");
$fileName = "export-$now.csv";
$fileName = $this->getExportFileName($gridField);

if ($fileData = $this->generateExportFileData($gridField)) {
return HTTPRequest::send_file($fileData, $fileName, 'text/csv');
Expand Down Expand Up @@ -351,4 +374,69 @@ public function setCsvHasHeader($bool)
$this->csvHasHeader = $bool;
return $this;
}

/**
* @param string $exportFileName
*
* @return $this
*/
public function setExportFileName($exportFileName): GridFieldExportButton
{
$this->exportFileName = $exportFileName;

return $this;
}

/**
* @param GridField $gridField
*
* @return string
*/
public function getExportFileName(GridField $gridField): string
{
$exportFileName = $this->exportFileName;

if (!$exportFileName) {
return null;
}

if (str_contains($exportFileName, '[classname]')) {
$className = strtolower(
preg_replace(
'/(?<!^)[A-Z]/',
'-$0',
ClassInfo::shortName(
$gridField->getModelClass()
)
)
);
$exportFileName = str_replace(
'[classname]',
$className,
$exportFileName
);
}

if (str_contains($exportFileName, '[timestamp]')) {
$exportFileName = str_replace(
'[timestamp]',
DBDatetime::now()->Format($this->timeStampFormat),
$exportFileName
);
}

return $exportFileName;
}

/**
* @param string $timeStampFormat
*
* @return $this
*/
public function setTimeStampFormat($timeStampFormat): GridFieldExportButton
{
$this->timeStampFormat = $timeStampFormat;

return $this;
}
}
80 changes: 75 additions & 5 deletions tests/php/Forms/GridField/GridFieldExportButtonTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
use SilverStripe\Forms\Tests\GridField\GridFieldExportButtonTest\Team;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldPaginator;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\View\ArrayData;

Expand All @@ -32,6 +32,16 @@ class GridFieldExportButtonTest extends SapphireTest
*/
protected $gridField;

/**
* @var GridFieldConfig
*/
protected $gridFieldConfig;

/**
* @var GridFieldExportButton
*/
protected $exportButton;

protected static $fixture_file = 'GridFieldExportButtonTest.yml';

protected static $extra_dataobjects = [
Expand All @@ -45,8 +55,10 @@ protected function setUp(): void

$this->list = new DataList(Team::class);
$this->list = $this->list->sort('Name');
$config = GridFieldConfig::create()->addComponent(new GridFieldExportButton());
$this->gridField = new GridField('testfield', 'testfield', $this->list, $config);
$this->gridFieldConfig = GridFieldConfig::create()->addComponent(
$this->exportButton = new GridFieldExportButton()
);
$this->gridField = new GridField('testfield', 'testfield', $this->list, $this->gridFieldConfig);
}

public function testCanView()
Expand Down Expand Up @@ -161,8 +173,8 @@ public function testArrayListInput()
$button = new GridFieldExportButton();
$columns = new GridFieldDataColumns();
$columns->setDisplayFields(['ID' => 'ID']);
$this->gridField->getConfig()->addComponent($columns);
$this->gridField->getConfig()->addComponent(new GridFieldPaginator());
$this->gridFieldConfig->addComponent($columns);
$this->gridFieldConfig->addComponent(new GridFieldPaginator());

//Create an ArrayList 1 greater the Paginator's default 15 rows
$arrayList = new ArrayList();
Expand Down Expand Up @@ -218,6 +230,64 @@ public function testGetExportColumnsForGridFieldThrowsException()
$reflectionMethod->invoke($component, $gridField);
}

public function testSetExportFileName()
{
$this->exportButton->setExportFileName('export.csv');

$this->assertEquals(
'export.csv',
$this->exportButton->getExportFileName($this->gridField)
);

$this->exportButton->setExportFileName('[classname]-export.csv');

$this->assertEquals(
'team-export.csv',
$this->exportButton->getExportFileName($this->gridField)
);

$mockDate = '2024-12-31 22:10:59';
DBDatetime::set_mock_now($mockDate);

$this->exportButton->setExportFileName('export-[timestamp].csv');

$this->assertEquals(
'export-2024-12-31-22-10-59.csv',
$this->exportButton->getExportFileName($this->gridField)
);

$this->exportButton->setExportFileName('[classname]-export-[timestamp].csv');

$this->assertEquals(
'team-export-2024-12-31-22-10-59.csv',
$this->exportButton->getExportFileName($this->gridField)
);

DBDatetime::clear_mock_now();
}

public function testSetTimeStampFormat()
{
$mockDate = '2024-12-31 22:10:59';
DBDatetime::set_mock_now($mockDate);

$this->exportButton->setTimeStampFormat('yyyyMMdd-HHmmss');

$this->assertEquals(
'team-export-20241231-221059.csv',
$this->exportButton->getExportFileName($this->gridField)
);

$this->exportButton->setTimeStampFormat('dd-MM-yyyy');

$this->assertEquals(
'team-export-31-12-2024.csv',
$this->exportButton->getExportFileName($this->gridField)
);

DBDatetime::clear_mock_now();
}

protected function createReader($string)
{
$reader = Reader::createFromString($string);
Expand Down