Add server side export #83

MaximePinot · 2019-04-30T15:14:37Z

This Bundle only allows server side processing. This raises an issue when it comes to use the HTML5 export buttons. These buttons only export the current page (as the DOM is only aware of the current page).

This pull request aims to fix this limitation.

Usage

I suggest you look at the ExporterController and the exporter.html.twig file for a complete usage example.

How it works

Front-end

https://github.com/MaximePinot/datatables-bundle/blob/10e586c98cb3c4f2f167828a932ef9180551e33d/tests/Fixtures/AppBundle/Resources/views/exporter.html.twig#L11-L26

Adding an export button must be handled by the front-end developer as it is not the Bundle's concern to manage/render anything. As the Bundle still needs some specific parameters to be sent, I created a function that generates the function needed by the action option.

Back-end

Everything is handled automatically by the Bundle and its current structure (isCallback / getResponse) is not changed (see this piece of code).

To trigger an "export state", the request must be sent with a _exporter parameter (along with the usual _dt parameter) whose value is the name of the DataTable exporter (defined by the getName() method).

At the moment, I only created an Excel exporter. I think the Bundle should be shipped with a few common exporters such as PDF, CSV and HTML. I plan to add these three, but I want to be sure that my implementation is correct before.

Anyone can add a DataTable exporter to its project by creating a service class that implements the Omines\DataTablesBundle\Exporter\DataTableExporterInterface. The service must be tagged with datatables.exporter.

Documentation

I did not write any documentation yet. I first want to be sure that my implementation is correct. When this pull request is ready to be merged. I will add a commit that adds a Server side export section to the documentation.

To support PHP 7.0

To maintain BC, it is not possible to type hint with the TranslatorInterface as older versions of Symfony inject "Symfony\Component\Translation\TranslatorInterface" while newer versions of Symfony inject "Symfony\Contracts\Translation\TranslatorInterface".

The 'render' column option is usually use to inject HTML.

Tests were passing using "Symfony\Component\Translation\DataCollectorTranslator" as type-hint but Symfony may inject "Symfony\Bundle\FrameworkBundle\Translation\Translator".

* Using a Generator makes the code more readable. * Avoid creating an array (iterator_to_array) may be sligtly faster?

curry684 · 2019-08-09T11:09:50Z

@shades684 changes make sense afaics, your opinion?

MaximePinot · 2019-08-09T11:27:53Z

Hi @curry684, thank you for reviewing my pull request.

I think some things should be improved. For example, it would be better to automatically tag classes that implement Omines\DataTablesBundle\Exporter\DataTableExporterInterface.

I need to add more tests. I'm using my fork in production and a "Cannot traverse an already closed generator" error is raised when one tries to export an empty DataTable. Apart from that, it's working fine.

However, exported data can be confusing depending of the render callback. Is there a way I can get the raw value from the database before the render callback is called?

curry684 · 2019-08-09T11:55:54Z

AbstractColumn::transform converts the raw value pre-rendering.

https://github.com/omines/datatables-bundle/blob/94777da/src/Column/AbstractColumn.php#L68-L77

…-export # Conflicts: # composer.json # src/DataTable.php # src/DataTableFactory.php # tests/Fixtures/services.yml

Export the entire table but keep current sort and filtering

MaximePinot · 2020-01-14T13:46:54Z

Hi @curry684 ,

I've been using my server-side-export branch for more than 6 months now on a big project. Everything is working as expected.

Could you also test it on one of your project?

As soon as you tell me everything is fine and my implementation is correct, I will add :

A HTML exporter
A PDF exporter
An "Export" section to the documentation

Then, I believe this PR will be ready to be merged!

Will not fix #122 but should prevent similar issues.

* Symfony 3 is not supported, according to the readme.md Symfony 3 is not supported, according to the readme.md. This updates the documentation to reflect that only Symfony 4.1+ is supported by this bundle * Update index.html.md

Alternative to #125

This is actually obsolete since Symfony Flex, as you can now run Symfony 4.1 with more recent components.

To support PHP 7.0

