Add DataTable Events (#76)

* Add DataTable Events

* Add Events in the documentation

* Fix test error with Symfony ^3.4

* Resolve requested changes

Author: MaximePinot

docs/source/index.html.md

@@ -300,6 +300,28 @@ Note that implementing your own criteria overrides the default, meaning searchin
 longer work automatically. Add the `SearchCriteriaProvider` manually to combine the default behavior
 with your own implementation.
 
+### Events
+
+```php?start_inline=1
+$table->createAdapter(ORMAdapter::class, [
+    'entity' => Employee::class,
+    'query' => function (QueryBuilder $builder) {
+        $builder
+            ->select('e')
+            ->addSelect('c')
+            ->from(Employee::class, 'e')
+            ->leftJoin('e.company', 'c')
+        ;
+    },
+]);
+
+$table->addEventListener(ORMAdapterEvents::PRE_QUERY, function(ORMAdapterQueryEvent $event) {
+    $event->getQuery()->useResultCache(true)->useQueryCache(true);
+});
+```
+The `PRE_QUERY` event is dispatched after the QueryBuilder built the Query
+and before the iteration starts. It can be useful to configure the cache.
+
 ## Elastica
 
 ```php?start_inline=1

src/Adapter/Doctrine/Event/ORMAdapterQueryEvent.php

@@ -0,0 +1,43 @@
+<?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\Adapter\Doctrine\Event;
+
+use Doctrine\ORM\Query;
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * @author Maxime Pinot <[email protected]>
+ */
+class ORMAdapterQueryEvent extends Event
+{
+    /** @var Query */
+    protected $query;
+
+    /**
+     * ORMAdapterQueryEvent constructor.
+     *
+     * @param Query $query
+     */
+    public function __construct(Query $query)
+    {
+        $this->query = $query;
+    }
+
+    /**
+     * @return Query
+     */
+    public function getQuery(): Query
+    {
+        return $this->query;
+    }
+}

src/Adapter/Doctrine/ORMAdapter.php

@@ -17,6 +17,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Omines\DataTablesBundle\Adapter\AbstractAdapter;
 use Omines\DataTablesBundle\Adapter\AdapterQuery;
+use Omines\DataTablesBundle\Adapter\Doctrine\Event\ORMAdapterQueryEvent;
 use Omines\DataTablesBundle\Adapter\Doctrine\ORM\AutomaticQueryBuilder;
 use Omines\DataTablesBundle\Adapter\Doctrine\ORM\QueryBuilderProcessorInterface;
 use Omines\DataTablesBundle\Adapter\Doctrine\ORM\SearchCriteriaProvider;
@@ -151,10 +152,10 @@ protected function getAliases(AdapterQuery $query)
         foreach ($builder->getDQLPart('join') as $joins) {
             /** @var Query\Expr\Join $join */
             foreach ($joins as $join) {
-                if(strstr($join->getJoin(), '.') === false){
+                if (false === mb_strstr($join->getJoin(), '.')) {
                     continue;
-                }       
-                
+                }
+
                 list($origin, $target) = explode('.', $join->getJoin());
 
                 $mapping = $aliases[$origin][1]->getAssociationMapping($target);
@@ -197,8 +198,11 @@ protected function getResults(AdapterQuery $query): \Traversable
             ;
         }
 
-        //!$this->query->getHint(self::HINT_DISTINCT) || isset($this->selectedClasses[$joinedDqlAlias])
-        foreach ($builder->getQuery()->iterate([], $this->hydrationMode) as $result) {
+        $query = $builder->getQuery();
+        $event = new ORMAdapterQueryEvent($query);
+        $state->getDataTable()->getEventDispatcher()->dispatch(ORMAdapterEvents::PRE_QUERY, $event);
+
+        foreach ($query->iterate([], $this->hydrationMode) as $result) {
             yield $entity = array_values($result)[0];
             if (Query::HYDRATE_OBJECT === $this->hydrationMode) {
                 $this->manager->detach($entity);

src/Adapter/Doctrine/ORMAdapterEvents.php

@@ -0,0 +1,31 @@
+<?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\Adapter\Doctrine;
+
+/**
+ * Available events.
+ *
+ * @author Maxime Pinot <[email protected]>
+ */
+final class ORMAdapterEvents
+{
+    /**
+     * The PRE_QUERY event is dispatched after the QueryBuilder
+     * built the Query and before the iteration starts.
+     *
+     * It can be useful to configure the cache.
+     *
+     * @Event("Omines\DataTablesBundle\Adapter\Doctrine\Event\ORMAdapterQueryEvent")
+     */
+    const PRE_QUERY = 'omines_datatables.ormadapter.pre_query';
+}

src/DataTable.php

@@ -19,6 +19,7 @@
 use Omines\DataTablesBundle\Exception\InvalidArgumentException;
 use Omines\DataTablesBundle\Exception\InvalidConfigurationException;
 use Omines\DataTablesBundle\Exception\InvalidStateException;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -65,6 +66,9 @@ class DataTable
     /** @var array<string, AbstractColumn> */
     protected $columnsByName = [];
 
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+
     /** @var string */
     protected $method = Request::METHOD_POST;
 
@@ -104,11 +108,14 @@ class DataTable
     /**
      * DataTable constructor.
      *
+     * @param EventDispatcherInterface $eventDispatcher
      * @param array $options
      * @param Instantiator|null $instantiator
      */
-    public function __construct(array $options = [], Instantiator $instantiator = null)
+    public function __construct(EventDispatcherInterface $eventDispatcher, array $options = [], Instantiator $instantiator = null)
     {
+        $this->eventDispatcher = $eventDispatcher;
+
         $this->instantiator = $instantiator ?? new Instantiator();
 
         $resolver = new OptionsResolver();
@@ -138,6 +145,24 @@ public function add(string $name, string $type, array $options = [])
         return $this;
     }
 
+    /**
+     * Adds an event listener to an event on this DataTable.
+     *
+     * @param string   $eventName The name of the event to listen to
+     * @param callable $listener  The listener to execute
+     * @param int      $priority  The priority of the listener. Listeners
+     *                            with a higher priority are called before
+     *                            listeners with a lower priority.
+     *
+     * @return $this
+     */
+    public function addEventListener(string $eventName, callable $listener, int $priority = 0): self
+    {
+        $this->eventDispatcher->addListener($eventName, $listener, $priority);
+
+        return $this;
+    }
+
     /**
      * @param int|string|AbstractColumn $column
      * @param string $direction
@@ -204,6 +229,14 @@ public function getColumns(): array
         return $this->columns;
     }
 
+    /**
+     * @return EventDispatcherInterface
+     */
+    public function getEventDispatcher(): EventDispatcherInterface
+    {
+        return $this->eventDispatcher;
+    }
+
     /**
      * @return bool
      */

src/DataTableFactory.php

@@ -13,6 +13,7 @@
 namespace Omines\DataTablesBundle;
 
 use Omines\DataTablesBundle\DependencyInjection\Instantiator;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 
 class DataTableFactory
@@ -29,17 +30,23 @@ class DataTableFactory
     /** @var array */
     protected $config;
 
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+
     /**
      * DataTableFactory constructor.
      *
      * @param array $config
      * @param DataTableRendererInterface $renderer
+     * @param Instantiator $instantiator
+     * @param EventDispatcherInterface $eventDispatcher
      */
-    public function __construct(array $config, DataTableRendererInterface $renderer, Instantiator $instantiator)
+    public function __construct(array $config, DataTableRendererInterface $renderer, Instantiator $instantiator, EventDispatcherInterface $eventDispatcher)
     {
         $this->config = $config;
         $this->renderer = $renderer;
         $this->instantiator = $instantiator;
+        $this->eventDispatcher = $eventDispatcher;
     }
 
     /**
@@ -50,7 +57,7 @@ public function create(array $options = [])
     {
         $config = $this->config;
 
-        return (new DataTable(array_merge($config['options'] ?? [], $options), $this->instantiator))
+        return (new DataTable($this->eventDispatcher, array_merge($config['options'] ?? [], $options), $this->instantiator))
             ->setRenderer($this->renderer)
             ->setMethod($config['method'] ?? Request::METHOD_POST)
             ->setPersistState($config['persist_state'] ?? 'fragment')

src/Resources/config/services.xml

@@ -23,6 +23,7 @@
             <argument>%datatables.config%</argument>
             <argument type="service" id="datatables.renderer" />
             <argument type="service" id="Omines\DataTablesBundle\DependencyInjection\Instantiator" />
+            <argument type="service" id="event_dispatcher" />
         </service>
 
         <!-- Support services -->

tests/Fixtures/AppBundle/Controller/ORMAdapterEventsController.php

@@ -0,0 +1,49 @@
+<?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 Tests\Fixtures\AppBundle\Controller;
+
+use Omines\DataTablesBundle\Adapter\Doctrine\Event\ORMAdapterQueryEvent;
+use Omines\DataTablesBundle\Adapter\Doctrine\ORMAdapter;
+use Omines\DataTablesBundle\Adapter\Doctrine\ORMAdapterEvents;
+use Omines\DataTablesBundle\Column\TextColumn;
+use Omines\DataTablesBundle\Controller\DataTablesTrait;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Tests\Fixtures\AppBundle\Entity\Employee;
+
+/**
+ * @author Maxime Pinot <[email protected]>
+ */
+class ORMAdapterEventsController extends AbstractController
+{
+    const PRE_QUERY_RESULT_CACHE_ID = 'datatable_result_cache';
+
+    use DataTablesTrait;
+
+    public function preQueryAction(Request $request): Response
+    {
+        $datatable = $this->createDataTable()
+            ->add('firstName', TextColumn::class)
+            ->add('lastName', TextColumn::class)
+            ->add('company', TextColumn::class, ['field' => 'company.name'])
+            ->createAdapter(ORMAdapter::class, [
+                'entity' => Employee::class,
+            ])
+            ->addEventListener(ORMAdapterEvents::PRE_QUERY, function (ORMAdapterQueryEvent $event) {
+                $event->getQuery()->useResultCache(true, 0, self::PRE_QUERY_RESULT_CACHE_ID);
+            });
+
+        return $datatable->handleRequest($request)->getResponse();
+    }
+}

tests/Fixtures/config.yml

@@ -13,6 +13,12 @@ framework:
     test: ~
     profiler:
         collect: false
+    cache:
+        pools:
+            doctrine.result_cache_pool:
+                adapter: cache.app
+            doctrine.system_cache_pool:
+                adapter: cache.system
 
 doctrine:
     dbal:
@@ -23,6 +29,15 @@ doctrine:
         auto_generate_proxy_classes: '%kernel.debug%'
         naming_strategy: doctrine.orm.naming_strategy.underscore
         auto_mapping: true
+        metadata_cache_driver:
+            type: service
+            id: doctrine.system_cache_provider
+        query_cache_driver:
+            type: service
+            id: doctrine.system_cache_provider
+        result_cache_driver:
+            type: service
+            id: doctrine.result_cache_provider
 
 twig:
     debug: '%kernel.debug%'

tests/Fixtures/routing.yml

@@ -29,3 +29,6 @@ grouped2:
 employee.edit:
     path:       /employee/{id}
 
+orm_adapter_events.pre_query:
+    path: /orm-adapter-events/pre-query
+    controller: Tests\Fixtures\AppBundle\Controller\ORMAdapterEventsController::preQueryAction