[DRAFT] - Filter type refactoring

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on: [ push ]
+
+jobs:
+  tests:
+    name: PHP ${{ matrix.php }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ 7.1, 7.2., 7.3, 7.4 ]
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, fileinfo, filter, gd, hash, intl, json, mbstring, pcre, pdo, zlib
+          tools: phpunit
+          coverage: none
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install the dependencies
+        run: composer install --no-interaction
+
+      - name: Run the unit tests
+        run: php vendor/bin/phpunit -c phpunit.xml.dist --colors=always
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.4
+          extensions: dom, fileinfo, filter, gd, hash, intl, json, mbstring, pcre, pdo, zlib
+          coverage: xdebug
+          tools: php-cs-fixer, phpunit
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install the dependencies
+        run: composer install --no-interaction
+
+      - name: Generate the coverage report
+        run: php vendor/bin/phpunit -c phpunit.xml.dist --coverage-clover build/logs/clover.xml
+
+      - name: Coveralls
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          composer global require php-coveralls/php-coveralls
+          php-coveralls --coverage_clover=build/logs/clover.xml -v

README.md

@@ -18,8 +18,8 @@ This bundle offers a generic filter module to use with arbitrary contao entities
 - Label/Message handling using symfony translations
 - Render form always empty (without user selection)
 - Merge data over multiple filter forms with same form name
