Merge pull request #13 from beatrycze-volk/return-type

Fix return for `getValues()`
slub · Apr 18, 2024 · 19bf0f0 · 19bf0f0
2 parents 4d678b6 + 0c2df12
commit 19bf0f0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.github/phpstan.neon b/.github/phpstan.neon
@@ -1,4 +1,7 @@
 parameters:
+    ignoreErrors:
+        - '#PHPDoc tag @var for property Slub\\Mods\\Element\\Xml\\Element::\$values with type array\|false is not subtype of native type array\.#'
+        - '#PHPDoc tag @return with type array\|false is not subtype of native type array\.#'
     level: 5
     paths:
         - ../src/

diff --git a/src/Mods/Element/Xml/Element.php b/src/Mods/Element/Xml/Element.php
@@ -64,12 +64,13 @@ public function exists(): bool
     }
 
     /**
-     * Get the value of the queried element
+     * Get the array of values of the queried element.
      *
      * @access public
      *
-     * @return array|false
+     * @return array|false array if element exists, false otherwise
      */
+    // TODO: change return type after upgrade to PHP 8.x
     public function getValues(): array
     {
         return $this->values;