Merge pull request #42 from internalsystemerror/hotfix/string-casting

Fix fatal errors due to strict types in string filters
laminas · Dec 23, 2021 · 79e8baa · 79e8baa
2 parents 67d88c4 + a3f9227
commit 79e8baa
Show file tree

Hide file tree

Showing 77 changed files with 1,254 additions and 1,471 deletions.
diff --git a/composer.json b/composer.json
@@ -16,7 +16,11 @@
         "forum": "https://discourse.laminas.dev"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "composer/package-versions-deprecated": true
+        }
     },
     "extra": {
         "laminas": {

diff --git a/src/AbstractFilter.php b/src/AbstractFilter.php
@@ -8,10 +8,12 @@
 use Traversable;
 
 use function array_key_exists;
+use function array_map;
 use function get_class;
 use function gettype;
 use function is_array;
 use function is_object;
+use function is_scalar;
 use function method_exists;
 use function sprintf;
 use function str_replace;
@@ -103,4 +105,21 @@ protected static function isOptions($options)
     {
         return is_array($options) || $options instanceof Traversable;
     }
+
+    /**
+     * @internal
+     *
+     * @param  mixed $value
+     * @return mixed
+     */
+    protected static function applyFilterOnlyToStringableValuesAndStringableArrayValues($value, callable $callback)
+    {
+        if (! is_array($value)) {
+            if (! is_scalar($value)) {
+                return $value;
+            }
+            return $callback((string) $value);
+        }
+        return $callback(array_map(fn($item) => is_scalar($item) ? (string) $item : $item, $value));
+    }
 }
diff --git a/src/Encrypt/Openssl.php b/src/Encrypt/Openssl.php
@@ -503,6 +503,7 @@ private function freeKeyResources(array $keys): void
     {
         if (PHP_VERSION_ID < 80000) {
             foreach ($keys as $key) {
+                // phpcs:ignore Generic.PHP.DeprecatedFunctions.Deprecated
                 openssl_free_key($key);
             }
         }

diff --git a/src/PregReplace.php b/src/PregReplace.php
@@ -4,14 +4,14 @@
 
 namespace Laminas\Filter;
 
+use Closure;
 use Traversable;
 
 use function func_get_args;
 use function get_class;
 use function gettype;
 use function is_array;
 use function is_object;
-use function is_scalar;
 use function is_string;
 use function iterator_to_array;
 use function preg_match;
@@ -137,18 +137,31 @@ public function getReplacement()
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
 
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         if ($this->options['pattern'] === null) {
             throw new Exception\RuntimeException(sprintf(
                 'Filter %s does not have a valid pattern set',
                 static::class
             ));
         }
 
-        return preg_replace($this->options['pattern'], $this->options['replacement'], $value);
+        /** @var string|string[] $pattern */
+        $pattern = $this->options['pattern'];
+        /** @var string|string[] $replacement */
+        $replacement = $this->options['replacement'];
+
+        return preg_replace($pattern, $replacement, $value);
     }
 
     /**

diff --git a/src/StripNewlines.php b/src/StripNewlines.php
@@ -4,8 +4,8 @@
 
 namespace Laminas\Filter;
 
-use function is_array;
-use function is_scalar;
+use Closure;
+
 use function str_replace;
 
 class StripNewlines extends AbstractFilter
@@ -15,14 +15,23 @@ class StripNewlines extends AbstractFilter
      *
      * Returns $value without newline control characters
      *
-     * @param  string|array $value
-     * @return string|array
+     * @param  mixed $value
+     * @return mixed
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
+
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         return str_replace(["\n", "\r"], '', $value);
     }
 }
diff --git a/src/Word/CamelCaseToSeparator.php b/src/Word/CamelCaseToSeparator.php
@@ -4,26 +4,33 @@
 
 namespace Laminas\Filter\Word;
 
+use Closure;
 use Laminas\Stdlib\StringUtils;
 
-use function is_array;
-use function is_scalar;
 use function preg_replace;
 
 class CamelCaseToSeparator extends AbstractSeparator
 {
     /**
      * Defined by Laminas\Filter\Filter
      *
-     * @param  string|array $value
-     * @return string|array
+     * @param  mixed $value
+     * @return mixed
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
 
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         if (StringUtils::hasPcreUnicodeSupport()) {
             $pattern     = ['#(?<=(?:\p{Lu}))(\p{Lu}\p{Ll})#', '#(?<=(?:\p{Ll}|\p{Nd}))(\p{Lu})#'];
             $replacement = [$this->separator . '\1', $this->separator . '\1'];

diff --git a/src/Word/DashToSeparator.php b/src/Word/DashToSeparator.php
@@ -4,24 +4,32 @@
 
 namespace Laminas\Filter\Word;
 
-use function is_array;
-use function is_scalar;
+use Closure;
+
 use function str_replace;
 
 class DashToSeparator extends AbstractSeparator
 {
     /**
      * Defined by Laminas\Filter\Filter
      *
-     * @param  string|array $value
-     * @return string|array
+     * @param  mixed $value
+     * @return mixed
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
 
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         return str_replace('-', $this->separator, $value);
     }
 }
diff --git a/src/Word/SeparatorToCamelCase.php b/src/Word/SeparatorToCamelCase.php
@@ -4,11 +4,10 @@
 
 namespace Laminas\Filter\Word;
 
+use Closure;
 use Laminas\Stdlib\StringUtils;
 
 use function extension_loaded;
-use function is_array;
-use function is_scalar;
 use function preg_quote;
 use function preg_replace_callback;
 
@@ -17,15 +16,23 @@ class SeparatorToCamelCase extends AbstractSeparator
     /**
      * Defined by Laminas\Filter\Filter
      *
-     * @param  string|array $value
-     * @return string|array
+     * @param  mixed $value
+     * @return mixed
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
 
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         // a unicode safe way of converting characters to \x00\x00 notation
         $pregQuotedSeparator = preg_quote($this->separator, '#');
 

diff --git a/src/Word/SeparatorToSeparator.php b/src/Word/SeparatorToSeparator.php
@@ -4,11 +4,10 @@
 
 namespace Laminas\Filter\Word;
 
+use Closure;
 use Laminas\Filter\AbstractFilter;
 use Laminas\Filter\Exception;
 
-use function is_array;
-use function is_scalar;
 use function preg_quote;
 use function preg_replace;
 
@@ -78,20 +77,31 @@ public function getReplacementSeparator()
      *
      * Returns the string $value, replacing the searched separators with the defined ones
      *
-     * @param  string|array $value
-     * @return string|array
+     * @param  mixed $value
+     * @return mixed
      */
     public function filter($value)
     {
-        if (! is_scalar($value) && ! is_array($value)) {
-            return $value;
-        }
+        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
+            $value,
+            Closure::fromCallable([$this, 'filterNormalizedValue'])
+        );
+    }
 
