B3 it twig3.1 (#1079)

* ~ twig to 3.0 * Update Tests for Twig 3.0 stuff * add 7.4 to travis tests * interface compatibility --------- Co-authored-by: Hans Mackowiak <h.mackowiak@b3-it.de>
APY · Feb 10, 2023 · 583cd0b · 583cd0b
1 parent cb28229
commit 583cd0b
Show file tree

Hide file tree

Showing 14 changed files with 154 additions and 117 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -3,6 +3,7 @@ language: php
 php:
   - 7.2
   - 7.3
+  - 7.4
 
 matrix:
   include:
@@ -12,13 +13,19 @@ matrix:
     - php: 7.2
       env: |
         SYMFONY_VERSION=^4.0
+    - php: 7.4
+      env: |
+        SYMFONY_VERSION=^3.0
+    - php: 7.4
+      env: |
+        SYMFONY_VERSION=^4.0
 
 before_install:
   - echo "extension = mongodb.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
   - |
     if [ "${SYMFONY_VERSION}" != "" ]; then
       packages="form dependency-injection config http-foundation http-kernel options-resolver security-guard serializer"
-      devpackages="framework-bundle browser-kit templating expression-language"
+      devpackages="framework-bundle security-bundle twig-bundle expression-language"
       for package in $packages
         do
           composer require --no-update symfony/"$package"=${SYMFONY_VERSION};

diff --git a/Grid/Export/DSVExport.php b/Grid/Export/DSVExport.php
@@ -33,7 +33,7 @@ public function __construct($title, $fileName = 'export', $params = [], $charset
         parent::__construct($title, $fileName, $params, $charset);
     }
 
-    public function computeData($grid)
+    public function computeData(Grid $grid)
     {
         $data = $this->getFlatGridData($grid);
 

diff --git a/Grid/Export/ExcelExport.php b/Grid/Export/ExcelExport.php
@@ -21,7 +21,7 @@ class ExcelExport extends Export
 
     protected $mimeType = 'application/vnd.ms-excel';
 
-    public function computeData($grid)
+    public function computeData(Grid $grid)
     {
         $data = $this->getGridData($grid);
 

diff --git a/Grid/Export/Export.php b/Grid/Export/Export.php
@@ -98,7 +98,7 @@ public function getContainer()
      *
      * @return Response
      */
-    public function getResponse()
+    public function getResponse() : \Symfony\Component\HttpFoundation\Response
     {
         // Response
         $kernelCharset = $this->container->getParameter('kernel.charset');
@@ -512,7 +512,7 @@ public function setTitle($title)
      *
      * @return string
      */
-    public function getTitle()
+    public function getTitle() : string
     {
         return $this->title;
     }

diff --git a/Grid/Export/ExportInterface.php b/Grid/Export/ExportInterface.php
@@ -12,28 +12,31 @@
 
 namespace APY\DataGridBundle\Grid\Export;
 
+use APY\DataGridBundle\Grid\Grid;
+use Symfony\Component\HttpFoundation\Response;
+
 interface ExportInterface
 {
     /**
      * function call by the grid to fill the content of the export.
      *
      * @param Grid $grid The grid
      */
-    public function computeData($grid);
+    public function computeData(Grid $grid);
 
     /**
      * Get the export Response.
      *
      * @return Response
      */
-    public function getResponse();
+    public function getResponse(): Response;
 
     /**
      * Get the export title.
      *
      * @return string
      */
-    public function getTitle();
+    public function getTitle(): string;
 
     /**
      * Get the export role.

diff --git a/Grid/Export/JSONExport.php b/Grid/Export/JSONExport.php
@@ -19,7 +19,7 @@ class JSONExport extends Export
 {
     protected $fileExtension = 'json';
 
-    public function computeData($grid)
+    public function computeData(Grid $grid)
     {
         $this->content = json_encode($this->getGridData($grid));
     }

diff --git a/Grid/Export/PHPExcel5Export.php b/Grid/Export/PHPExcel5Export.php
@@ -31,7 +31,7 @@ public function __construct($tilte, $fileName = 'export', $params = [], $charset
         parent::__construct($tilte, $fileName, $params, $charset);
     }
 
-    public function computeData($grid)
+    public function computeData(Grid $grid)
     {
         $data = $this->getFlatGridData($grid);
 

diff --git a/Grid/Export/XMLExport.php b/Grid/Export/XMLExport.php
@@ -25,7 +25,7 @@ class XMLExport extends Export
 
     protected $mimeType = 'application/xml';
 
-    public function computeData($grid)
+    public function computeData(Grid $grid)
     {
         $xmlEncoder = new XmlEncoder();
         $xmlEncoder->setRootNodeName('grid');

diff --git a/Grid/Grid.php b/Grid/Grid.php
@@ -18,6 +18,7 @@
 use APY\DataGridBundle\Grid\Column\ActionsColumn;
 use APY\DataGridBundle\Grid\Column\Column;
 use APY\DataGridBundle\Grid\Column\MassActionColumn;
+use APY\DataGridBundle\Grid\Export\Export;
 use APY\DataGridBundle\Grid\Export\ExportInterface;
 use APY\DataGridBundle\Grid\Source\Entity;
 use APY\DataGridBundle\Grid\Source\Source;
@@ -334,6 +335,11 @@ public function __construct($container, $id = '', GridConfigInterface $config =
 
         $this->id = $id;
 
+        // even id is set, do create hash early
+        if (!empty($this->id)) {
+            $this->createHash();
+        }
+
         $this->columns = new Columns($this->securityContext);
 
         $this->routeParameters = $this->request->attributes->all();
@@ -1100,6 +1106,7 @@ protected function getFromRequest($key)
         if (isset($this->requestData[$key])) {
             return $this->requestData[$key];
         }
+        return null;
     }
 
     /**
@@ -1114,6 +1121,7 @@ protected function get($key)
         if (isset($this->sessionData[$key])) {
             return $this->sessionData[$key];
         }
+        return null;
     }
 
     /**
@@ -1394,7 +1402,7 @@ public function getRowActions()
     /**
      * Sets template for export.
      *
-     * @param \Twig_Template|string $template
+     * @param TemplateWrapper|string $template
      *
      * @throws \Exception
      *
@@ -1418,7 +1426,7 @@ public function setTemplate($template)
     /**
      * Returns template.
      *
-     * @return \Twig_Template|string
+     * @return string
      */
     public function getTemplate()
     {
@@ -1454,19 +1462,19 @@ public function getExports()
     /**
      * Returns the export response.
      *
-     * @return Export[]
+     * @return Response
      */
-    public function getExportResponse()
+    public function getExportResponse(): Response
     {
         return $this->exportResponse;
     }
 
     /**
      * Returns the mass action response.
      *
-     * @return Export[]
+     * @return Response
      */
-    public function getMassActionResponse()
+    public function getMassActionResponse(): Response
     {
         return $this->massActionResponse;
     }
@@ -2124,7 +2132,7 @@ public function __clone()
      * @param string|array $param2   The view name or an array of parameters to pass to the view
      * @param Response     $response A response instance
      *
-     * @return Response A Response instance
+     * @return Response|array A Response instance
      */
     public function getGridResponse($param1 = null, $param2 = null, Response $response = null)
     {
@@ -2154,7 +2162,15 @@ public function getGridResponse($param1 = null, $param2 = null, Response $respon
             if ($view === null) {
                 return $parameters;
             } else {
-                return new Response($this->container->get('twig')->render($view, $parameters, $response));
+                $content = $this->container->get('twig')->render($view, $parameters);
+
+                if (null === $response) {
+                    $response = new Response();
+                }
+
+                $response->setContent($content);
+
+                return $response;
             }
         }
     }

diff --git a/Grid/GridManager.php b/Grid/GridManager.php
@@ -12,10 +12,14 @@
 
 namespace APY\DataGridBundle\Grid;
 
+use Countable;
+use IteratorAggregate;
+use RuntimeException;
+use SplObjectStorage;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Response;
 
-class GridManager implements \IteratorAggregate, \Countable
+class GridManager implements IteratorAggregate, Countable
 {
     protected $container;
 
@@ -34,15 +38,15 @@ class GridManager implements \IteratorAggregate, \Countable
     public function __construct($container)
     {
         $this->container = $container;
-        $this->grids = new \SplObjectStorage();
+        $this->grids = new SplObjectStorage();
     }
 
     public function getIterator()
     {
         return $this->grids;
     }
 
-    public function count()
+    public function count(): int
     {
         return $this->grids->count();
     }
@@ -52,7 +56,7 @@ public function count()
      *
      * @return Grid
      */
-    public function createGrid($id = null)
+    public function createGrid($id = null): Grid
     {
         $grid = $this->container->get('grid');
 
@@ -65,10 +69,10 @@ public function createGrid($id = null)
         return $grid;
     }
 
-    public function isReadyForRedirect()
+    public function isReadyForRedirect(): bool
     {
         if ($this->grids->count() == 0) {
-            throw new \RuntimeException(self::NO_GRID_EX_MSG);
+            throw new RuntimeException(self::NO_GRID_EX_MSG);
         }
 
         $checkHash = [];
@@ -90,7 +94,7 @@ public function isReadyForRedirect()
             }
 
             if (in_array($grid->getHash(), $checkHash)) {
-                throw new \RuntimeException(self::SAME_GRID_HASH_EX_MSG);
+                throw new RuntimeException(self::SAME_GRID_HASH_EX_MSG);
             }
 
             $checkHash[] = $grid->getHash();
@@ -101,10 +105,10 @@ public function isReadyForRedirect()
         return $isReadyForRedirect;
     }
 
-    public function isReadyForExport()
+    public function isReadyForExport(): bool
     {
         if ($this->grids->count() == 0) {
-            throw new \RuntimeException(self::NO_GRID_EX_MSG);
+            throw new RuntimeException(self::NO_GRID_EX_MSG);
         }
 
         $checkHash = [];
@@ -114,7 +118,7 @@ public function isReadyForExport()
             $grid = $this->grids->current();
 
             if (in_array($grid->getHash(), $checkHash)) {
-                throw new \RuntimeException(self::SAME_GRID_HASH_EX_MSG);
+                throw new RuntimeException(self::SAME_GRID_HASH_EX_MSG);
             }
 
             $checkHash[] = $grid->getHash();
@@ -131,7 +135,7 @@ public function isReadyForExport()
         return false;
     }
 
-    public function isMassActionRedirect()
+    public function isMassActionRedirect(): bool
     {
         $this->grids->rewind();
         while ($this->grids->valid()) {
@@ -152,11 +156,11 @@ public function isMassActionRedirect()
     /**
      * Renders a view.
      *
-     * @param string|array $param1   The view name or an array of parameters to pass to the view
-     * @param string|array $param2   The view name or an array of parameters to pass to the view
-     * @param Response     $response A response instance
+     * @param string|array  $param1   The view name or an array of parameters to pass to the view
+     * @param string|array  $param2   The view name or an array of parameters to pass to the view
+     * @param Response|null $response A response instance
      *
-     * @return Response A Response instance
+     * @return Response|array A Response instance
      */
     public function getGridManagerResponse($param1 = null, $param2 = null, Response $response = null)
     {

diff --git a/Grid/GridRegistryInterface.php b/Grid/GridRegistryInterface.php
@@ -3,6 +3,8 @@
 namespace APY\DataGridBundle\Grid;
 
 use APY\DataGridBundle\Grid\Column\Column;
+use APY\DataGridBundle\Grid\Export\Export;
+use APY\DataGridBundle\Grid\Source\Source;
 
 /**
  * The central registry of the Grid component.