Merge branch 'master' into natural-keys

lexik · Mar 7, 2022 · aa2a8d2 · aa2a8d2
2 parents cf2d669 + ecea502
commit aa2a8d2
Show file tree

Hide file tree

Showing 41 changed files with 216 additions and 148 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,9 +1,9 @@
-.gitignore        export-ignore
-.php_cs           export-ignore
-.travis.yml       export-ignore
-autoload.php.dist export-ignore
-composer.json     export-ignore
-phpunit.xml.dist  export-ignore
-README.md         export-ignore
-Tests/            export-ignore
-UPGRADE*.md       export-ignore
+* text=auto
+
+/.github           export-ignore
+/Tests             export-ignore
+/.gitattributes    export-ignore
+/.gitignore        export-ignore
+/.php_cs           export-ignore
+/autoload.php.dist export-ignore
+/phpunit.xml.dist  export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,64 @@
+name: "CI Tests"
+
+on:
+  pull_request:
+  push:
+
+env:
+  fail-fast: true
+  PHPUNIT_FLAGS: "-v"
+  SYMFONY_DEPRECATIONS_HELPER: 40
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: PHP v${{ matrix.php }}, Symfony v${{ matrix.symfony }}} with Mongo v${{ matrix.mongodb }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { php: 7.3, mongodb: 3.6, symfony: "4.4.*", composer-flags: '--prefer-stable'}
+          - { php: 7.4, mongodb: 3.6, symfony: "5.4.*", composer-flags: '--prefer-stable'}
+          - { php: 8.0, mongodb: 3.6, symfony: "5.4.*", composer-flags: '--prefer-stable'}
+          - { php: 8.0, mongodb: 3.6, symfony: "6.0.*", composer-flags: '--prefer-stable'}
+          - { php: 8.1, mongodb: 3.6, symfony: "6.1.*@dev", composer-flags: '' }
+    services:
+      mongo:
+        image: mongo:${{ matrix.mongodb }}
+        ports:
+          - 27017:27017
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: "Installing php"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl,mbstring,xdebug,mongodb
+          ini-values: date.timezone="Europe/Paris"
+          coverage: xdebug
+          tools: composer
+      - name: Show PHP version
+        run: php -v && composer -V
+      - name: Download Composer cache dependencies from cache
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+      - name: Install Symfony ${{ matrix.symfony }}
+        run: composer require symfony/symfony:${{ matrix.symfony }} --no-update
+      - name: "Require symfony/messenger"
+        run: "composer require --dev symfony/doctrine-messenger --no-update"
+        if: "${{ startsWith(matrix.symfony, '5.3') || startsWith(matrix.symfony, '5.4') }}"
+      - name: Cache Composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ matrix.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ matrix.os }}-composer-
+      - name: Install dependencies
+        run: |
+          perl -pi -e 's/^}$/,"minimum-stability":"dev"}/' composer.json
+          composer config platform.ext-mongo 1.6.16
+          composer require alcaeus/mongo-php-adapter --no-update
+          composer update ${{ matrix.composer-flags }} --prefer-dist
+      - name: "Run PHPUnit Tests"
+        run: "composer test"
diff --git a/.travis.yml b/.travis.yml
diff --git a/Event/Listener/PrepareListener.php b/Event/Listener/PrepareListener.php
@@ -20,11 +20,6 @@ class PrepareListener
      */
     protected $encoding;
 
