IBX-8534: Changed typehint from abstract Criterion to CriterionInterf…

…ace (#80) * IBX-8534: Changed typehint from abstract Criterion to CriterionInterface * Cleaned up baseline * fixed codestyle * Dropped removed isPublished property * added status property * added more concrete ternary operator check * added null check for query::query
ibexa · Dec 10, 2024 · 4248a31 · 4248a31
1 parent 1485af2
commit 4248a31
Show file tree

Hide file tree

Showing 72 changed files with 294 additions and 173 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -255,11 +255,6 @@ parameters:
 			count: 1
 			path: src/lib/CoreFilter/NativeCoreFilter.php
 
-		-
-			message: "#^Method Ibexa\\\\Solr\\\\CoreFilter\\\\NativeCoreFilter\\:\\:getLanguageFilter\\(\\) should return Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion but returns Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\\\CustomField\\|Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\\\LogicalAnd\\|Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\\\LogicalNot\\|Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\\\LogicalOr\\|false\\.$#"
-			count: 1
-			path: src/lib/CoreFilter/NativeCoreFilter.php
-
 		-
 			message: "#^Parameter \\#2 \\$languageCode of method Ibexa\\\\Solr\\\\DocumentMapper\\\\NativeDocumentMapper\\:\\:generateContentDocumentId\\(\\) expects string\\|null, int\\|string given\\.$#"
 			count: 1
@@ -785,16 +780,6 @@ parameters:
 			count: 1
 			path: src/lib/Query/Common/CriterionVisitor/Aggregate.php
 
-		-
-			message: "#^Access to an undefined property Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\:\\:\\$criteria\\.$#"
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/CompositeCriterion.php
-
-		-
-			message: "#^Cannot call method visit\\(\\) on Ibexa\\\\Contracts\\\\Solr\\\\Query\\\\CriterionVisitor\\|null\\.$#"
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/CompositeCriterion.php
-
 		-
 			message: "#^Parameter \\#2 \\$array of function array_map expects array, array\\<bool\\|float\\|int\\|string\\>\\|bool\\|float\\|int\\|string given\\.$#"
 			count: 1
@@ -1080,11 +1065,6 @@ parameters:
 			count: 1
 			path: src/lib/Query/Content/CriterionVisitor/ParentLocationIdIn.php
 
-		-
-			message: "#^Instanceof between Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion and Ibexa\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Query\\\\Criterion\\\\PermissionSubtree will always evaluate to false\\.$#"
-			count: 1
-			path: src/lib/Query/Content/CriterionVisitor/SubtreeIn.php
-
 		-
 			message: "#^Parameter \\#2 \\$array of function array_map expects array, array\\<bool\\|float\\|int\\|string\\>\\|bool\\|float\\|int\\|string given\\.$#"
 			count: 1

diff --git a/src/contracts/Query/CriterionVisitor.php b/src/contracts/Query/CriterionVisitor.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 
 /**
  * Visits the criterion tree into a Solr query.
@@ -20,16 +21,14 @@ abstract class CriterionVisitor
      *
      * @return bool
      */
-    abstract public function canVisit(Criterion $criterion);
+    abstract public function canVisit(CriterionInterface $criterion);
 
     /**
      * Map field value to a proper Solr representation.
      *
-     * @param CriterionVisitor $subVisitor
-     *
      * @return string
      */
-    abstract public function visit(Criterion $criterion, self $subVisitor = null);
+    abstract public function visit(CriterionInterface $criterion, self $subVisitor = null);
 
     /**
      * Get Solr range.

diff --git a/src/lib/CoreFilter/NativeCoreFilter.php b/src/lib/CoreFilter/NativeCoreFilter.php
@@ -8,14 +8,14 @@
 namespace Ibexa\Solr\CoreFilter;
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
-use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\CustomField;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LogicalAnd;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LogicalNot;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LogicalOr;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
 use Ibexa\Solr\CoreFilter;
 use Ibexa\Solr\Gateway\EndpointResolver;
+use RuntimeException;
 
 /**
  * Native core filter handles:.
@@ -132,7 +132,7 @@ private function getCoreCriterion(
         array $languageCodes,
         bool $useAlwaysAvailable,
         bool $excludeTranslationsFromAlwaysAvailable = true
-    ): Criterion {
+    ): Query\CriterionInterface {
         // Handle languages if given
         if (!empty($languageCodes)) {
             // Get condition for prioritized languages fallback
@@ -164,10 +164,8 @@ private function getCoreCriterion(
      * Returns criteria for prioritized languages fallback.
      *
      * @param string[] $languageCodes
-     *
-     * @return \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion
      */
-    private function getLanguageFilter(array $languageCodes)
+    private function getLanguageFilter(array $languageCodes): Query\CriterionInterface
     {
         $languageFilters = [];
 
@@ -209,6 +207,10 @@ private function getLanguageFilter(array $languageCodes)
             return new LogicalAnd($languageFilters);
         }
 
+        if (empty($languageFilters)) {
+            throw new RuntimeException('$languageFilters is empty');
+        }
+
         return reset($languageFilters);
     }
 
