Migrate Psalm to PHPstan

Author: tvdijen

.github/workflows/php.yml

@@ -54,9 +54,8 @@ jobs:
         with:
           # Should be the higest supported version, so we can use the newest tools
           php-version: '8.4'
-          tools: composer, composer-require-checker, composer-unused, phpcs, psalm
-          # optional performance gain for psalm: opcache
-          extensions: ctype, date, dom, fileinfo, filter, hash, intl, mbstring, opcache, openssl, pcre, posix, spl, xml
+          tools: composer, composer-require-checker, composer-unused, phpcs, phpstan
+          extensions: ctype, date, dom, fileinfo, filter, hash, intl, mbstring, openssl, pcre, posix, spl, xml
 
       - name: Setup problem matchers for PHP
         run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
@@ -88,27 +87,13 @@ jobs:
       - name: PHP Code Sniffer
         run: phpcs
 
-      - name: Psalm
-        continue-on-error: true
-        run: |
-          psalm -c psalm.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
-
-      - name: Psalm (testsuite)
+      - name: PHPStan
         run: |
-          psalm -c psalm-dev.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
+          vendor/bin/phpstan analyze -c phpstan.neon --debug
 
-      - name: Psalter
+      - name: PHPStan (testsuite)
         run: |
-          psalm --alter \
-          --issues=UnnecessaryVarAnnotation \
-          --dry-run \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
+          vendor/bin/phpstan analyze -c phpstan-dev.neon --debug
 
   security:
     name: Security checks

phpstan-dev.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 9
+  paths:
+    - tests

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 6
+  paths:
+    - src

psalm-dev.xml

@@ -26,16 +26,16 @@ class Hash extends UserPassBase
      * Our users, stored in an associative array. The key of the array is "<username>:<passwordhash>",
      * while the value of each element is a new array with the attributes for each user.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     private array $users;
 
 
     /**
      * Constructor for this authentication source.
      *
-     * @param array $info Information about this authentication source.
-     * @param array $config Configuration.
+     * @param array<string, mixed> $info Information about this authentication source.
+     * @param array<string, mixed> $config Configuration.
      *
      * @throws \Exception in case of a configuration error.
      */
@@ -87,7 +87,7 @@ public function __construct(array $info, array $config)
      * @param string $username The username the user wrote.
      * @param string $password The password the user wrote.
      *
-     * @return array  Associative array with the users attributes.
+     * @return array<string, mixed> Associative array with the users attributes.
      *
      * @throws \SimpleSAML\Error\Error if authentication fails.
      */

psalm.xml

@@ -26,23 +26,23 @@ class Htpasswd extends UserPassBase
     /**
      * Our users, stored in an array, where each value is "<username>:<passwordhash>".
      *
-     * @var array
+     * @var array<int, mixed>
      */
     private array $users;
 
     /**
      * An array containing static attributes for our users.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     private array $attributes = [];
 
 
     /**
      * Constructor for this authentication source.
      *
-     * @param array $info Information about this authentication source.
-     * @param array $config Configuration.
+     * @param array<string, mixed> $info Information about this authentication source.
+     * @param array<string, mixed> $config Configuration.
      *
      * @throws \Exception if the htpasswd file is not readable or the static_attributes array is invalid.
      */
@@ -81,7 +81,7 @@ public function __construct(array $info, array $config)
      * @param string $username The username the user wrote.
      * @param string $password The password the user wrote.
      *
-     * @return array Associative array with the users attributes.
+     * @return array<string, mixed> Associative array with the users attributes.
      *
      * @throws \SimpleSAML\Error\Error if authentication fails.
      */