Refactor DashToSeparator Filter

docs/book/v3/migration/v2-to-v3.md

@@ -48,6 +48,18 @@ The impact of the removal of these aliases will not affect you if you use a FQCN
 
 ### Changes to Individual Filters
 
+#### `DashToSeparator`
+
+The following methods have been removed:
+
+- `setOptions`
+- `getOptions`
+- `isOptions`
+- `setSeparator`
+- `getSeparator`
+
+The constructor now only accepts an associative array of [documented options](../word.md#dashToSeparator).
+
 #### `DenyList`
 
 The following methods have been removed:

docs/book/v3/word.md

@@ -106,8 +106,7 @@ The following options are supported for `Laminas\Filter\Word\DashToSeparator`:
 ### Basic Usage
 
 ```php
-$filter = new Laminas\Filter\Word\DashToSeparator('+');
-// or new Laminas\Filter\Word\CamelCaseToSeparator(array('separator' => '+'));
+$filter = new Laminas\Filter\Word\DashToSeparator('separator' => '+');
 
 print $filter->filter('this-is-my-content');
 ```

src/Word/DashToSeparator.php

@@ -5,10 +5,8 @@
 namespace Laminas\Filter\Word;
 
 use Laminas\Filter\FilterInterface;
+use Laminas\Filter\ScalarOrArrayFilterCallback;
 
-use function array_map;
-use function is_array;
-use function is_scalar;
 use function str_replace;
 
 /**
@@ -17,24 +15,16 @@
  *     ...
  * }
  * @template TOptions of Options
- * @implements FilterInterface<mixed>
+ * @implements FilterInterface<string|array<array-key, string|mixed>>
  */
 final class DashToSeparator implements FilterInterface
 {
-    protected string $separator = ' ';
+    private readonly string $separator;
 
-    /**
-     * @param Options|string $separator Space by default
-     */
-    public function __construct(string|array $separator = ' ')
+    /** @param Options $options */
+    public function __construct(array $options = [])
     {
-        if (is_array($separator) && isset($separator['separator'])) {
-            $this->setSeparator($separator['separator']);
-
-            return;
-        }
-
-        $this->setSeparator($separator);
+        $this->separator = $options['separator'] ?? ' ';
     }
 
     public function __invoke(mixed $value): mixed
@@ -44,36 +34,9 @@ public function __invoke(mixed $value): mixed
 
     public function filter(mixed $value): mixed
     {
-        if (! is_array($value)) {
-            if (! is_scalar($value)) {
-                return $value;
-            }
-            return $this->filterNormalizedValue((string) $value);
-        }
-
-        return $this->filterNormalizedValue(
-            array_map(static fn($item) => is_scalar($item) ? (string) $item : $item, $value)
+        return ScalarOrArrayFilterCallback::applyRecursively(
+            $value,
+            fn (string $input): string => str_replace('-', $this->separator, $input)
         );
     }
-
-    /**
-     * @param  string|string[] $value
-     * @return string|string[]
-     */
-    private function filterNormalizedValue($value)
-    {
-        return str_replace('-', $this->separator, $value);
-    }
-
-    /** @return $this */
-    public function setSeparator(string $separator): self
-    {
-        $this->separator = $separator;
-        return $this;
-    }
-
-    public function getSeparator(): string
-    {
-        return $this->separator;
-    }
 }

test/Word/DashToSeparatorTest.php

@@ -24,7 +24,7 @@ public function testFilterSeparatesDashedWordsWithDefaultSpaces(): void
     public function testFilterSeparatesDashedWordsWithSomeString(): void
     {
         $string   = 'dash-separated-words';
-        $filter   = new DashToSeparatorFilter(':-:');
+        $filter   = new DashToSeparatorFilter(['separator' => ':-:']);
         $filtered = $filter($string);
 
         self::assertNotEquals($string, $filtered);