Replace usages of AbstractFilter with the FilterInterface and mark th…

…e filter as readonly
laminas · Dec 27, 2024 · 182f4e4 · 182f4e4
1 parent f7c2743
commit 182f4e4
Show file tree

Hide file tree

Showing 23 changed files with 482 additions and 2,211 deletions.
diff --git a/src/AbstractDateDropdown.php b/src/AbstractDateDropdown.php
@@ -7,33 +7,31 @@
 use function array_reduce;
 use function count;
 use function is_array;
-use function is_iterable;
 use function ksort;
 use function sprintf;
 use function vsprintf;
 
 /**
  * @psalm-type Options = array{
  *     null_on_empty?: bool,
- *     null_on_all_empty?: bool,
- *     ...
+ *     null_on_all_empty?: bool
  * }
  * @psalm-type InputArray = array<string, string>
  * @template TOptions of Options
- * @template-extends AbstractFilter<TOptions>
+ * @template-implements FilterInterface<string|null>
  * @template TInput of array<array-key, numeric>
  */
-abstract class AbstractDateDropdown extends AbstractFilter
+abstract class AbstractDateDropdown implements FilterInterface
 {
     /**
      * If true, the filter will return null if any date field is empty
      */
-    protected bool $nullOnEmpty = false;
+    protected readonly bool $nullOnEmpty;
 
     /**
      * If true, the filter will return null if all date fields are empty
      */
-    protected bool $nullOnAllEmpty = false;
+    protected readonly bool $nullOnAllEmpty;
 
     /**
      * Sprintf format string to use for formatting the date, fields will be used in alphabetical order.
@@ -43,42 +41,12 @@ abstract class AbstractDateDropdown extends AbstractFilter
     protected int $expectedInputs = 0;
 
     /**
-     * @param mixed $options If array or Traversable, passes value to
-     *     setOptions().
+     * @param Options $options
      */
-    public function __construct(mixed $options = null)
+    public function __construct(array $options = [])
     {
-        if (is_iterable($options)) {
-            $this->setOptions($options);
-        }
-    }
-
-    /**
-     * @return $this
-     */
-    public function setNullOnAllEmpty(bool $nullOnAllEmpty): self
-    {
-        $this->nullOnAllEmpty = $nullOnAllEmpty;
-        return $this;
-    }
-
-    public function isNullOnAllEmpty(): bool
-    {
-        return $this->nullOnAllEmpty;
-    }
-
-    /**
-     * @return $this
-     */
-    public function setNullOnEmpty(bool $nullOnEmpty): self
-    {
-        $this->nullOnEmpty = $nullOnEmpty;
-        return $this;
-    }
-
-    public function isNullOnEmpty(): bool
-    {
-        return $this->nullOnEmpty;
+        $this->nullOnEmpty    = $options['null_on_empty'] ?? false;
+        $this->nullOnAllEmpty = $options['null_on_all_empty'] ?? false;
     }
 
     /**
@@ -97,14 +65,14 @@ public function filter(mixed $value): mixed
 
         // Convert the date to a specific format
         if (
-            $this->isNullOnEmpty()
+            $this->nullOnEmpty
             && array_reduce($value, self::reduce(...), false)
         ) {
             return null;
         }
 
         if (
-            $this->isNullOnAllEmpty()
+            $this->nullOnAllEmpty
             && array_reduce($value, self::reduce(...), true)
         ) {
             return null;
@@ -118,6 +86,11 @@ public function filter(mixed $value): mixed
         return vsprintf($this->format, $value);
     }
 
+    public function __invoke(mixed $value): mixed
+    {
+        return $this->filter($value);
+    }
+
     /**
      * Ensures there are enough inputs in the array to properly format the date.
      *

diff --git a/src/AbstractFilter.php b/src/AbstractFilter.php
diff --git a/src/DateSelect.php b/src/DateSelect.php
@@ -8,7 +8,6 @@
  * @psalm-type Options = array{
  *     null_on_empty?: bool,
  *     null_on_all_empty?: bool,
- *     ...
  * }
  * @psalm-type InputArray = array{
  *      year: numeric,

diff --git a/src/DateTimeSelect.php b/src/DateTimeSelect.php
@@ -12,7 +12,6 @@
  * @psalm-type Options = array{
  *     null_on_empty?: bool,
  *     null_on_all_empty?: bool,
- *     ...
  * }
  * @psalm-type InputArray = array{
  *     year: numeric,
@@ -42,7 +41,7 @@ public function filter(mixed $value): mixed
         }
 
         if (
-            $this->isNullOnEmpty()
+            $this->nullOnEmpty
             && (
                 empty($value['year'])
                 || empty($value['month'])
@@ -56,7 +55,7 @@ public function filter(mixed $value): mixed
         }
 
         if (
-            $this->isNullOnAllEmpty()
+            $this->nullOnAllEmpty
             && (
                 empty($value['year'])
                 && empty($value['month'])

diff --git a/src/Dir.php b/src/Dir.php
@@ -9,16 +9,16 @@
 
 /**
  * @psalm-type Options = array{}
- * @extends AbstractFilter<Options>
+ * @implements FilterInterface<string>
  */
-final class Dir extends AbstractFilter
+final class Dir implements FilterInterface
 {
     /**
      * Defined by Laminas\Filter\FilterInterface
      *
      * Returns dirname($value)
      *
-     * @psalm-return ($value is scalar ? string : mixed)
+     * @psalm-return string
      */
     public function filter(mixed $value): mixed
     {
@@ -29,4 +29,9 @@ public function filter(mixed $value): mixed
 
         return dirname($value);
     }
+
+    public function __invoke(mixed $value): mixed
+    {
+        return $this->filter($value);
+    }
 }