-- Default Values (can be overwritten by user)
-- Initial Values (can`t be overwritten by user)
+- Default Values
+- Initial Values
 - Stores filter data in session (no GET parameter URL remnant)
 - Content element "Filter-Preselect" with optional redirect functionality to preselect filter on given page
 - Content element "Filter-Hyperlink" with filter preselect feature

composer.json

@@ -8,7 +8,7 @@
     "contao/core-bundle": "^4.4",
     "symfony/framework-bundle": "~3.4.26|^4.0",
     "heimrichhannot/contao-be_explanation-bundle": "^2.3",
-    "heimrichhannot/contao-utils-bundle": "^2.0",
+    "heimrichhannot/contao-utils-bundle": "^2.206",
     "heimrichhannot/contao-multi-column-editor-bundle": "^2.0",
     "heimrichhannot/contao-fieldpalette-bundle": ">=0.2 <2.0-dev",
     "heimrichhannot/contao-entity-filter-bundle": "^1.5",
@@ -17,7 +17,8 @@
     "twig/extensions": "^1.5",
     "heimrichhannot/truncate-html": "^1.0",
     "symfony/form": "~3.4|~4.0",
-    "ext-pdo": "*"
+    "ext-pdo": "*",
+    "psr/container": "^1.0 || ^2.0"
   },
   "require-dev": {
     "contao/core-bundle": "4.4.*",

phpunit.xml.dist

@@ -19,11 +19,21 @@
         <ini name="display_startup_errors" value="1"/>
         <ini name="intl.default_locale" value="en"/>
         <ini name="intl.error_level" value="0"/>
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak"/>
     </php>
 
     <testsuites>
         <testsuite name="Unit Tests">
             <directory>./tests</directory>
+            <exclude>./tests/Backend</exclude>
+            <exclude>./tests/Choice</exclude>
+            <exclude>./tests/Config</exclude>
+            <exclude>./tests/ContaoManager</exclude>
+            <exclude>./tests/DependencyInjection</exclude>
+            <exclude>./tests/Filter/Type</exclude>
+            <exclude>./tests/Model</exclude>
+            <exclude>./tests/Module</exclude>
+            <exclude>./tests/Utils</exclude>
         </testsuite>
     </testsuites>
 

src/Backend/FilterPreselect.php

@@ -14,6 +14,7 @@
 use Contao\System;
 use HeimrichHannot\FilterBundle\Filter\Type\ChoiceType;
 use HeimrichHannot\FilterBundle\Model\FilterConfigElementModel;
+use HeimrichHannot\FilterBundle\Type\AbstractFilterType;
 
 class FilterPreselect
 {
@@ -48,12 +49,12 @@ public function adjustLabel($row, $label)
         $choices = $this->prepareElementChoices((int) $row['id']);
 
         switch ($row['initialValueType']) {
-            case \HeimrichHannot\FilterBundle\Filter\AbstractType::VALUE_TYPE_SCALAR:
+            case AbstractFilterType::VALUE_TYPE_SCALAR:
                 $label = $choices[$row['initialValue']] ?? $row['initialValue'];
 
                 break;
 
-            case \HeimrichHannot\FilterBundle\Filter\AbstractType::VALUE_TYPE_ARRAY:
+            case AbstractFilterType::VALUE_TYPE_ARRAY:
                 $values = array_map(
                     function ($item) {
                         return $item['value'] ?? null;
@@ -65,8 +66,8 @@ function ($item) {
 
                 break;
 
-            case \HeimrichHannot\FilterBundle\Filter\AbstractType::VALUE_TYPE_CONTEXTUAL:
-                $label = \HeimrichHannot\FilterBundle\Filter\AbstractType::VALUE_TYPE_CONTEXTUAL;
+            case AbstractFilterType::VALUE_TYPE_CONTEXTUAL:
+                $label = AbstractFilterType::VALUE_TYPE_CONTEXTUAL;
         }
 
         return sprintf('%s -> %s [ID: %s]', $filterConfigElement->title, $label, $filterConfigElement->id);

src/Choice/DateChoice.php

@@ -151,7 +151,7 @@ protected function collect()
             $dates[$translatedDate] = $translatedDate;
         }
 
-        krsort($dates, SORT_NUMERIC);
+        krsort($dates, \SORT_NUMERIC);
 
         return $dates;
     }

src/Choice/FieldOptionsChoice.php

@@ -14,6 +14,7 @@
 use Contao\Widget;
 use Doctrine\DBAL\FetchMode;
 use HeimrichHannot\FilterBundle\Model\FilterConfigElementModel;
+use HeimrichHannot\FilterBundle\Type\FilterTypeCollection;
 use HeimrichHannot\UtilsBundle\Choice\AbstractChoice;
 use HeimrichHannot\UtilsBundle\Model\ModelUtil;
 use Symfony\Component\Translation\Translator;
@@ -118,7 +119,7 @@ protected function getCustomOptions(FilterConfigElementModel $element, array $fi
 
         $options = StringUtil::deserialize($element->options, true);
 
-        return $options;
+        return $this->adjustOptionLabels($element, $filter, $options);
     }
 
     /**
@@ -129,7 +130,6 @@ protected function getCustomOptions(FilterConfigElementModel $element, array $fi
     protected function getDcaOptions(FilterConfigElementModel $element, array $filter, array $dca)
     {
         $options = [];
-        $dca = $GLOBALS['TL_DCA'][$filter['dataContainer']]['fields'][$element->field];
 
         if (isset($dca['eval']['isCategoryField']) && $dca['eval']['isCategoryField']) {
             if (isset($dca['options_callback'])) {
@@ -144,10 +144,6 @@ protected function getDcaOptions(FilterConfigElementModel $element, array $filte
             return $options;
         }
 
-        if (!isset($dca['inputType'])) {
-            return $options;
-        }
-
         switch ($dca['inputType']) {
             case 'cfgTags':
                 if (!isset($dca['eval']['tagsManager'])) {
@@ -173,6 +169,13 @@ protected function getWidgetOptions(FilterConfigElementModel $element, array $fi
     {
         $options = [];
 
+        $filterTypeCollection = System::getContainer()->get(FilterTypeCollection::class);
+
+        // fix for new filter types to show possible choices if inputType dca attribute is not given
+        if ($filterTypeCollection->hasType($element->type)) {
+            $dca['inputType'] = $element->inputType;
+        }
+
         if (!isset($GLOBALS['TL_FFL'][$dca['inputType']]) && (System::getContainer()->get('huh.utils.container')->isBackend() && !isset($GLOBALS['BE_FFL'][$dca['inputType']]))) {
             return $options;
         }
@@ -255,45 +258,7 @@ protected function getWidgetOptions(FilterConfigElementModel $element, array $fi
             }
         }
 
-        if (!empty($options) && true === (bool) $element->adjustOptionLabels && !empty($element->optionLabelPattern)) {
-            if (null !== ($filterQueryBuilder = System::getContainer()->get('huh.filter.manager')->getQueryBuilder($filter['id'], [$element->id]))) {
-                $filterQueryBuilder->select([$filter['dataContainer'].'.'.$element->field, $filter['dataContainer'].'.*']);
-                $filterQueryBuilder->orderBy($element->field);
-                $rows = $filterQueryBuilder->execute()->fetchAll();
-
-                $data = [];
-
-                foreach ($rows as $row) {
-                    $currentValue = $row[$element->field];
-
-                    if (isset($data[$currentValue])) {
-                        ++$data[$currentValue]['count'];
-
-                        continue;
-                    }
-
-                    $data[$currentValue] = ['data' => $row, 'count' => 1];
-                }
-
-                foreach ($options as $key => &$option) {
-                    if (!isset($option['label']) || !isset($rows[$option['value']])) {
-                        continue;
-                    }
-
-                    $params = $data[$option['value']];
-                    $params['label'] = $option['label'];
-
-                    foreach ($params as $key => $value) {
-                        unset($params[$key]);
-                        $params['%'.$key.'%'] = $value;
-                    }
-
-                    $option['label'] = System::getContainer()->get('translator')->trans($element->optionLabelPattern, $params);
-                }
-            }
-        }
-
-        return $options;
+        return $this->adjustOptionLabels($element, $filter, $options);
     }
 
     /**
@@ -367,4 +332,51 @@ protected function getGroupChoicesValue(array $choices, FilterConfigElementModel
 
         return implode(',', $choices);
     }
+
+    private function adjustOptionLabels(FilterConfigElementModel $element, array $filter, array $options): array
+    {
+        if (!empty($options) && true === (bool) $element->adjustOptionLabels && !empty($element->optionLabelPattern)) {
+            if (null !== ($filterQueryBuilder = System::getContainer()->get('huh.filter.manager')->getQueryBuilder($filter['id'], [$element->id]))) {
+                $filterQueryBuilder->select([$filter['dataContainer'].'.'.$element->field, $filter['dataContainer'].'.*']);
+                $filterQueryBuilder->orderBy($element->field);
+                $rows = $filterQueryBuilder->execute()->fetchAll();
+
+                $data = [];
+
+                foreach ($rows as $row) {
+                    $currentValue = $row[$element->field];
+
+                    if (isset($data[$currentValue])) {
+                        ++$data[$currentValue]['count'];
+
+                        continue;
+                    }
+
+                    $data[$currentValue] = ['data' => $row, 'count' => 1];
+                }
+
+                foreach ($options as &$option) {
+                    if (!isset($option['label']) || !isset($rows[$option['value']])) {
+                        continue;
+                    }
+
+                    $params = $data[$option['value']];
+                    $params['label'] = $option['label'];
+
+                    foreach ($params as $key => $value) {
+                        unset($params[$key]);
+                        $params['%'.$key.'%'] = $value;
+                    }
+
+                    if (!$params['%count%']) {
+                        $params['%count%'] = 0;
+                    }
+
+                    $option['label'] = System::getContainer()->get('translator')->trans($element->optionLabelPattern, $params);
+                }
+            }
+        }
+
+        return $options;
+    }
 }