Fix Psalm errors

laminas · Jan 2, 2025 · 7395ec0 · 7395ec0
1 parent a059191
commit 7395ec0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 46 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -319,29 +319,6 @@
       <code><![CDATA[Module]]></code>
     </UnusedClass>
   </file>
-  <file src="src/StripTags.php">
-    <DeprecatedClass>
-      <code><![CDATA[AbstractFilter]]></code>
-    </DeprecatedClass>
-    <MixedArgument>
-      <code><![CDATA[$options['allowAttribs']]]></code>
-      <code><![CDATA[$options['allowTags']]]></code>
-    </MixedArgument>
-    <MixedAssignment>
-      <code><![CDATA[$attribute]]></code>
-      <code><![CDATA[$element]]></code>
-      <code><![CDATA[$temp['allowAttribs']]]></code>
-      <code><![CDATA[$temp['allowComments']]]></code>
-      <code><![CDATA[$temp['allowTags']]]></code>
-    </MixedAssignment>
-    <PossiblyUndefinedVariable>
-      <code><![CDATA[$temp]]></code>
-    </PossiblyUndefinedVariable>
-    <RedundantConditionGivenDocblockType>
-      <code><![CDATA[is_array($options)]]></code>
-      <code><![CDATA[is_string($attribute)]]></code>
-    </RedundantConditionGivenDocblockType>
-  </file>
   <file src="src/Word/SeparatorToCamelCase.php">
     <MissingClosureParamType>
       <code><![CDATA[$matches]]></code>

diff --git a/src/StripTags.php b/src/StripTags.php
@@ -21,7 +21,7 @@
 
 /**
  * @psalm-type Options = array{
- *     allowTags?: array<string|list<string>>,
+ *     allowTags?: list<string>|array<string, list<string>>,
  *     allowAttribs?: list<string>
  * }
  * @implements FilterInterface<string>
@@ -60,8 +60,6 @@ public function __construct(array $options = [])
      * Defined by Laminas\Filter\FilterInterface
      *
      * If the value provided is non-scalar, the value will remain unfiltered
-     *
-     * @psalm-return ($value is scalar ? string : mixed)
      */
     public function filter(mixed $value): mixed
     {
@@ -117,6 +115,9 @@ public function __invoke(mixed $value): mixed
         return $this->filter($value);
     }
 
+    /**
+     * @param array<string|list<string>> $tagsAllowed
+     */
     private function setTagsAllowed(array $tagsAllowed): void
     {
         foreach ($tagsAllowed as $index => $element) {
@@ -126,22 +127,16 @@ private function setTagsAllowed(array $tagsAllowed): void
                 $tagName = strtolower($element);
                 // Store the tag as allowed with no attributes
                 $this->tagsAllowed[$tagName] = [];
-            } elseif (is_string($index) && (is_array($element) || is_string($element))) {
+            } elseif (is_string($index) && is_array($element)) {
                 // Otherwise, if a tag was provided with attributes
                 // Canonicalize the tag name
                 $tagName = strtolower($index);
-                // Canonicalize the attributes
-                if (is_string($element)) {
-                    $element = [$element];
-                }
                 // Store the tag as allowed with the provided attributes
                 $this->tagsAllowed[$tagName] = [];
                 foreach ($element as $attribute) {
-                    if (is_string($attribute)) {
-                        // Canonicalize the attribute name
-                        $attributeName                               = strtolower($attribute);
-                        $this->tagsAllowed[$tagName][$attributeName] = null;
-                    }
+                    // Canonicalize the attribute name
+                    $attributeName                               = strtolower($attribute);
+                    $this->tagsAllowed[$tagName][$attributeName] = null;
                 }
             }
         }
@@ -154,11 +149,9 @@ private function setAttributesAllowed(array $attributesAllowed): void
     {
         // Store each attribute as allowed
         foreach ($attributesAllowed as $attribute) {
-            if (is_string($attribute)) {
-                // Canonicalize the attribute name
-                $attributeName                           = strtolower($attribute);
-                $this->attributesAllowed[$attributeName] = null;
-            }
+            // Canonicalize the attribute name
+            $attributeName                           = strtolower($attribute);
+            $this->attributesAllowed[$attributeName] = null;
         }
     }
 

diff --git a/test/StripTagsTest.php b/test/StripTagsTest.php
@@ -123,7 +123,7 @@ public function testFilterTagAllowedAttribute(): void
     public function testFilterTagAllowedAttributeAllowed(): void
     {
         $filter   = new StripTagsFilter([
-            'allowTags' => ['img' => 'alt'],
+            'allowTags' => ['img' => ['alt']],
         ]);
         $input    = '<IMG ALT="FOO" />';
         $expected = '<img alt="FOO" />';
@@ -138,7 +138,7 @@ public function testFilterTagAllowedAttributeAllowed(): void
     public function testFilterTagAllowedAttributeAllowedGt(): void
     {
         $filter   = new StripTagsFilter([
-            'allowTags' => ['img' => 'alt'],
+            'allowTags' => ['img' => ['alt']],
         ]);
         $input    = '<img alt="$object->property" />';
         $expected = '<img>property" /';
@@ -151,7 +151,7 @@ public function testFilterTagAllowedAttributeAllowedGt(): void
     public function testFilterTagAllowedAttributeAllowedGtEscaped(): void
     {
         $filter   = new StripTagsFilter([
-            'allowTags' => ['img' => 'alt'],
+            'allowTags' => ['img' => ['alt']],
         ]);
         $input    = '<img alt="$object-&gt;property" />';
         $expected = '<img alt="$object-&gt;property" />';
@@ -242,7 +242,7 @@ public function testClosingAngleBracketInAllowedAttributeValue(): void
     {
         $filter   = new StripTagsFilter([
             'allowTags' => [
-                'a' => 'href',
+                'a' => ['href'],
             ],
         ]);
         $input    = '<a href="Some &gt; Text">';
@@ -259,7 +259,7 @@ public function testAllowedAttributeValueMayEndWithEquals(): void
     {
         $filter = new StripTagsFilter([
             'allowTags' => [
-                'element' => 'attribute',
+                'element' => ['attribute'],
             ],
         ]);
         $input  = '<element attribute="a=">contents</element>';