From c1a007689677dfcf38c9eb8be3666ee690c384c0 Mon Sep 17 00:00:00 2001
From: mgiraud <mgiraud@users.noreply.github.com>
Date: Wed, 2 Sep 2020 19:47:21 +0000
Subject: [PATCH] Apply fixes from StyleCI

---
 DataGrid/Expression/ComparisonExpression.php  | 10 -----
 DataGrid/Expression/CompositeExpression.php   |  5 ---
 DataGrid/Expression/EmptyExpression.php       |  2 -
 DataGrid/Expression/Visitable.php             |  2 -
 .../AbstractExpressionVisitor.php             |  7 +---
 .../DoctrineExpressionVisitor.php             | 35 ++++------------
 DataGrid/Parser/SearchQueryParser.php         | 42 ++++---------------
 DataGrid/QueryHandler/DoctrineQueryConfig.php | 21 +---------
 .../QueryHandler/DoctrineQueryHandler.php     | 26 +-----------
 DataGrid/Search/SearchGroup.php               |  3 --
 DataGrid/Search/SearchQuery.php               | 19 +--------
 DataGrid/Search/SearchQueryBuilder.php        | 18 --------
 DataGrid/Search/SearchSort.php                |  3 --
 13 files changed, 22 insertions(+), 171 deletions(-)

diff --git a/DataGrid/Expression/ComparisonExpression.php b/DataGrid/Expression/ComparisonExpression.php
index d9a556a..c023071 100644
--- a/DataGrid/Expression/ComparisonExpression.php
+++ b/DataGrid/Expression/ComparisonExpression.php
@@ -30,17 +30,11 @@ class ComparisonExpression implements Visitable
      */
     protected $operator;
 
-    /**
-     * @return string
-     */
     public function getField(): string
     {
         return $this->field;
     }
 
-    /**
-     * @return string
-     */
     public function getOperator(): string
     {
         return $this->operator;
@@ -62,8 +56,6 @@ public function getValue()
     /**
      * ComparisonExpression constructor.
      *
-     * @param string $field
-     * @param string $operator
      * @param $value
      */
     public function __construct(string $field, string $operator, $value)
@@ -74,8 +66,6 @@ public function __construct(string $field, string $operator, $value)
     }
 
     /**
-     * @param AbstractExpressionVisitor $visitor
-     *
      * @return mixed
      */
     public function visit(AbstractExpressionVisitor $visitor)
diff --git a/DataGrid/Expression/CompositeExpression.php b/DataGrid/Expression/CompositeExpression.php
index 46055c1..9e0f5d3 100644
--- a/DataGrid/Expression/CompositeExpression.php
+++ b/DataGrid/Expression/CompositeExpression.php
@@ -46,8 +46,6 @@ public function getExpressions(): array
     }
 
     /**
-     * @param Visitable $expression
-     *
      * @return $this
      */
     public function addExpression(Visitable $expression)