+    /**
+     * @param  string|string[] $value
+     * @return string|string[]
+     */
+    private function filterNormalizedValue($value)
+    {
         if ($this->searchSeparator === null) {
             throw new Exception\RuntimeException('You must provide a search separator for this filter to work.');
         }
 
-        $pattern = '#' . preg_quote($this->searchSeparator, '#') . '#';
-        return preg_replace($pattern, $this->replacementSeparator, $value);
+        return preg_replace(
+            '#' . preg_quote($this->searchSeparator, '#') . '#',
+            $this->replacementSeparator,
+            $value
+        );
     }
 }
diff --git a/src/Word/UnderscoreToStudlyCase.php b/src/Word/UnderscoreToStudlyCase.php
@@ -28,6 +28,7 @@ public function filter($value)
             return $value;
         }
 
+        /** @var string|array $value */
         $value          = parent::filter($value);
         $lowerCaseFirst = 'lcfirst';
 

diff --git a/test/AllowListTest.php b/test/AllowListTest.php
@@ -24,16 +24,16 @@ public function testConstructorOptions(): void
             'strict' => true,
         ]);
 
-        $this->assertEquals(true, $filter->getStrict());
-        $this->assertEquals(['test', 1], $filter->getList());
+        $this->assertSame(true, $filter->getStrict());
+        $this->assertSame(['test', 1], $filter->getList());
     }
 
     public function testConstructorDefaults(): void
     {
         $filter = new AllowListFilter();
 
-        $this->assertEquals(false, $filter->getStrict());
-        $this->assertEquals([], $filter->getList());
+        $this->assertSame(false, $filter->getStrict());
+        $this->assertSame([], $filter->getList());
     }
 
     public function testWithPluginManager(): void
@@ -59,7 +59,7 @@ public function testTraversableConvertsToArray(): void
         $filter = new AllowListFilter([
             'list' => $obj,
         ]);
-        $this->assertEquals($array, $filter->getList());
+        $this->assertSame($array, $filter->getList());
     }
 
     public function testSetStrictShouldCastToBoolean(): void

diff --git a/test/BaseNameTest.php b/test/BaseNameTest.php
@@ -12,18 +12,16 @@ class BaseNameTest extends TestCase
 {
     /**
      * Ensures that the filter follows expected behavior
-     *
-     * @return void
      */
-    public function testBasic()
+    public function testBasic(): void
     {
         $filter         = new BaseNameFilter();
         $valuesExpected = [
             '/path/to/filename'     => 'filename',
             '/path/to/filename.ext' => 'filename.ext',
         ];
         foreach ($valuesExpected as $input => $output) {
-            $this->assertEquals($output, $filter($input));
+            $this->assertSame($output, $filter($input));
         }
     }
 
@@ -43,12 +41,11 @@ public function returnUnfilteredDataProvider()
 
     /**
      * @dataProvider returnUnfilteredDataProvider
-     * @return void
      */
-    public function testReturnUnfiltered($input)
+    public function testReturnUnfiltered($input): void
     {
         $filter = new BaseNameFilter();
 
-        $this->assertEquals($input, $filter($input));
+        $this->assertSame($input, $filter($input));
     }
 }