@@ -220,7 +222,7 @@ private function getLanguageFilter(array $languageCodes)
     private function getAlwaysAvailableFilter(
         array $languageCodes,
         bool $excludeTranslationsFromAlwaysAvailable = true
-    ): Criterion {
+    ): Query\CriterionInterface {
         $excludeOnField = $excludeTranslationsFromAlwaysAvailable
             // Exclude all translations by given languages
             ? self::FIELD_LANGUAGES

diff --git a/src/lib/Handler.php b/src/lib/Handler.php
@@ -173,7 +173,7 @@ public function findContent(Query $query, array $languageFilter = [])
      *
      * @return \Ibexa\Contracts\Core\Persistence\Content
      */
-    public function findSingle(Criterion $filter, array $languageFilter = [])
+    public function findSingle(Query\CriterionInterface $filter, array $languageFilter = [])
     {
         $query = new Query();
         $query->filter = $filter;

diff --git a/src/lib/Query/Common/CriterionVisitor/Aggregate.php b/src/lib/Query/Common/CriterionVisitor/Aggregate.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Exceptions\NotImplementedException;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -48,7 +49,7 @@ public function addVisitor(CriterionVisitor $visitor)
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return true;
     }
@@ -62,14 +63,14 @@ public function canVisit(Criterion $criterion)
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         foreach ($this->visitors as $visitor) {
             if ($visitor->canVisit($criterion)) {
                 return $visitor->visit($criterion, $this);
             }
         }
 
-        throw new NotImplementedException('No visitor available for: ' . \get_class($criterion) . ' with operator ' . $criterion->operator);
+        throw new NotImplementedException('No visitor available for: ' . \get_class($criterion));
     }
 }
diff --git a/src/lib/Query/Common/CriterionVisitor/BaseIsContainer.php b/src/lib/Query/Common/CriterionVisitor/BaseIsContainer.php
@@ -10,6 +10,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -19,12 +20,15 @@ abstract class BaseIsContainer extends CriterionVisitor
 {
     abstract protected function getTargetField(): string;
 
-    public function canVisit(Criterion $criterion): bool
+    public function canVisit(CriterionInterface $criterion): bool
     {
         return $criterion instanceof Criterion\IsContainer && $criterion->operator === Operator::EQ;
     }
 
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null): string
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\IsContainer $criterion
+     */
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null): string
     {
         $value = $criterion->value;
 

diff --git a/src/lib/Query/Common/CriterionVisitor/CompositeCriterion.php b/src/lib/Query/Common/CriterionVisitor/CompositeCriterion.php
@@ -9,17 +9,21 @@
 namespace Ibexa\Solr\Query\Common\CriterionVisitor;
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 final class CompositeCriterion extends CriterionVisitor
 {
-    public function canVisit(Criterion $criterion): bool
+    public function canVisit(CriterionInterface $criterion): bool
     {
         return $criterion instanceof Criterion\CompositeCriterion;
     }
 
-    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\CompositeCriterion $criterion
+     */
+    public function visit(CriterionInterface $criterion, ?CriterionVisitor $subVisitor = null): string
     {
-        return $subVisitor->visit($criterion->criteria, $subVisitor);
+        return $subVisitor?->visit($criterion->criteria, $subVisitor) ?? '';
     }
 }
diff --git a/src/lib/Query/Common/CriterionVisitor/ContentIdIn.php b/src/lib/Query/Common/CriterionVisitor/ContentIdIn.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -21,7 +22,7 @@ class ContentIdIn extends CriterionVisitor
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return
             $criterion instanceof Criterion\ContentId &&
@@ -34,11 +35,12 @@ public function canVisit(Criterion $criterion)
     /**
      * Map field value to a proper Solr representation.
      *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentId $criterion
      * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         return '(' .
             implode(

diff --git a/src/lib/Query/Common/CriterionVisitor/ContentTypeGroupIdIn.php b/src/lib/Query/Common/CriterionVisitor/ContentTypeGroupIdIn.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -21,7 +22,7 @@ class ContentTypeGroupIdIn extends CriterionVisitor
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return
             $criterion instanceof Criterion\ContentTypeGroupId &&
@@ -34,11 +35,12 @@ public function canVisit(Criterion $criterion)
     /**
      * Map field value to a proper Solr representation.
      *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeGroupId $criterion
      * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         return '(' .
             implode(

diff --git a/src/lib/Query/Common/CriterionVisitor/ContentTypeIdIn.php b/src/lib/Query/Common/CriterionVisitor/ContentTypeIdIn.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -21,7 +22,7 @@ class ContentTypeIdIn extends CriterionVisitor
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return
             $criterion instanceof Criterion\ContentTypeId &&
@@ -34,11 +35,12 @@ public function canVisit(Criterion $criterion)
     /**
      * Map field value to a proper Solr representation.
      *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeId $criterion
      * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         return '(' .
             implode(

diff --git a/src/lib/Query/Common/CriterionVisitor/ContentTypeIdentifierIn.php b/src/lib/Query/Common/CriterionVisitor/ContentTypeIdentifierIn.php
@@ -11,6 +11,7 @@
 use Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
@@ -46,7 +47,7 @@ public function __construct(Handler $contentTypeHandler, LoggerInterface $logger
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return
             $criterion instanceof Criterion\ContentTypeIdentifier
@@ -59,11 +60,12 @@ public function canVisit(Criterion $criterion)
     /**
      * Map field value to a proper Solr representation.
      *
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeIdentifier $criterion
      * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         $validIds = [];
         $invalidIdentifiers = [];

diff --git a/src/lib/Query/Common/CriterionVisitor/CustomField/CustomFieldIn.php b/src/lib/Query/Common/CriterionVisitor/CustomField/CustomFieldIn.php
@@ -9,6 +9,7 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
 /**
@@ -21,7 +22,7 @@ class CustomFieldIn extends CriterionVisitor
      *
      * @return bool
      */
-    public function canVisit(Criterion $criterion)
+    public function canVisit(CriterionInterface $criterion)
     {
         return
             $criterion instanceof Criterion\CustomField &&
@@ -36,10 +37,11 @@ public function canVisit(Criterion $criterion)
      * Map field value to a proper Solr representation.
      *
      * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\CustomField $criterion
      *
      * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(CriterionInterface $criterion, CriterionVisitor $subVisitor = null)
     {
         $queries = [];
         $values = (array)$criterion->value;