Fix compatibility issues with Symfony 5.x

Author: curry684

CHANGELOG.md

@@ -9,6 +9,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
  - Drop Symfony 3.x compatibility
  - Drop PHP <7.2 compatibility
 
+### Deprecated
+ - DataTablesTrait should be dropped in favor of injection
+
 ## [0.3.1] - 2019-08-09
 ### Added
  - Update the url used for ajax request on each init. (#75)

README.md

@@ -9,7 +9,7 @@
 [![SensioLabs Insight](https://img.shields.io/sensiolabs/i/05d79ba2-cba4-4201-a17a-2868c51f9c6c.svg)](https://insight.sensiolabs.com/projects/05d79ba2-cba4-4201-a17a-2868c51f9c6c)
 
 This bundle provides convenient integration of the popular [DataTables](https://datatables.net/) jQuery library
-for realtime Ajax tables in your [Symfony](https://symfony.com/) 3.4+ or 4.1+ application.
+for realtime Ajax tables in your [Symfony](https://symfony.com/) 4.1+ or 5.0+ application.
 
 Unlike other bundles providing similar functionality we decoupled the implementation of the DataTables logic
 completely from the source of the data. Therefore it is possible to implement your own custom adapters for

composer.json

@@ -32,7 +32,7 @@
         "doctrine/orm": "^2.5",
         "friendsofphp/php-cs-fixer": "^2.7",
         "mongodb/mongodb": "^1.2",
-        "phpunit/phpunit": "^7.1|^8.0",
+        "phpunit/phpunit": "^7.1",
         "ruflin/elastica": "^6.0|^7.0",
         "symfony/browser-kit": "^4.1|^5.0",
         "symfony/css-selector": "^4.1|^5.0",

src/Adapter/Doctrine/Event/ORMAdapterQueryEvent.php

@@ -13,7 +13,7 @@
 namespace Omines\DataTablesBundle\Adapter\Doctrine\Event;
 
 use Doctrine\ORM\Query;
-use Symfony\Component\EventDispatcher\Event;
+use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * @author Maxime Pinot <[email protected]>

src/Adapter/Doctrine/ORMAdapter.php

@@ -190,7 +190,7 @@ protected function getResults(AdapterQuery $query): \Traversable
 
         $query = $builder->getQuery();
         $event = new ORMAdapterQueryEvent($query);
-        $state->getDataTable()->getEventDispatcher()->dispatch(ORMAdapterEvents::PRE_QUERY, $event);
+        $state->getDataTable()->getEventDispatcher()->dispatch($event, ORMAdapterEvents::PRE_QUERY);
 
         foreach ($query->iterate([], $this->hydrationMode) as $result) {
             yield $entity = array_values($result)[0];

src/Column/TwigColumn.php

@@ -14,7 +14,7 @@
 
 use Omines\DataTablesBundle\Exception\MissingDependencyException;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use Twig_Environment;
+use Twig\Environment;
 
 /**
  * TwigColumn.
@@ -23,13 +23,13 @@
  */
 class TwigColumn extends AbstractColumn
 {
-    /** @var Twig_Environment */
+    /** @var Environment */
     private $twig;
 
     /**
      * TwigColumn constructor.
      */
-    public function __construct(Twig_Environment $twig = null)
+    public function __construct(Environment $twig = null)
     {
         if (null === ($this->twig = $twig)) {
             throw new MissingDependencyException('You must have TwigBundle installed to use ' . self::class);

src/Controller/DataTablesTrait.php

@@ -22,6 +22,8 @@
  * @author Niels Keurentjes <[email protected]>
  *
  * @property ContainerInterface $container
+ *
+ * @deprecated inject the DataTableFactory in your controllers or actions instead
  */
 trait DataTablesTrait
 {

tests/Fixtures/AppBundle/Controller/CustomQueryController.php

@@ -12,7 +12,7 @@
 
 namespace Tests\Fixtures\AppBundle\Controller;
 
-use Omines\DataTablesBundle\Controller\DataTablesTrait;
+use Omines\DataTablesBundle\DataTableFactory;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -25,11 +25,9 @@
  */
 class CustomQueryController extends AbstractController
 {
-    use DataTablesTrait;
-
-    public function tableAction(Request $request)
+    public function tableAction(Request $request, DataTableFactory $dataTableFactory)
     {
-        $datatable = $this->createDataTableFromType(CustomQueryTableType::class)
+        $datatable = $dataTableFactory->createFromType(CustomQueryTableType::class)
             ->setMethod(Request::METHOD_GET);
         if ($datatable->handleRequest($request)->isCallback()) {
             return $datatable->getResponse();

tests/Fixtures/AppBundle/Controller/GroupedController.php

@@ -12,7 +12,7 @@
 
 namespace Tests\Fixtures\AppBundle\Controller;
 
-use Omines\DataTablesBundle\Controller\DataTablesTrait;
+use Omines\DataTablesBundle\DataTableFactory;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Tests\Fixtures\AppBundle\DataTable\Type\Grouped2TableType;
@@ -25,21 +25,19 @@
  */
 class GroupedController extends AbstractController
 {
-    use DataTablesTrait;
-
-    public function tableAction(Request $request)
+    public function tableAction(Request $request, DataTableFactory $dataTableFactory)
     {
-        $datatable = $this->createDataTableFromType(GroupedTableType::class)
+        $datatable = $dataTableFactory->createFromType(GroupedTableType::class)
             ->setName('companies')
             ->setMethod(Request::METHOD_GET)
         ;
 
         return $datatable->handleRequest($request)->getResponse();
     }
 
-    public function table2Action(Request $request)
+    public function table2Action(Request $request, DataTableFactory $dataTableFactory)
     {
-        $datatable = $this->createDataTableFromType(Grouped2TableType::class)
+        $datatable = $dataTableFactory->createFromType(Grouped2TableType::class)
             ->setName('companies2')
             ->setMethod(Request::METHOD_GET)
         ;

tests/Fixtures/AppBundle/Controller/HomeController.php

@@ -14,7 +14,7 @@
 
 use Omines\DataTablesBundle\Adapter\ArrayAdapter;
 use Omines\DataTablesBundle\Column\TextColumn;
-use Omines\DataTablesBundle\Controller\DataTablesTrait;
+use Omines\DataTablesBundle\DataTableFactory;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -25,9 +25,7 @@
  */
 class HomeController extends AbstractController
 {
-    use DataTablesTrait;
-
-    public function showAction(Request $request)
+    public function showAction(Request $request, DataTableFactory $dataTableFactory)
     {
         $datatable1 = $this->createDataTable();
         $datatable1