-    /**
-     * @param boolean $value
-     * @return PrepareListener $this
-     * @throws \InvalidArgumentException
-     */
     public function setForceCaseInsensitivity($value)
     {
         if (!is_bool($value)) {

diff --git a/Event/Subscriber/AbstractDoctrineSubscriber.php b/Event/Subscriber/AbstractDoctrineSubscriber.php
@@ -6,7 +6,7 @@
 use Lexik\Bundle\FormFilterBundle\Filter\Form\Type\BooleanFilterType;
 use Lexik\Bundle\FormFilterBundle\Event\GetFilterConditionEvent;
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 
 /**
  * Provide Doctrine ORM and DBAL filters.
@@ -35,7 +35,7 @@ public function filterValue(GetFilterConditionEvent $event)
             } elseif (!is_array($values['value'])) {
                 $event->setCondition(
                     $expr->eq($event->getField(), ':'.$paramName),
-                    array($paramName => array($values['value'], Type::STRING))
+                    array($paramName => array($values['value'], Types::STRING))
                 );
             }
         }
@@ -56,7 +56,7 @@ public function filterBoolean(GetFilterConditionEvent $event)
 
             $event->setCondition(
                 $expr->eq($event->getField(), ':'.$paramName),
-                array($paramName => array($value, Type::BOOLEAN))
+                array($paramName => array($value, Types::BOOLEAN))
             );
         }
     }
@@ -74,7 +74,7 @@ public function filterCheckbox(GetFilterConditionEvent $event)
 
             $event->setCondition(
                 $expr->eq($event->getField(), ':'.$paramName),
-                array($paramName => array($values['value'], Type::STRING))
+                array($paramName => array($values['value'], Types::STRING))
             );
         }
     }
@@ -92,7 +92,7 @@ public function filterDate(GetFilterConditionEvent $event)
 
             $event->setCondition(
                 $expr->eq($event->getField(), ':'.$paramName),
-                array($paramName => array($values['value'], Type::DATE))
+                array($paramName => array($values['value'], Types::DATE_MUTABLE))
             );
         }
     }
@@ -124,7 +124,7 @@ public function filterDateTime(GetFilterConditionEvent $event)
 
             $event->setCondition(
                 $expr->eq($event->getField(), ':'.$paramName),
-                array($paramName => array($values['value'], Type::DATETIME))
+                array($paramName => array($values['value'], Types::DATETIME_MUTABLE))
             );
         }
     }
@@ -158,7 +158,7 @@ public function filterNumber(GetFilterConditionEvent $event)
 
             $event->setCondition(
                 $expr->$op($event->getField(), ':'.$paramName),
-                array($paramName => array($values['value'], is_int($values['value']) ? Type::INTEGER : Type::FLOAT))
+                array($paramName => array($values['value'], is_int($values['value']) ? Types::INTEGER : Types::FLOAT))
             );
         }
     }
@@ -191,7 +191,7 @@ public function filterNumberRange(GetFilterConditionEvent $event)
                 $leftParamName = sprintf('p_%s_left', str_replace('.', '_', $event->getField()));
 
                 $expression->add($expr->$leftCond($event->getField(), ':'.$leftParamName));
-                $params[$leftParamName] = array($leftValue, is_int($leftValue) ? Type::INTEGER : Type::FLOAT);
+                $params[$leftParamName] = array($leftValue, is_int($leftValue) ? Types::INTEGER : Types::FLOAT);
             }
         }
 
@@ -211,7 +211,7 @@ public function filterNumberRange(GetFilterConditionEvent $event)
                 $rightParamName = sprintf('p_%s_right', str_replace('.', '_', $event->getField()));
 
                 $expression->add($expr->$rightCond($event->getField(), ':'.$rightParamName));
-                $params[$rightParamName] = array($rightValue, is_int($rightValue) ? Type::INTEGER : Type::FLOAT);
+                $params[$rightParamName] = array($rightValue, is_int($rightValue) ? Types::INTEGER : Types::FLOAT);
             }
         }
 

diff --git a/Event/Subscriber/DoctrineDBALSubscriber.php b/Event/Subscriber/DoctrineDBALSubscriber.php
@@ -12,7 +12,7 @@
 class DoctrineDBALSubscriber extends AbstractDoctrineSubscriber implements EventSubscriberInterface
 {
     /**
-     * {@inheritDoc}
+     * @return array
      */
     public static function getSubscribedEvents()
     {

diff --git a/Event/Subscriber/DoctrineMongodbSubscriber.php b/Event/Subscriber/DoctrineMongodbSubscriber.php
@@ -16,7 +16,7 @@
 class DoctrineMongodbSubscriber implements EventSubscriberInterface
 {
     /**
-     * {@inheritDoc}
+     * @return array
      */
     public static function getSubscribedEvents()
     {

diff --git a/Event/Subscriber/DoctrineORMSubscriber.php b/Event/Subscriber/DoctrineORMSubscriber.php
@@ -4,7 +4,7 @@
 
 use Doctrine\Common\Collections\Collection;
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
@@ -19,7 +19,7 @@
 class DoctrineORMSubscriber extends AbstractDoctrineSubscriber implements EventSubscriberInterface
 {
     /**
-     * {@inheritDoc}
+     * @return array
      */
     public static function getSubscribedEvents()
     {
@@ -108,7 +108,7 @@ public function filterEntity(GetFilterConditionEvent $event)
                     $expr->eq($filterField, ':'.$paramName),
                     array($paramName => array(
                         $this->getEntityIdentifier($values['value'], $queryBuilder->getEntityManager()),
-                        $this->getEntityIdentifierType($values['value'], $queryBuilder->getEntityManager()),
+                        Types::INTEGER
                     ))
                 );
             }

diff --git a/Filter/Doctrine/Expression/ExpressionBuilder.php b/Filter/Doctrine/Expression/ExpressionBuilder.php
@@ -91,8 +91,8 @@ public function between($field, $min, $max)
      * Returns gte expression if min is null
      *
      * @param string        $field field name
-     * @param null|DateTime $min   start date
-     * @param null|DateTime $max   end date
+     * @param null|\DateTime $min   start date
+     * @param null|\DateTime $max   end date
      *
      * @return \Doctrine\ORM\Query\Expr\Comparison|string
      */
@@ -125,9 +125,9 @@ public function dateInRange($field, $min = null, $max = null)
      * Returns lte expression if max is null
      * Returns gte expression if min is null
      *
-     * @param  string|DateTime $value alias.fieldName or mysql date string format or DateTime
-     * @param  string|DateTime $min alias.fieldName or mysql date string format or DateTime
-     * @param  string|DateTime $max alias.fieldName or mysql date string format or DateTime
+     * @param  string|\DateTime $value alias.fieldName or mysql date string format or DateTime
+     * @param  string|\DateTime $min alias.fieldName or mysql date string format or DateTime
+     * @param  string|\DateTime $max alias.fieldName or mysql date string format or DateTime
      * @return \Doctrine\ORM\Query\Expr\Comparison|string
      */
     public function dateTimeInRange($value, $min = null, $max = null)
@@ -180,7 +180,7 @@ public function stringLike($field, $value, $type = FilterOperands::STRING_CONTAI
     /**
      * Normalize DateTime boundary
      *
-     * @param  DateTime $date
+     * @param  \DateTime $date
      * @param  bool     $isMax
      *
      * @return \Doctrine\ORM\Query\Expr\Literal|string
@@ -190,7 +190,7 @@ protected function convertToSqlDate($date, $isMax = false)
         if (! $date instanceof \DateTime) {
             return;
         }
-        
+
         $copy = clone $date;
 
         if ($isMax) {
@@ -203,7 +203,7 @@ protected function convertToSqlDate($date, $isMax = false)
     /**
      * Normalize date time boundary
      *
-     * @param DateTime|string $date
+     * @param \DateTime|string $date
      * @return \Doctrine\ORM\Query\Expr\Literal
      */
     protected function convertToSqlDateTime($date)

diff --git a/Filter/FilterBuilderUpdater.php b/Filter/FilterBuilderUpdater.php
@@ -129,7 +129,7 @@ protected function addFilters(FormInterface $form, QueryInterface $filterQuery,
 
             // this means we have a relation
             if ($child->getConfig()->hasAttribute('add_shared')) {
-                $join = trim($alias . '.' . $child->getName(), '.');
+                $join = $child->getConfig()->getAttribute('filter_shared_name') ?? trim($alias . '.' . $child->getName(), '.');
 
                 $addSharedClosure = $child->getConfig()->getAttribute('add_shared');
 
@@ -150,7 +150,7 @@ protected function addFilters(FormInterface $form, QueryInterface $filterQuery,
 
             // Doctrine2 embedded object case
             } elseif ($formType instanceof EmbeddedFilterTypeInterface) {
-                $this->addFilters($child, $filterQuery, $alias . '.' . $child->getName());
+                $this->addFilters($child, $filterQuery, $child->getConfig()->getAttribute('filter_field_name') ?? ($alias . '.' . $child->getName()));
 
             // default case
             } else {
@@ -176,7 +176,7 @@ protected function getFilterCondition(FormInterface $form, AbstractType $formTyp
     {
         $values = $this->prepareFilterValues($form, $formType);
         $values += array('alias' => $alias);
-        $field = trim($values['alias'] . '.' . $form->getName(), '. ');
+        $field = $form->getConfig()->getAttribute('filter_field_name') ?? trim($values['alias'] . '.' . $form->getName(), '. ');
 
         $condition = null;
 

diff --git a/Filter/Form/FilterExtension.php b/Filter/Form/FilterExtension.php
@@ -13,7 +13,7 @@
 class FilterExtension extends AbstractExtension
 {
     /**
-     * {@inheritdoc}
+     * @return array
      */
     protected function loadTypes()
     {
@@ -36,10 +36,10 @@ protected function loadTypes()
     /**
      * {@inheritdoc}
      */
-    public function loadTypeExtensions()
+    public function loadTypeExtensions(): array
     {
-        return array(
+        return [
             new FilterTypeExtension(),
-        );
+        ];
     }
 }
diff --git a/Filter/Form/FilterTypeExtension.php b/Filter/Form/FilterTypeExtension.php
@@ -26,6 +26,14 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         if ($options['filter_condition_builder'] instanceof \Closure) {
             $builder->setAttribute('filter_condition_builder', $options['filter_condition_builder']);
         }
+
+        if (null !== $options['filter_field_name']) {
+            $builder->setAttribute('filter_field_name', $options['filter_field_name']);
+        }
+
+        if (null !== $options['filter_shared_name']) {
+            $builder->setAttribute('filter_shared_name', $options['filter_shared_name']);
+        }
     }
 
     /**
@@ -37,6 +45,8 @@ public function configureOptions(OptionsResolver $resolver)
             'apply_filter'             => null,
             'data_extraction_method'   => 'default',
             'filter_condition_builder' => null,
+            'filter_field_name'        => null,
+            'filter_shared_name'       => null,
         ));
     }