@@ -57,9 +55,6 @@ public function addExpression(Visitable $expression)
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getType(): string
     {
         return $this->type;
diff --git a/DataGrid/Expression/EmptyExpression.php b/DataGrid/Expression/EmptyExpression.php
index d89659e..0bda291 100644
--- a/DataGrid/Expression/EmptyExpression.php
+++ b/DataGrid/Expression/EmptyExpression.php
@@ -10,8 +10,6 @@
 class EmptyExpression implements Visitable
 {
     /**
-     * @param AbstractExpressionVisitor $visitor
-     *
      * @return mixed
      */
     public function visit(AbstractExpressionVisitor $visitor)
diff --git a/DataGrid/Expression/Visitable.php b/DataGrid/Expression/Visitable.php
index e170564..01c09c8 100644
--- a/DataGrid/Expression/Visitable.php
+++ b/DataGrid/Expression/Visitable.php
@@ -10,8 +10,6 @@
 interface Visitable
 {
     /**
-     * @param AbstractExpressionVisitor $visitor
-     *
      * @return mixed
      */
     public function visit(AbstractExpressionVisitor $visitor);
diff --git a/DataGrid/ExpressionVisitor/AbstractExpressionVisitor.php b/DataGrid/ExpressionVisitor/AbstractExpressionVisitor.php
index b080f7d..6fec008 100644
--- a/DataGrid/ExpressionVisitor/AbstractExpressionVisitor.php
+++ b/DataGrid/ExpressionVisitor/AbstractExpressionVisitor.php
@@ -12,23 +12,18 @@
 abstract class AbstractExpressionVisitor
 {
     /**
-     * @param ComparisonExpression $comparison
-     *
      * @return mixed
      */
     abstract public function visitComparison(ComparisonExpression $comparison);
 
     /**
      * @param $type
-     * @param array $expressions
      *
      * @return mixed
      */
     abstract public function visitProcessedCompositeExpression(string $type, array $expressions);
 
     /**
-     * @param CompositeExpression $compositeExpression
-     *
      * @return mixed
      */
     public function visitCompositeExpression(CompositeExpression $compositeExpression)
@@ -37,7 +32,7 @@ public function visitCompositeExpression(CompositeExpression $compositeExpressio
             return $expr->visit($this);
         });
         $expressions = \Functional\filter($expressions, function ($expr) {
-            return $expr !== null;
+            return null !== $expr;
         });
 
         return $this->visitProcessedCompositeExpression($compositeExpression->getType(), $expressions);
diff --git a/DataGrid/ExpressionVisitor/DoctrineExpressionVisitor.php b/DataGrid/ExpressionVisitor/DoctrineExpressionVisitor.php
index 73a0a1e..b8d4282 100644
--- a/DataGrid/ExpressionVisitor/DoctrineExpressionVisitor.php
+++ b/DataGrid/ExpressionVisitor/DoctrineExpressionVisitor.php
@@ -53,8 +53,6 @@ class DoctrineExpressionVisitor extends AbstractExpressionVisitor
 
     /**
      * DoctrineExpressionVisitor constructor.
-     *
-     * @param DoctrineQueryHandler $queryHandler
      */
     public function __construct(DoctrineQueryHandler $queryHandler)
     {
@@ -75,8 +73,6 @@ protected function convertOperator($operator)
     }
 
     /**
-     * @param ComparisonExpression $comparison
-     *
      * @return mixed|string
      */
     protected function visitValue(ComparisonExpression $comparison)
@@ -88,14 +84,14 @@ protected function visitValue(ComparisonExpression $comparison)
         ) {
             return $date->setTimezone(new \DateTimezone(date_default_timezone_get()));
         } else {
-            $value = $comparison->getValue() !== null ? $this->queryHandler->transformValueCase($comparison->getValue()) : null;
-            if ($comparison->getOperator() === ComparisonExpression::CONTAINS || $comparison->getOperator(
-                ) === ComparisonExpression::NOTCONTAINS
+            $value = null !== $comparison->getValue() ? $this->queryHandler->transformValueCase($comparison->getValue()) : null;
+            if (ComparisonExpression::CONTAINS === $comparison->getOperator() || ComparisonExpression::NOTCONTAINS === $comparison->getOperator(
+                )
             ) {
                 return '%'.$value.'%';
-            } elseif ($comparison->getOperator() === ComparisonExpression::STARTSWITH) {
+            } elseif (ComparisonExpression::STARTSWITH === $comparison->getOperator()) {
                 return $value.'%';
-            } elseif ($comparison->getOperator() === ComparisonExpression::ENDSWITH) {
+            } elseif (ComparisonExpression::ENDSWITH === $comparison->getOperator()) {
                 return '%'.$value;
             } else {
                 return $value;
@@ -103,11 +99,6 @@ protected function visitValue(ComparisonExpression $comparison)
         }
     }
 
-    /**
-     * @param ComparisonExpression $comparisonExpression
-     *
-     * @return string
-     */
     protected function visitField(ComparisonExpression $comparisonExpression, $visitedValue): string
     {
         $field = $comparisonExpression->getField();
@@ -119,9 +110,7 @@ protected function visitField(ComparisonExpression $comparisonExpression, $visit
     }
 
     /**
-     * @param ComparisonExpression $comparison
-     * @param string               $fieldName
-     * @param mixed                $value
+     * @param mixed $value
      *
      * @return DoctrineComparison
      */
@@ -156,9 +145,6 @@ protected function visitComparisonWithNotNullValue(ComparisonExpression $compari
     }
 
     /**
-     * @param ComparisonExpression $comparison
-     * @param string               $fieldName
-     *
      * @return string
      */
     protected function visitComparisonWithNullValue(ComparisonExpression $comparison, string $fieldName)
@@ -174,8 +160,6 @@ protected function visitComparisonWithNullValue(ComparisonExpression $comparison
     }
 
     /**
-     * @param ComparisonExpression $comparison
-     *
      * @return DoctrineComparison
      */
     public function visitComparison(ComparisonExpression $comparison)
@@ -183,7 +167,7 @@ public function visitComparison(ComparisonExpression $comparison)
         $value = $this->visitValue($comparison);
         $fieldName = $this->visitField($comparison, $value);
 
-        if ($value !== null) {
+        if (null !== $value) {
             return $this->visitComparisonWithNotNullValue($comparison, $fieldName, $value);
         } else {
             return $this->visitComparisonWithNullValue($comparison, $fieldName);
@@ -191,9 +175,6 @@ public function visitComparison(ComparisonExpression $comparison)
     }
 
     /**
-     * @param string $type
-     * @param array  $expressions
-     *
      * @return Andx|Orx|Func
      */
     public function visitProcessedCompositeExpression(string $type, array $expressions)
@@ -204,7 +185,7 @@ public function visitProcessedCompositeExpression(string $type, array $expressio
             case CompositeExpression::TYPE_OR:
                 return new Orx($expressions);
             case CompositeExpression::TYPE_NOT:
-                return new Func("not", $expressions);
+                return new Func('not', $expressions);
             default:
                 throw new UnknownCompositeException($type);
         }
diff --git a/DataGrid/Parser/SearchQueryParser.php b/DataGrid/Parser/SearchQueryParser.php
index 97a70a2..b63c264 100644
--- a/DataGrid/Parser/SearchQueryParser.php
+++ b/DataGrid/Parser/SearchQueryParser.php
@@ -28,19 +28,11 @@ public function __construct()
         $this->builder = new SearchQueryBuilder();
     }
 
-    /**
-     * @return SearchQueryBuilder
-     */
     public function getBuilder(): SearchQueryBuilder
     {
         return $this->builder;
     }
 
-    /**
-     * @param \stdClass $data
-     *
-     * @return SearchQuery
-     */
     public function parse(\stdClass $data): SearchQuery
     {
         if (isset($data->take)) {
@@ -60,8 +52,6 @@ public function parse(\stdClass $data): SearchQuery
     }
 
     /**
-     * @param \stdClass $data
-     *
      * @throws NotNumericException
      */
     public function parseStartIndex(\stdClass $data)
@@ -74,8 +64,6 @@ public function parseStartIndex(\stdClass $data)
     }
 
     /**
-     * @param \stdClass $data
-     *
      * @throws NotNumericException
      */
     public function parseMaxResults(\stdClass $data)
@@ -88,8 +76,6 @@ public function parseMaxResults(\stdClass $data)
     }
 
     /**
-     * @param \stdClass $data
-     *
      * @throws NotArrayException
      */
     public function parseSort(\stdClass $data)
@@ -106,28 +92,18 @@ function (\stdClass $sort) {
         }
     }
 
-    /**
-     * @param array $filter
-     *
-     * @return ComparisonExpression
-     */
     public function parseComparison(array $filter): ComparisonExpression
     {
         return new ComparisonExpression($filter[0], $filter[1], $filter[2]);
     }
 
     /**
-     * @param array                    $filter
-     * @param CompositeExpression|null $parent
-     *
-     * @return Visitable
-     *
      * @throws \Exception
      */
     public function parseDisjunction(array $filter, CompositeExpression $parent = null): Visitable
     {
-        if (count($filter) == 1) {
-            if ($parent === null) {
+        if (1 == count($filter)) {
+            if (null === $parent) {
                 return $this->parseComparison(array_shift($filter));
             } else {
                 $parent->addExpression($this->parseDisjunction(array_shift($filter)));
@@ -137,14 +113,14 @@ public function parseDisjunction(array $filter, CompositeExpression $parent = nu
         } elseif (count($filter) >= 3) {
             $first = array_shift($filter);
             $second = array_shift($filter);
-            if ($second === 'and' || $second === 'or') {
-                if ($second === 'and') {
+            if ('and' === $second || 'or' === $second) {
+                if ('and' === $second) {
                     $newComposite = new CompositeExpression(CompositeExpression::TYPE_AND, []);
                 } else {
                     $newComposite = new CompositeExpression(CompositeExpression::TYPE_OR, []);
                 }
-                if ($parent !== null) {
-                    if (count($filter[0]) > 1 && count($parent->getExpressions()) === 0) {
+                if (null !== $parent) {
+                    if (count($filter[0]) > 1 && 0 === count($parent->getExpressions())) {
                         $newComposite->addExpression($this->parseDisjunction($first, $newComposite));
 
                         return $this->parseDisjunction($filter, $newComposite);
@@ -161,11 +137,11 @@ public function parseDisjunction(array $filter, CompositeExpression $parent = nu
             } else {
                 return $this->parseComparison([$first, $second, $filter[0]]);
             }
-        } else if (count($filter) == 2) {
+        } elseif (2 == count($filter)) {
             $first = array_shift($filter);
             $second = array_shift($filter);
 
-            if($first === '!') {
+            if ('!' === $first) {
                 $newComposite = new CompositeExpression(CompositeExpression::TYPE_NOT, []);
 
                 $newComposite->addExpression($this->parseDisjunction($second, $newComposite));
@@ -178,8 +154,6 @@ public function parseDisjunction(array $filter, CompositeExpression $parent = nu
     }
 
     /**
-     * @param \stdClass $data
-     *
      * @throws NotArrayException
      */
     public function parseFilter(\stdClass $data)
diff --git a/DataGrid/QueryHandler/DoctrineQueryConfig.php b/DataGrid/QueryHandler/DoctrineQueryConfig.php
index 73d3545..f34c827 100644
--- a/DataGrid/QueryHandler/DoctrineQueryConfig.php
+++ b/DataGrid/QueryHandler/DoctrineQueryConfig.php
@@ -27,9 +27,7 @@ class DoctrineQueryConfig
     /**
      * DoctrineQueryConfig constructor.
      *
-     * @param array $fieldMapping
-     * @param array $defaultFilters
-     * @param bool  $caseSensitive
+     * @param bool $caseSensitive
      */
     public function __construct(array $fieldMapping = [], array $defaultFilters = [], $caseSensitive = false)
     {
@@ -46,33 +44,22 @@ public function getDefaultFilters(): array
         return $this->defaultFilters;
     }
 
-    /**
-     * @param array $defaultFilters
-     */
     public function setDefaultFilters(array $defaultFilters)
     {
         $this->defaultFilters = $defaultFilters;
     }
 
-    /**
-     * @return array
-     */
     public function getFieldMapping(): array
     {
         return $this->fieldMapping;
     }
 
-    /**
-     * @param array $fieldMapping
-     */
     public function setFieldMapping(array $fieldMapping)
     {
         $this->fieldMapping = $fieldMapping;
     }
 
     /**
-     * @param string $field
-     *
      * @return string
      */
     public function mapField(string $field)
@@ -84,17 +71,11 @@ public function mapField(string $field)
         return $field;
     }
 
-    /**
-     * @return bool
-     */
     public function isCaseSensitive(): bool
     {
         return $this->caseSensitive;
     }
 
-    /**
-     * @param bool $caseSensitive
-     */
     public function setCaseSensitive(bool $caseSensitive)
     {
         $this->caseSensitive = $caseSensitive;
diff --git a/DataGrid/QueryHandler/DoctrineQueryHandler.php b/DataGrid/QueryHandler/DoctrineQueryHandler.php
index 0f2c52b..931d11c 100644
--- a/DataGrid/QueryHandler/DoctrineQueryHandler.php
+++ b/DataGrid/QueryHandler/DoctrineQueryHandler.php
@@ -31,10 +31,6 @@ class DoctrineQueryHandler
 
     /**
      * DoctrineQueryHandler constructor.
-     *
-     * @param DoctrineQueryConfig $queryConfig
-     * @param QueryBuilder        $queryBuilder
-     * @param SearchQuery         $searchQuery
      */
     public function __construct(DoctrineQueryConfig $queryConfig, QueryBuilder $queryBuilder, SearchQuery $searchQuery)
     {
@@ -44,8 +40,6 @@ public function __construct(DoctrineQueryConfig $queryConfig, QueryBuilder $quer
     }
 
     /**
-     * @param string $field
-     *
      * @return string
      */
     public function transformField(string $field)
@@ -54,10 +48,7 @@ public function transformField(string $field)
     }
 
     /**
-     * @param string $field
      * @param $visitedValue
-     *
-     * @return string
      */
     public function transformFieldCase(string $field, $visitedValue): string
     {
@@ -68,11 +59,6 @@ public function transformFieldCase(string $field, $visitedValue): string
         return $field;
     }
 
-    /**
-     * @param string $value
-     *
-     * @return string
-     */
     public function transformValueCase(string $value): string
     {
         if ($this->queryConfig->isCaseSensitive()) {
@@ -98,15 +84,13 @@ public function addAllModifiers($noDefaultFilter = false)
 
     /**
      * @param bool $noDefaultFilter
-     *
-     * @return DoctrineQueryHandler
      */
     public function addFilters($noDefaultFilter = false): DoctrineQueryHandler
     {
         $visitor = new DoctrineExpressionVisitor($this);
         $filters = $this->searchQuery->getFilter()->visit($visitor);
 
-        if ($filters !== null) {
+        if (null !== $filters) {
             $this->queryBuilder->andWhere($filters);
         }
 
@@ -129,9 +113,6 @@ function (Parameter $parameter) {
         return $this;
     }
 
-    /**
-     * @return DoctrineQueryHandler
-     */
     public function addSorting(): DoctrineQueryHandler
     {
         \Functional\each(
@@ -147,13 +128,10 @@ function (SearchSort $sort) {
         return $this;
     }
 
-    /**
-     * @return QueryBuilder
-     */
     public function addPagination(): QueryBuilder
     {
         $this->queryBuilder->setFirstResult($this->searchQuery->getStartIndex());
-        if (($maxResults = $this->searchQuery->getMaxResults()) !== null) {
+        if (null !== ($maxResults = $this->searchQuery->getMaxResults())) {
             $this->queryBuilder->setMaxResults($maxResults);
         }
 
diff --git a/DataGrid/Search/SearchGroup.php b/DataGrid/Search/SearchGroup.php
index 086991e..f3686a7 100644
--- a/DataGrid/Search/SearchGroup.php
+++ b/DataGrid/Search/SearchGroup.php
@@ -16,9 +16,6 @@ class SearchGroup
 
     /**
      * SearchGroup constructor.
-     *
-     * @param string $field
-     * @param bool   $desc
      */
     public function __construct(string $field, bool $desc)
     {
diff --git a/DataGrid/Search/SearchQuery.php b/DataGrid/Search/SearchQuery.php
index 02dd4bc..abe9cd4 100644
--- a/DataGrid/Search/SearchQuery.php
+++ b/DataGrid/Search/SearchQuery.php
@@ -41,25 +41,19 @@ public function __construct($filter, $sort, $startIndex, $maxResults)
     {
         $this->filter = $filter;
         $this->sort = $sort;
-        if ($this->startIndex !== null) {
+        if (null !== $this->startIndex) {
             $this->startIndex = (int) $startIndex;
         }
-        if ($maxResults !== null) {
+        if (null !== $maxResults) {
             $this->maxResults = (int) $maxResults;
         }
     }
 
-    /**
-     * @return Visitable
-     */
     public function getFilter(): Visitable
     {
         return $this->filter;
     }
 
-    /**
-     * @param Visitable $filter
-     */
     public function setFilter(Visitable $filter)
     {
         $this->filter = $filter;
@@ -73,25 +67,16 @@ public function getSort(): array
         return $this->sort;
     }
 
-    /**
-     * @param array $sort
-     */
     public function setSort(array $sort)
     {
         $this->sort = $sort;
     }
 
-    /**
-     * @return int
-     */
     public function getStartIndex(): int
     {
         return $this->startIndex;
     }
 
-    /**
-     * @param int $startIndex
-     */
     public function setStartIndex(int $startIndex)
     {
         $this->startIndex = $startIndex;
diff --git a/DataGrid/Search/SearchQueryBuilder.php b/DataGrid/Search/SearchQueryBuilder.php
index b7319e4..39277ff 100644
--- a/DataGrid/Search/SearchQueryBuilder.php
+++ b/DataGrid/Search/SearchQueryBuilder.php
@@ -52,17 +52,11 @@ public function build()
         return new SearchQuery($filters, $this->sortings, $this->startIndex, $this->maxResults);
     }
 
-    /**
-     * @return array
-     */
     public function getFilters(): array
     {
         return $this->filters;
     }
 
-    /**
-     * @return int
-     */
     public function getStartIndex(): int
     {
         return $this->startIndex;
@@ -74,8 +68,6 @@ public function getMaxResults()
     }
 
     /**
-     * @param array $filters
-     *
      * @return $this
      */
     public function setFilters(array $filters)
@@ -85,17 +77,12 @@ public function setFilters(array $filters)
         return $this;
     }
 
-    /**
-     * @return array
-     */
     public function getSortings(): array
     {
         return $this->sortings;
     }
 
     /**
-     * @param int $startIndex
-     *
      * @return $this
      */
     public function setStartIndex(int $startIndex)
@@ -118,9 +105,6 @@ public function setMaxResults($maxResults)
     }
 
     /**
-     * @param string $field
-     * @param bool   $desc
-     *
      * @return $this
      */
     public function sort(string $field, bool $desc)
@@ -131,8 +115,6 @@ public function sort(string $field, bool $desc)
     }
 
     /**
-     * @param Visitable $expression
-     *
      * @return $this
      */
     public function filter(Visitable $expression)
diff --git a/DataGrid/Search/SearchSort.php b/DataGrid/Search/SearchSort.php
index 2c61c2b..aed1711 100644
--- a/DataGrid/Search/SearchSort.php
+++ b/DataGrid/Search/SearchSort.php
@@ -19,9 +19,6 @@ class SearchSort
 
     /**
      * SearchSort constructor.
-     *
-     * @param string $field
-     * @param bool   $desc
      */
     public function __construct(string $field, bool $desc)
     {