2017 © Pedro Peláez
 

silverstripe-vendormodule gridfieldqueuedexport

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

image

silverstripe/gridfieldqueuedexport

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

  • Monday, June 18, 2018
  • by tractorcow
  • Repository
  • 11 Watchers
  • 7 Stars
  • 9,968 Installations
  • PHP
  • 1 Dependents
  • 3 Suggesters
  • 9 Forks
  • 5 Open issues
  • 13 Versions
  • 27 % Grown

The README.md

GridField Queued Export

Build Status Scrutinizer Code Quality SilverStripe supported module Code Coverage, (*1)

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., (*2)

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., (*3)

Requirements

Installation

To install run composer require silverstripe/gridfieldqueuedexport., (*6)

Configuration

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

$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()., (*8)

// 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., (*9)

The Versions

18/06 2018

dev-master

9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

25/05 2018

2.1.x-dev

2.1.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

04/04 2018

2.1.0

2.1.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

22/02 2018

2.0.0

2.0.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

17/01 2018

2.0.0-beta1

2.0.0.0-beta1

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

17/01 2018

2.0.x-dev

2.0.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

csv export silverstripe gridfield cwp queuedjobs

16/01 2018

1.x-dev

1.9999999.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

16/01 2018

1.1.x-dev

1.1.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

16/01 2018

1.0.x-dev

1.0.9999999.9999999-dev

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

29/08 2017

1.1.0

1.1.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

09/12 2016

1.0.0

1.0.0.0

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

13/06 2016

1.0.0-rc2

1.0.0.0-RC2

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs

24/05 2016

1.0.0-rc1

1.0.0.0-RC1

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

  Sources   Download

BSD-3-Clause

The Requires

 

csv export silverstripe gridfield cwp queuedjobs