This Silverstripe module makes it easy to export a set of Silverstripe DataObjects to:

• Excel 2007 (XLSX)
• Excel 5 (XLS)
• CSV

This module is built by extending the standard SilverStripe DataFormatter.

• silverstripe/cms >=3.1
• phpoffice/phpexcel >=1.8

• silverstripe/restfulserver >=3.1

Install the module through composer:

composer require firebrandhq/silverstripe-excel-export

There's 3 ways you can export your data to a spread sheet.

3 DataFormatters are provided:

• ExcelDataFormatter for XLSX
• OldExcelDataFormatter for XLS
• CsvDataFormatter for CSV

You can manually instantiate them to convert a list of DataObjects or a single DataObject.

$formatter = new ExcelDataFormatter();

// Will return an Excel Spreadsheet as a string for a single user
$filedata = $formatter->convertDataObject($user);

// Will return an Excel Spreadsheet as a string for a list of user
$filedata = $formatter->convertDataObjectSet(Member::get());

convertDataObjectSet() and convertDataObject() will automatically set the Content-Type HTTP header to an appropriate Mime Type.

You can also retrieve the underlying PHPExcel object and export your DataObject set to whatever format supported by PHPExcel.

// Get your Data
$formatter = new ExcelDataFormatter();
$excel = $formatter->getPhpExcelObject(SiteTree::get());

// Set up a writer
$writer = PHPExcel_IOFactory::createWriter($excel, 'HTML');

// Save the file somewhere on the server
$writer->save('/tmp/sitetree_list.html');

// Output the results back to the browser
$writer->save('php://output');

// Output the file to a variable
ob_start();
$writer->save('php://output');
$fileData = ob_get_clean();

The GridFieldExcelExportButton allows your CMS users to easily export the data from a GridField to a spreadsheet.

$rowEntryConfig = GridFieldConfig_RecordEditor::create();
$rowEntryConfig->addComponent(new GridFieldExcelExportButton());
$rowEntryDataGridField = new GridField(
    "ContentRow",
    "Content Row Entry",
    $this->ContentRow(),
    $rowEntryConfig
);
$fields->addFieldToTab('Root.Main', $rowEntryDataGridField);

The above code snippet will display a split button allowing the user to export the GridField list to the format of their choice.

Unlike the SilverStripe GridFieldExportButton, the GridFieldExcelExportButton will export all the fields of the provided DataObjects ... not just the summary fields.

The SilverStripe RestfulServer Module allows you to turn any SilverStripe website into a RESTFul Server.

If you use the SilverStripe RestfulServer Module in conjunction with the Silverstripe Excel Export module, you'll be able to dynamically export any DataObject set just by entering the right URL in your browser.

Obviously, you don't want everyone to be able to download any data off your website. The SilverStripe RestfulServer Module will only return results for DataObject with the $api_access property set.

private static $api_access = true;

Additionally, access to individual DataObjects is controlled by the canView function.

Configuration the SilverStripe RestfulServer Module

Exporting your data is just as easy as entering a URL.

• Get a list of all Pages in Excel 2007: http://localhost/api/v1/Page.xlsx
• Get a list of all Pages in Excel 5: http://localhost/api/v1/Page.xls
• Get a list of all Pages in CSV: http://localhost/api/v1/Page.csv
• Limit the list to 10 results: http://localhost/api/v1/Page.csv?limit=10
• Return a single record: http://localhost/api/v1/Page/37.xlsx
• Drill down into relationships: http://localhost/api/v1/Tag/127/Articles.xlsx

SilverStripe RestfulServer Module Supported operations