IBX-6601: Fixed wrong documentation for Indexable/Unindexed

phpstan-baseline.neon

@@ -10370,16 +10370,6 @@ parameters:
 			count: 1
 			path: src/lib/FieldType/Time/Value.php
 
-		-
-			message: "#^Method Ibexa\\\\Core\\\\FieldType\\\\Unindexed\\:\\:getDefaultMatchField\\(\\) should return string but returns null\\.$#"
-			count: 1
-			path: src/lib/FieldType/Unindexed.php
-
-		-
-			message: "#^Method Ibexa\\\\Core\\\\FieldType\\\\Unindexed\\:\\:getDefaultSortField\\(\\) should return string but returns null\\.$#"
-			count: 1
-			path: src/lib/FieldType/Unindexed.php
-
 		-
 			message: "#^Access to an undefined property Ibexa\\\\Contracts\\\\Core\\\\FieldType\\\\Value\\:\\:\\$text\\.$#"
 			count: 1

src/contracts/FieldType/Indexable.php

@@ -39,7 +39,7 @@ public function getIndexDefinition();
      * implementation of this interface), this method is used to define default
      * field for matching. Default field is typically used by Field criterion.
      *
-     * @return string
+     * @return string|null
      */
     public function getDefaultMatchField();
 
@@ -50,7 +50,7 @@ public function getDefaultMatchField();
      * implementation of this interface), this method is used to define default
      * field for sorting. Default field is typically used by Field sort clause.
      *
-     * @return string
+     * @return string|null
      */
     public function getDefaultSortField();
 }

src/lib/FieldType/Unindexed.php

@@ -11,7 +11,9 @@
 use Ibexa\Contracts\Core\Persistence\Content\Type\FieldDefinition;
 
 /**
- * Indexable definition for string field type.
+ * Empty implementation of \Ibexa\Contracts\Core\FieldType\Indexable.
+ *
+ * Used when field type doesn't contribute to search index.
  */
 class Unindexed implements Indexable
 {
@@ -31,8 +33,6 @@ public function getIndexDefinition()
      * As field types can index multiple fields (see MapLocation field type's
      * implementation of this interface), this method is used to define default
      * field for matching. Default field is typically used by Field criterion.
-     *
-     * @return string
      */
     public function getDefaultMatchField()
     {
@@ -45,8 +45,6 @@ public function getDefaultMatchField()
      * As field types can index multiple fields (see MapLocation field type's
      * implementation of this interface), this method is used to define default
      * field for sorting. Default field is typically used by Field sort clause.
-     *
-     * @return string
      */
     public function getDefaultSortField()
     {

src/lib/Search/Common/FieldNameResolver.php

@@ -263,6 +263,12 @@ public function getIndexFieldName(
         $indexDefinition = $indexFieldType->getIndexDefinition();
 
         // Should only happen by mistake, so let's throw if it does
+        if ($name === null) {
+            throw new RuntimeException(
+                "Undefined default sort or match field in '{$fieldTypeIdentifier}' Field Type's index definition"
+            );
+        }
+
         if (!isset($indexDefinition[$name])) {
             throw new RuntimeException(
                 "Could not find Field '{$name}' in '{$fieldTypeIdentifier}' Field Type's index definition"