refactor: update filter handling and introduce new filter types and events

Author: ericges

config/services.yaml

@@ -21,10 +21,6 @@ services:
             - ../src/Engine/Loader
             - ../src/Engine/View
 
-    HeimrichHannot\FlareBundle\Filter\Resolver\FilterInvokerResolver:
-        arguments:
-            $invokerLocator: null # populated by compiler pass
-
     # Util classes registered as twig globals must be defined as services
     HeimrichHannot\FlareBundle\Util\Env: ~
     HeimrichHannot\FlareBundle\Util\Str: ~

…ollection/FilterDefinitionCollection.php …ollection/ConfiguredFilterCollection.phpsrc/Collection/FilterDefinitionCollection.php renamed to src/Collection/ConfiguredFilterCollection.php src/Collection/FilterDefinitionCollection.php renamed to src/Collection/ConfiguredFilterCollection.php

@@ -5,14 +5,14 @@
 namespace HeimrichHannot\FlareBundle\Collection;
 
 use Contao\StringUtil;
-use HeimrichHannot\FlareBundle\Specification\FilterDefinition;
+use HeimrichHannot\FlareBundle\Specification\ConfiguredFilter;
 
 /**
- * @method array<int, FilterDefinition> all() Get the items of the collection.
- * @method array<int, FilterDefinition> values() Get the values of the collection.
- * @method \Traversable<string, FilterDefinition> getIterator() Iterator for the collection items.
+ * @method array<int|string, ConfiguredFilter> all() Get the items of the collection.
+ * @method array<int|string, ConfiguredFilter> values() Get the values of the collection.
+ * @method \Traversable<string, ConfiguredFilter> getIterator() Iterator for the collection items.
  */
-class FilterDefinitionCollection extends AbstractCollection
+class ConfiguredFilterCollection extends AbstractCollection
 {
     public function __construct(
         ?array $items = null,
@@ -36,7 +36,7 @@ private function initItems(array $items): void
         }
     }
 
-    public function get(string $key): ?FilterDefinition
+    public function get(string $key): ?ConfiguredFilter
     {
         return $this->items[$key] ?? null;
     }
@@ -50,12 +50,12 @@ public function hasType(string $type): bool
     {
         return \array_reduce(
             $this->items,
-            static fn (bool $carry, FilterDefinition $filter): bool => $carry || $filter->getType() === $type,
+            static fn (bool $carry, ConfiguredFilter $filter): bool => $carry || $filter->getElementType() === $type,
             false
         );
     }
 
