tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Accessors, documentation and i18n for GridFieldExporter

Browse Source
This commit is contained in:
Ingo Schommer 2012-01-30 16:48:15 +01:00
parent 2d898cab63
commit 5faca9ca2f
1 changed files with 73 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
forms/gridfield/GridFieldExporter.php
View File

@ -1,4 +1,8 @@
<?php <?php
/**
* @package sapphire
* @subpackage gridfield
*/
/** /**
* Adds an "Export list" button to the bottom of a GridField. * Adds an "Export list" button to the bottom of a GridField.
@ -6,12 +10,27 @@
* WARNING: This is experimental and its API is subject to change. Feel free to use it as long as you are happy of * WARNING: This is experimental and its API is subject to change. Feel free to use it as long as you are happy of
* refactoring your code in the future. * refactoring your code in the future.
*/ */
class GridFieldExporter implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler { class GridFieldExporter implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler {
/**
* @var array Map of a property name on the exported objects, with values being the column title in the CSV file.
* Note that titles are only used when {@link $csvHasHeader} is set to TRUE.
*/
protected $exportColumns; protected $exportColumns;
/**
* @var string
*/
protected $csvSeparator = ","; protected $csvSeparator = ",";
/**
* @var boolean
*/
protected $csvHasHeader = true; protected $csvHasHeader = true;
/**
* @param array
*/
public function __construct($exportColumns = null) { public function __construct($exportColumns = null) {
$this->exportColumns = $exportColumns; $this->exportColumns = $exportColumns;
} }
@ -20,7 +39,13 @@ class GridFieldExporter implements GridField_HTMLProvider, GridField_ActionProvi
* Place the export button in a <p> tag below the field * Place the export button in a <p> tag below the field
*/ */
public function getHTMLFragments($gridField) { public function getHTMLFragments($gridField) {
$button = new GridField_Action($gridField, 'export', 'Export to CSV', 'export', null); $button = new GridField_Action(
$gridField,
'export',
_t('TableListField.CSVEXPORT', 'Export to CSV'),
'export',
null
);
return array( return array(
'after' => '<p>' . htmlentities($button->Field()) . '</p>', 'after' => '<p>' . htmlentities($button->Field()) . '</p>',
); );
@ -65,7 +90,7 @@ class GridFieldExporter implements GridField_HTMLProvider, GridField_ActionProvi
*/ */
function generateExportFileData($gridField) { function generateExportFileData($gridField) {
$separator = $this->csvSeparator; $separator = $this->csvSeparator;
$csvColumns = ($this->exportColumns) ? $this->exportColumns : $gridField->getDisplayFields(); $csvColumns = $this->getExportColumns();
$fileData = ''; $fileData = '';
$columnData = array(); $columnData = array();
$fieldItems = new ArrayList(); $fieldItems = new ArrayList();
@ -91,5 +116,50 @@ class GridFieldExporter implements GridField_HTMLProvider, GridField_ActionProvi
return $fileData; return $fileData;
} }
/**
* Returns exported columns, defaults to {@link GridField->getDisplayFields()}.
*
* @return array
*/
function getExportColumns() {
return ($this->exportColumns) ? $this->exportColumns : $gridField->getDisplayFields();
}
/**
* @param array
*/
function setExportColumns($cols) {
$this->exportColumns = $cols;
}
/**
* @return string
*/
function getCsvSeparator() {
return $this->csvSeparator;
}
/**
* @param string
*/
function setCsvSeparator($separator) {
$this->csvSeparator = $separator;
}
/**
* @return boolean
*/
function getCsvHasHeader() {
return $this->csvHasHeader;
}
/**
* @param boolean
*/
function setCsvHasHeader($bool) {
$this->csvHasHeader = $bool;
}
} }