Add events before and after creating the response (#373)

Author: NMe84

docs/source/index.html.md

@@ -545,6 +545,39 @@ Of course you can modify the base type to fit the controller's specific needs be
 `handleRequest`. Secondly, the `createDataTableFromType` function accepts an array as a second
 argument which is passed to the type class for parametrized instantiation.
 
+# Events
+
+A few events are available that allow you to hook into the DataTables lifecycle. These are dispatched
+by the `DataTable` instance, and can be listened to by adding event listeners to the table.
+
+## DataTableEvents::PRE_RESPONSE
+
+This event is dispatched just before the response is created, allowing you to modify the table
+one last time while the table state is already known. This could, for instance, be useful for
+adding or removing columns when in the server-side exporting context.
+
+```php?start_inline=1
+$table->addEventListener(DataTableEvents::PRE_RESPONSE, function (DataTablePreResponseEvent $event) {
+    $table = $event->getTable();
+
+    $table
+        ->add('extraColumn', TextColumn::class)
+        ->remove('obsoleteColumn')
+    ;
+});
+```
+
+## DataTableEvents::POST_RESPONSE
+
+This event is dispatched just after the response is created but before it is returned to the client.
+This is useful for logging, or other post-processing tasks.
+
+```php?start_inline=1
+$table->addEventListener(DataTableEvents::POST_RESPONSE, function (DataTablePreResponseEvent $event) use ($logger) {
+    $logger->info('Table rendered', ['table' => $event->getTable()]);
+});
+```
+
 # Javascript
 
 ```javascript

src/DataTable.php

@@ -16,6 +16,8 @@
 use Omines\DataTablesBundle\Adapter\ResultSetInterface;
 use Omines\DataTablesBundle\Column\AbstractColumn;
 use Omines\DataTablesBundle\DependencyInjection\Instantiator;
+use Omines\DataTablesBundle\Event\DataTablePostResponseEvent;
+use Omines\DataTablesBundle\Event\DataTablePreResponseEvent;
 use Omines\DataTablesBundle\Exception\InvalidArgumentException;
 use Omines\DataTablesBundle\Exception\InvalidConfigurationException;
 use Omines\DataTablesBundle\Exception\InvalidStateException;
@@ -123,6 +125,28 @@ public function add(string $name, string $type, array $options = []): static
         return $this;
     }
 
+    public function remove(string $name): static
+    {
+        if (!isset($this->columnsByName[$name])) {
+            throw new InvalidArgumentException(sprintf("There is no column with name '%s'", $name));
+        }
+
+        $column = $this->columnsByName[$name];
+        unset($this->columnsByName[$name]);
+        $index = array_search($column, $this->columns, true);
+        unset($this->columns[$index]);
+
+        return $this;
+    }
+
+    public function clearColumns(): static
+    {
+        $this->columns = [];
+        $this->columnsByName = [];
+
+        return $this;
+    }
+
     /**
      * Adds an event listener to an event on this DataTable.
      *
@@ -263,14 +287,19 @@ public function handleRequest(Request $request): static
 
     public function getResponse(): Response
     {
+        $this->eventDispatcher->dispatch(new DataTablePreResponseEvent($this), DataTableEvents::PRE_RESPONSE);
+
         $state = $this->getState();
 
         // Server side export
         if (null !== $state->getExporterName()) {
-            return $this->exporterManager
+            $response = $this->exporterManager
                 ->setDataTable($this)
                 ->setExporterName($state->getExporterName())
                 ->getResponse();
+            $this->eventDispatcher->dispatch(new DataTablePostResponseEvent($this), DataTableEvents::POST_RESPONSE);
+
+            return $response;
         }
 
         $resultSet = $this->getResultSet();
@@ -285,6 +314,8 @@ public function getResponse(): Response
             $response['template'] = $this->renderer->renderDataTable($this, $this->template, $this->templateParams);
         }
 
+        $this->eventDispatcher->dispatch(new DataTablePostResponseEvent($this), DataTableEvents::POST_RESPONSE);
+
         return new JsonResponse($response);
     }
 

src/DataTableEvents.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle;
+
+/**
+ * Available events.
+ *
+ * @author Jeroen van den Broek <[email protected]>
+ */
+final class DataTableEvents
+{
+    /**
+     * The PRE_RESPONSE event is dispatched right before the response
+     * is generated to allow any last-minute changes based on the table state.
+     *
+     * @Event("Omines\DataTablesBundle\Event\DataTablePreResponseEvent")
+     */
+    public const PRE_RESPONSE = 'omines_datatables.pre_response';
+
+    /**
+     * The POST_RESPONSE event is dispatched right after the response
+     * is generated but before it is returned.
+     *
+     * @Event("Omines\DataTablesBundle\Event\DataTablePostResponseEvent")
+     */
+    public const POST_RESPONSE = 'omines_datatables.post_response';
+}

src/Event/DataTableEvent.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle\Event;
+
+use Omines\DataTablesBundle\DataTable;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * DataTableEvent.
+ *
+ * @author Jeroen van den Broek <[email protected]>
+ */
+abstract class DataTableEvent extends Event
+{
+    /**
+     * DataTableEvent constructor.
+     */
+    public function __construct(
+        protected readonly DataTable $table,
+    ) {
+    }
+
+    public function getTable(): DataTable
+    {
+        return $this->table;
+    }
+}

src/Event/DataTablePostResponseEvent.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle\Event;
+
+/**
+ * DataTablePostResponseEvent.
+ *
+ * @author Jeroen van den Broek <[email protected]>
+ */
+class DataTablePostResponseEvent extends DataTableResponseEvent
+{
+}

src/Event/DataTablePreResponseEvent.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle\Event;
+
+/**
+ * DataTablePreResponseEvent.
+ *
+ * @author Jeroen van den Broek <[email protected]>
+ */
+class DataTablePreResponseEvent extends DataTableResponseEvent
+{
+}

src/Event/DataTableResponseEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle\Event;
+
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * DataTableResponseEvent.
+ *
+ * @author Jeroen van den Broek <[email protected]>
+ */
+abstract class DataTableResponseEvent extends DataTableEvent
+{
+    public function getResponse(): Response
+    {
+        return $this->table->getResponse();
+    }
+}

tests/Fixtures/AppBundle/DataTable/Type/RegularPersonTableType.php

@@ -16,7 +16,9 @@
 use Omines\DataTablesBundle\Column\DateTimeColumn;
 use Omines\DataTablesBundle\Column\TextColumn;
 use Omines\DataTablesBundle\DataTable;
+use Omines\DataTablesBundle\DataTableEvents;
 use Omines\DataTablesBundle\DataTableTypeInterface;
+use Omines\DataTablesBundle\Event\DataTablePreResponseEvent;
 
 /**
  * RegularPersonTableType.
@@ -36,6 +38,7 @@ public function configure(DataTable $dataTable, array $options): void
                 },
                 'format' => 'd-m-Y',
             ])
+            ->add('dummy', TextColumn::class, ['data' => fn () => ''])
             ->createAdapter(ArrayAdapter::class, [
                 ['firstName' => 'Donald', 'lastName' => 'Trump'],
                 ['firstName' => 'Barack', 'lastName' => 'Obama'],
@@ -49,6 +52,16 @@ public function configure(DataTable $dataTable, array $options): void
 
                 return $row;
             })
+            ->addEventListener(DataTableEvents::PRE_RESPONSE, function (DataTablePreResponseEvent $event) {
+                $table = $event->getTable();
+
+                $table
+                    ->add('email', TextColumn::class, [
+                        'data' => fn ($context) => mb_strtolower($context['lastName']) . '@example.org',
+                    ])
+                    ->remove('dummy')
+                ;
+            })
         ;
     }
 }

tests/Functional/FunctionalTest.php

@@ -81,6 +81,8 @@ public function testTypeDataTable(): void
         $this->assertSame('George W.', $json->data[0]->firstName);
         $this->assertSame('BUSH', $json->data[0]->lastName);
         $this->assertSame('01-01-2017', $json->data[0]->lastActivity);
+        $this->assertSame('[email protected]', $json->data[0]->email);
+        $this->assertObjectNotHasProperty('dummy', $json->data[0]);
 
         $json = $this->callDataTableUrl('/type?_dt=persons&draw=1&search[value]=Bush');