Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

165 lines (141 sloc) 3.494 kB
<?php
/**
* @package sapphire
* @subpackage gridfield
*/
/**
* Adds an "Export list" button to the bottom of a GridField.
*
* 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.
*/
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;
/**
* @var string
*/
protected $csvSeparator = ",";
/**
* @var boolean
*/
protected $csvHasHeader = true;
/**
* @param array
*/
public function __construct($exportColumns = null) {
$this->exportColumns = $exportColumns;
}
/**
* Place the export button in a <p> tag below the field
*/
public function getHTMLFragments($gridField) {
$button = new GridField_Action(
$gridField,
'export',
_t('TableListField.CSVEXPORT', 'Export to CSV'),
'export',
null
);
return array(
'after' => '<p>' . htmlentities($button->Field()) . '</p>',
);
}
/**
* export is an action button
*/
public function getActions($gridField) {
return array('export');
}
function handleAction(GridField $gridField, $actionName, $arguments, $data) {
if($actionName == 'export') {
return $this->handleExport($gridField);
}
}
/**
* it is also a URL
*/
function getURLHandlers($gridField) {
return array(
'export' => 'handleExport',
);
}
/**
* Handle the export, for both the action button and the URL
*/
public function handleExport($gridField, $request = null) {
$now = Date("d-m-Y-H-i");
$fileName = "export-$now.csv";
if($fileData = $this->generateExportFileData($gridField)){
return SS_HTTPRequest::send_file($fileData, $fileName);
}
}
/**
* Export core.
*/
function generateExportFileData($gridField) {
$separator = $this->csvSeparator;
$csvColumns = $this->getExportColumns();
$fileData = '';
$columnData = array();
$fieldItems = new ArrayList();
if($this->csvHasHeader) {
$fileData .= "\"" . implode("\"{$separator}\"", array_values($csvColumns)) . "\"";
$fileData .= "\n";
}
$items = $gridField->getList();
foreach($items as $item) {
$columnData = array();
foreach($csvColumns as $columnSource => $columnHeader) {
$value = $item->$columnSource;
$value = str_replace(array("\r", "\n"), "\n", $value);
$columnData[] = '"' . str_replace('"', '\"', $value) . '"';
}
$fileData .= implode($separator, $columnData);
$fileData .= "\n";
$item->destroy();
}
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;
}
}
Jump to Line
Something went wrong with that request. Please try again.