To maintain BC, it is not possible to type hint with the TranslatorInterface as older versions of Symfony inject "Symfony\Component\Translation\TranslatorInterface" while newer versions of Symfony inject "Symfony\Contracts\Translation\TranslatorInterface".

The 'render' column option is usually use to inject HTML.

Tests were passing using "Symfony\Component\Translation\DataCollectorTranslator" as type-hint but Symfony may inject "Symfony\Bundle\FrameworkBundle\Translation\Translator".

* Using a Generator makes the code more readable. * Avoid creating an array (iterator_to_array) may be sligtly faster?

Export the entire table but keep current sort and filtering

…atatables-bundle into server-side-export

MaximePinot · 2020-04-23T09:48:48Z

Wow, maybe I should have git merge instead of git rebase 😅 Sorry for all the duplicates... But at least, tests are passing!

curry684 · 2020-04-28T11:19:46Z

I have no good way to test at the moment and the PR is unreviewable due to the rebase, so I'll just merge it and we'll see how the community likes it :P

MaximePinot · 2020-04-28T11:38:10Z

Thanks @curry684! I'm watching this repository so I'll be responsive if someone opens an issue about this feature. 😉

curry684 · 2020-06-30T18:39:43Z

It would seem something in Symfony 5 broke it:

https://travis-ci.org/github/omines/datatables-bundle/jobs/703172222

There were 5 errors:
1) Tests\Functional\Exporter\Csv\CsvExporterTest::testExport
Error: Call to undefined method Symfony\Component\HttpFoundation\Response::getFile()
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Csv/CsvExporterTest.php:34
2) Tests\Functional\Exporter\Event\DataTableExporterResponseEventTest::testPreResponseEvent with data set #0 ('excel', 'xlsx')
TypeError: Argument 1 passed to PHPUnit\Framework\Assert::assertStringContainsString() must be of the type string, null given, called in /home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Event/DataTableExporterResponseEventTest.php on line 43
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Event/DataTableExporterResponseEventTest.php:43
3) Tests\Functional\Exporter\Event\DataTableExporterResponseEventTest::testPreResponseEvent with data set #1 ('txt', 'txt')
TypeError: Argument 1 passed to PHPUnit\Framework\Assert::assertStringContainsString() must be of the type string, null given, called in /home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Event/DataTableExporterResponseEventTest.php on line 43
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Event/DataTableExporterResponseEventTest.php:43
4) Tests\Functional\Exporter\Excel\ExcelExporterTest::testExport
Error: Call to undefined method Symfony\Component\HttpFoundation\Response::getFile()
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Excel/ExcelExporterTest.php:45
5) Tests\Functional\Exporter\Excel\ExcelExporterTest::testWithSearch
Error: Call to undefined method Symfony\Component\HttpFoundation\Response::getFile()
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Excel/ExcelExporterTest.php:103

Also a fatal:

1) Tests\Functional\Exporter\Excel\ExcelExporterTest::testEmptyDataTable
Failed asserting that false is true.
/home/travis/build/omines/datatables-bundle/tests/Functional/Exporter/Excel/ExcelExporterTest.php:77

Not really sure what's behind this. Could you have a look?

I'm holding off 0.5.0 until this is fixed (currently at rc1).

MaximePinot added 10 commits April 30, 2019 16:04

Add server side export

10e586c

Add missing dev dependency

f272733

Replace pseudo-type "iterable" by "\Traversable"

d72a226

To support PHP 7.0

Fix ArgumentCountError (Symfony ^3.4)

1fa9d10

Fix Content Disposition header format

9cc1796

Do not display the export form

2cad2c7

Excel: render HTML in cells

74ee8f4

The 'render' column option is usually use to inject HTML.

Fix Translator injection

ac32a5f

Tests were passing using "Symfony\Component\Translation\DataCollectorTranslator" as type-hint but Symfony may inject "Symfony\Bundle\FrameworkBundle\Translation\Translator".

Use a Generator instead of a new Iterator

3c67e29

* Using a Generator makes the code more readable. * Avoid creating an array (iterator_to_array) may be sligtly faster?

curry684 approved these changes Aug 9, 2019

View reviewed changes

MaximePinot added 6 commits August 9, 2019 19:59

