silverstripe/gridfieldqueuedexport

Export large data sets from your GridField in the SilverStripe CMS interface through async jobs

4.0.0-alpha1 2024-11-20 23:11 UTC

Requires

• php: ^8.3
• league/csv: ^9
• silverstripe/framework: ^6
• symbiote/silverstripe-queuedjobs: ^6

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpunit/phpunit: ^11.3
• silverstripe/standards: ^1
• squizlabs/php_codesniffer: ^3

BSD-3-Clause

• csv
• export
• silverstripe
• gridfield
• queuedjobs
• cwp

README

Introduction

Allows for large data set exports from a GridField. By using an asynchronous job queue, we avoid running out of PHP memory or exceeding any maximum execution time limits.

The exact limitations of a standard GridField export vary based on the server configuration, server capacity and the complexity of the exported DataObject. As a rough guide, you should consider using this module when more than 1000 records need to be exported. The module should be able to export 10,000 records on a standard server configuration within a few minutes.

Installation

composer require silverstripe/gridfieldqueuedexport

Configuration

Since this component operates on a GridField, you can simply use it's addComponent() API.

$gridField = GridField::create('Pages', 'All pages', SiteTree::get())
$config = $gridField->getConfig();
$config->addComponent(GridFieldQueuedExportButton::create('buttons-after-left'));

If you want to replace the GridFieldExportButton created by the default GridField configuration, you also need to call removeComponentsByType().

// Find GridField
$gridField = $fields->fieldByName('MyGridField');
$config = $gridField->getConfig();

// Add new component
$oldExportButton = $config->getComponentByType(GridFieldExportButton::class);
$config->addComponent($newExportButton = GridFieldQueuedExportButton::create('buttons-after-left'));

// Set Header and Export columns on new Export Button
$newExportButton->setCsvHasHeader($oldExportButton->getCsvHasHeader()); 
$newExportButton->setExportColumns($oldExportButton->getExportColumns());

// Remove original component
$config->removeComponentsByType(GridFieldExportButton::class);

Note: This module is preconfigured to work with the silverstripe/userforms submission CSV export.

Related

• silverstripe/queuedjobcsvexport: General purpose CSV exports through queuedjobs (without a dependency on GridField)