Add facet option to schema index field definition

Author: alexander-schranz

packages/seal/src/Schema/Field/AbstractField.php

@@ -27,6 +27,7 @@ public function __construct(
         public readonly bool $searchable,
         public readonly bool $filterable,
         public readonly bool $sortable,
+        public readonly bool $facet,
         public readonly array $options,
     ) {
     }

packages/seal/src/Schema/Field/BooleanField.php

@@ -32,6 +32,7 @@ public function __construct(
         bool $searchable = false,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         if ($searchable) { // @phpstan-ignore-line
@@ -44,6 +45,7 @@ public function __construct(
             $searchable,
             $filterable,
             $sortable,
+            $facet,
             $options,
         );
     }

packages/seal/src/Schema/Field/DateTimeField.php

@@ -32,6 +32,7 @@ public function __construct(
         bool $searchable = false,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         if ($searchable) { // @phpstan-ignore-line
@@ -44,6 +45,7 @@ public function __construct(
             $searchable,
             $filterable,
             $sortable,
+            $facet,
             $options,
         );
     }

packages/seal/src/Schema/Field/FloatField.php

@@ -32,19 +32,21 @@ public function __construct(
         bool $searchable = false,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         if ($searchable) { // @phpstan-ignore-line
             throw new \InvalidArgumentException('Searchability for FloatField is not yet implemented: https://github.com/php-cmsig/search/issues/97');
         }
 
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }

packages/seal/src/Schema/Field/GeoPointField.php

@@ -22,6 +22,7 @@
  * ATTENTION: Different search engines support only one field for geopoint per index.
  *
  * @property false $searchable
+ * @property false $facet
  *
  * @readonly
  */
@@ -30,6 +31,7 @@ final class GeoPointField extends AbstractField
     /**
      * @param false $searchable
      * @param false $multiple
+     * @param false $facet
      * @param array<string, mixed> $options
      */
     public function __construct(
@@ -38,19 +40,25 @@ public function __construct(
         bool $searchable = false,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         if ($searchable) { // @phpstan-ignore-line
             throw new \InvalidArgumentException('Searchability for GeoPointField is not yet implemented: https://github.com/php-cmsig/search/issues/97');
         }
 
+        if ($facet) { // @phpstan-ignore-line
+            throw new \InvalidArgumentException('Facet for GeoPointField is not yet implemented: <TODO create issue>');
+        }
+
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }

packages/seal/src/Schema/Field/IdentifierField.php

@@ -20,6 +20,7 @@
  * @property false $searchable
  * @property true $filterable
  * @property true $sortable
+ * @property false $facet
  *
  * @readonly
  */
@@ -33,6 +34,7 @@ public function __construct(string $name)
             searchable: false,
             filterable: true,
             sortable: true,
+            facet: false,
             options: [],
         );
     }

packages/seal/src/Schema/Field/IntegerField.php

@@ -32,19 +32,21 @@ public function __construct(
         bool $searchable = false,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         if ($searchable) { // @phpstan-ignore-line
             throw new \InvalidArgumentException('Searchability for IntegerField is not yet implemented: https://github.com/php-cmsig/search/issues/97');
         }
 
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }

packages/seal/src/Schema/Field/ObjectField.php

@@ -33,6 +33,7 @@ public function __construct(
         $searchable = false;
         $filterable = false;
         $sortable = false;
+        $facet = false;
 
         foreach ($fields as $field) {
             if ($field->searchable) {
@@ -46,15 +47,20 @@ public function __construct(
             if ($field->sortable) {
                 $sortable = true;
             }
+
+            if ($field->facet) {
+                $facet = true;
+            }
         }
 
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }

packages/seal/src/Schema/Field/TextField.php

@@ -29,15 +29,17 @@ public function __construct(
         bool $searchable = true,
         bool $filterable = false,
         bool $sortable = false,
+        bool $facet = false,
         array $options = [],
     ) {
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }

packages/seal/src/Schema/Field/TypedField.php

@@ -34,6 +34,7 @@ public function __construct(
         $searchable = false;
         $filterable = false;
         $sortable = false;
+        $facet = false;
 
         foreach ($types as $fields) {
             foreach ($fields as $field) {
@@ -48,16 +49,21 @@ public function __construct(
                 if ($field->sortable) {
                     $sortable = true;
                 }
+
+                if ($field->facet) {
+                    $facet = true;
+                }
             }
         }
 
         parent::__construct(
-            $name,
-            $multiple,
-            $searchable,
-            $filterable,
-            $sortable,
-            $options,
+            name: $name,
+            multiple: $multiple,
+            searchable: $searchable,
+            filterable: $filterable,
+            sortable: $sortable,
+            facet: $facet,
+            options: $options,
         );
     }
 }