-    public function add(FilterDefinition ...$item): static
+    public function add(ConfiguredFilter ...$item): static
     {
         foreach ($item as $filter) {
             do {
@@ -68,15 +68,15 @@ public function add(FilterDefinition ...$item): static
         return $this;
     }
 
-    public function set(string $key, FilterDefinition $filter): void
+    public function set(string $key, ConfiguredFilter $filter): void
     {
         $this->items[$key] = $filter;
     }
 
     /**
-     * @param FilterDefinition|string $item The item to remove or its key.
+     * @param ConfiguredFilter|string $item The item to remove or its key.
      */
-    public function remove(FilterDefinition|string $item): bool
+    public function remove(ConfiguredFilter|string $item): bool
     {
         if (\is_string($item)) {
             if (!\array_key_exists($item, $this->items)) {
@@ -90,58 +90,36 @@ public function remove(FilterDefinition|string $item): bool
 
         $filtered = \array_filter(
             $this->items,
-            static fn (FilterDefinition $filter): bool => $filter !== $item
+            static fn (ConfiguredFilter $filter): bool => $filter !== $item
         );
 
         $this->items = $filtered;
 
         return \count($this->items) < $beforeCount;
     }
 
-    /**
-     * Serialize the collection.
-     *
-     * @return string Serialized representation of the collection.
-     */
     public function serialize(): string
     {
         return \serialize($this->items);
     }
 
-    /**
-     * Unserialize data into the collection.
-     *
-     * @param string $data The serialized data.
-     * @throws \UnexpectedValueException if the data is not an array of the expected type.
-     */
     public function unserialize(string $data): void
     {
         $unserialized = StringUtil::deserialize($data);
 
-        if (!is_array($unserialized)) {
-            throw new \UnexpectedValueException("Invalid data: expected an array.");
+        if (!\is_array($unserialized)) {
+            throw new \UnexpectedValueException('Invalid data: expected an array.');
         }
 
         $this->items = [];
         $this->initItems($unserialized);
     }
 
-    /**
-     * Magic method for serialization.
-     *
-     * @return array<int, FilterDefinition> Data to serialize.
-     */
     public function __serialize(): array
     {
         return $this->items;
     }
 
-    /**
-     * Magic method for unserialization.
-     *
-     * @param array<int, FilterDefinition> $data Data array to restore into the object.
-     * @throws \UnexpectedValueException if any item is of an incorrect type.
-     */
     public function __unserialize(array $data): void
     {
         $this->items = [];
@@ -150,14 +128,14 @@ public function __unserialize(array $data): void
 
     public function __clone(): void
     {
-        $this->items = \array_map(static fn (FilterDefinition $item): FilterDefinition => clone $item, $this->items);
+        $this->items = \array_map(static fn (ConfiguredFilter $item): ConfiguredFilter => clone $item, $this->items);
     }
 
     public function hash(): string
     {
         return \sha1(\serialize(\array_map(
-            static fn (FilterDefinition $filter): string => $filter->hash(),
+            static fn (ConfiguredFilter $filter): string => $filter->hash(),
             $this->items
         )));
     }
-}
+}

src/Contract/FilterElement/HydrateFormContract.php

@@ -4,11 +4,11 @@
 
 namespace HeimrichHannot\FlareBundle\Contract\FilterElement;
 
-use HeimrichHannot\FlareBundle\Specification\FilterDefinition;
+use HeimrichHannot\FlareBundle\Specification\ConfiguredFilter;
 use HeimrichHannot\FlareBundle\Specification\ListSpecification;
 use Symfony\Component\Form\FormInterface;
 
 interface HydrateFormContract
 {
-    public function hydrateForm(FormInterface $field, ListSpecification $list, FilterDefinition $filter): void;
+    public function hydrateForm(FormInterface $field, ListSpecification $list, ConfiguredFilter $filter): void;
 }

src/Contract/FilterElement/IntrinsicValueContract.php

@@ -4,7 +4,7 @@
 
 namespace HeimrichHannot\FlareBundle\Contract\FilterElement;
 
-use HeimrichHannot\FlareBundle\Specification\FilterDefinition;
+use HeimrichHannot\FlareBundle\Specification\ConfiguredFilter;
 use HeimrichHannot\FlareBundle\Specification\ListSpecification;
 
 interface IntrinsicValueContract
@@ -19,5 +19,5 @@ interface IntrinsicValueContract
      * @return mixed Any intrinsic value of which the FilterElement's invokers know how to interpret. Will be accessible
      *   through `$invocation->getValue()` from the invoker methods.
      */
-    public function getIntrinsicValue(ListSpecification $list, FilterDefinition $filter): mixed;
+    public function getIntrinsicValue(ListSpecification $list, ConfiguredFilter $filter): mixed;
 }

src/Contract/FilterElement/RuntimeValueContract.php

@@ -4,7 +4,7 @@
 
 namespace HeimrichHannot\FlareBundle\Contract\FilterElement;
 
-use HeimrichHannot\FlareBundle\Specification\FilterDefinition;
+use HeimrichHannot\FlareBundle\Specification\ConfiguredFilter;
 use HeimrichHannot\FlareBundle\Specification\ListSpecification;
 
 interface RuntimeValueContract
@@ -19,5 +19,5 @@ interface RuntimeValueContract
      * @return mixed The processed value, which will be passed to the filter method upon invocation, where it can
      *   be accessed through `$invocation->getValue()`.
      */
-    public function processRuntimeValue(mixed $value, ListSpecification $list, FilterDefinition $filter): mixed;
-}
+    public function processRuntimeValue(mixed $value, ListSpecification $list, ConfiguredFilter $filter): mixed;
+}

src/DataContainer/FilterContainer.php

@@ -11,9 +11,9 @@
 use HeimrichHannot\FlareBundle\Model\ListModel;
 use HeimrichHannot\FlareBundle\Query\Factory\ListExecutionContextFactory;
 use HeimrichHannot\FlareBundle\Query\ListExecutionContext;
-use HeimrichHannot\FlareBundle\Specification\Factory\FilterDefinitionFactory;
+use HeimrichHannot\FlareBundle\Specification\Factory\ConfiguredFilterFactory;
 use HeimrichHannot\FlareBundle\Specification\Factory\ListSpecificationFactory;
-use HeimrichHannot\FlareBundle\Specification\FilterDefinition;
+use HeimrichHannot\FlareBundle\Specification\ConfiguredFilter;
 use HeimrichHannot\FlareBundle\Specification\ListSpecification;
 use HeimrichHannot\FlareBundle\Util\CallbackHelper;
 
@@ -22,7 +22,7 @@ class FilterContainer implements FlareCallbackContainerInterface
     public const TABLE_NAME = 'tl_flare_filter';
 
     public function __construct(
-        private readonly FilterDefinitionFactory     $filterDefinitionFactory,
+        private readonly ConfiguredFilterFactory     $configuredFilterFactory,
         private readonly FlareCallbackManager        $callbacks,
         private readonly ListExecutionContextFactory $listExecutionContextFactory,
         private readonly ListSpecificationFactory    $listSpecificationFactory,
@@ -64,7 +64,7 @@ public function handleFieldOptions(?DataContainer $dc, string $target): array
 
         $callbacks = $this->callbacks->getFilterCallbacks($filterModel->type, $target);
 
-        $filterDefinition = $this->filterDefinitionFactory->create($filterModel);
+        $configuredFilter = $this->configuredFilterFactory->create($filterModel);
         $listSpecification = $this->listSpecificationFactory->create($listModel);
         $context = $this->listExecutionContextFactory->create($listSpecification);
         $tables = $context->tableAliasRegistry->getTables();
@@ -74,7 +74,7 @@ public function handleFieldOptions(?DataContainer $dc, string $target): array
             FilterModel::class => $filterModel,
             ListModel::class  => $listModel,
             DataContainer::class  => $dc,
-            FilterDefinition::class => $filterDefinition,
+            ConfiguredFilter::class => $configuredFilter,
             ListSpecification::class => $listSpecification,
             ListExecutionContext::class => $context,
             'tables' => $tables,
@@ -146,4 +146,4 @@ public function getModelsFromDataContainer(?DataContainer $dc, bool $ignoreType
     }
 
     // </editor-fold>
-}
+}