Add functional test "testEmptyDataTable"

9fcea75

Merge remote-tracking branch 'remotes/origin/master' into server-side…

3dd9e1f

…-export # Conflicts: # composer.json # src/DataTable.php # src/DataTableFactory.php # tests/Fixtures/services.yml

Fix tests

c5da251

Preserve DataTableState

4977ae1

Export the entire table but keep current sort and filtering

Automatically tag exporters

1ef0c96

Add CSV exporter

828bab4

MaximePinot and others added 9 commits January 15, 2020 15:11

Add missing "_dt"

bb7059f

Fix "DT_RowId" check

5a78e68

Make dependency on contracts explicit

6c72c97

Will not fix #122 but should prevent similar issues.

Option for custom datetime format for creating object (#127)

fd7b222

Fix failing test by reverting custom WebClient handling

379cb40

Alternative to #125

Fix deprecations helper crashing old Symfony versions

19d8fd7

Drop bad testing method on old Symfony frameworks

3b666cd

This is actually obsolete since Symfony Flex, as you can now run Symfony 4.1 with more recent components.

Apply code style

0f255b2

MaximePinot added 21 commits April 23, 2020 10:33

Fix export issue when using GET method

dcaea54

Add server side export

450e45f

Add missing dev dependency

ce2d55a

Replace pseudo-type "iterable" by "\Traversable"

986cf7f

To support PHP 7.0

Fix ArgumentCountError (Symfony ^3.4)

69df58d

Fix Content Disposition header format

e6c0e5a

Do not display the export form

924dbe5

Excel: render HTML in cells

81a94c2

The 'render' column option is usually use to inject HTML.

Fix Translator injection

566c195

Tests were passing using "Symfony\Component\Translation\DataCollectorTranslator" as type-hint but Symfony may inject "Symfony\Bundle\FrameworkBundle\Translation\Translator".

Use a Generator instead of a new Iterator

52552b5

* Using a Generator makes the code more readable. * Avoid creating an array (iterator_to_array) may be sligtly faster?

Add functional test "testEmptyDataTable"

0816dee

Fix tests

0aece2a

Preserve DataTableState

7e983a5

Export the entire table but keep current sort and filtering

Automatically tag exporters

00f4ef5

Add CSV exporter

107267d

Add missing "_dt"

00f3154

Fix "DT_RowId" check

c232c57

Fix export issue when using GET method

3145bbc

Fix tests

4951d27

Merge branch 'server-side-export' of https://github.com/MaximePinot/d…

47e9842

…atatables-bundle into server-side-export

MaximePinot requested a review from curry684 April 23, 2020 09:52

curry684 merged commit f3a35b3 into omines:master Apr 28, 2020

curry684 mentioned this pull request Jun 30, 2020

Tag Release #155

Closed

MaximePinot mentioned this pull request Jul 2, 2020

Fix server-side export tests #168

Merged

NMe84 mentioned this pull request Sep 9, 2021

Update documentation to include info on the Exporter #239

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add server side export #83

Add server side export #83

MaximePinot commented Apr 30, 2019

curry684 commented Aug 9, 2019

MaximePinot commented Aug 9, 2019

curry684 commented Aug 9, 2019 •

edited

Loading

MaximePinot commented Jan 14, 2020

MaximePinot commented Apr 23, 2020

curry684 commented Apr 28, 2020

MaximePinot commented Apr 28, 2020

curry684 commented Jun 30, 2020 •

edited

Loading

Add server side export #83

Add server side export #83

Conversation

MaximePinot commented Apr 30, 2019

Usage

How it works

Front-end

Back-end

Documentation

curry684 commented Aug 9, 2019

MaximePinot commented Aug 9, 2019

curry684 commented Aug 9, 2019 • edited Loading

MaximePinot commented Jan 14, 2020

MaximePinot commented Apr 23, 2020

curry684 commented Apr 28, 2020

MaximePinot commented Apr 28, 2020

curry684 commented Jun 30, 2020 • edited Loading

curry684 commented Aug 9, 2019 •

edited

Loading

curry684 commented Jun 30, 2020 •

edited

Loading