Migrate to PHPStan

Author: tvdijen

.github/workflows/php.yml

@@ -50,10 +50,9 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           # Should be the higest supported version, so we can use the newest tools
-          php-version: '8.3'
-          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, pdo, posix, spl, xml
+          php-version: '8.4'
+          tools: composer, composer-require-checker, composer-unused, phpcs, phpstan
+          extensions: ctype, date, dom, fileinfo, filter, hash, intl, mbstring, openssl, pcre, pdo, posix, spl, xml
 
       - name: Setup problem matchers for PHP
         run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
@@ -85,27 +84,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
@@ -156,7 +141,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.1', '8.2', '8.3']
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
 
     steps:
       - name: Setup PHP, with composer and extensions
@@ -196,15 +181,15 @@ jobs:
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
       - name: Run unit tests with coverage
-        if: ${{ matrix.php-versions == '8.3' }}
+        if: ${{ matrix.php-versions == '8.4' }}
         run: vendor/bin/phpunit
 
       - name: Run unit tests (no coverage)
-        if: ${{ matrix.php-versions != '8.3' }}
+        if: ${{ matrix.php-versions != '8.4' }}
         run: vendor/bin/phpunit --no-coverage
 
       - name: Save coverage data
-        if: ${{ matrix.php-versions == '8.3' }}
+        if: ${{ matrix.php-versions == '8.4' }}
         uses: actions/upload-artifact@v4
         with:
           name: coverage-data
@@ -218,7 +203,7 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [windows-latest]
-        php-versions: ['8.1', '8.2', '8.3']
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
 
     steps:
       - name: Setup PHP, with composer and extensions

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Strict comparison using \\=\\=\\= between mixed and null will always evaluate to false\\.$#"
+			count: 1
+			path: src/Auth/Source/PasswordVerify.php

phpstan-dev.neon

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

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+  level: 5
+  paths:
+    - src
+includes:
+  - phpstan-baseline.neon

psalm-dev.xml

@@ -142,7 +142,7 @@ protected function login(string $username, string $password): array
                  * This should never happen as the count(data) test above would have already thrown.
                  * But checking twice doesn't hurt.
                  */
-                if (is_null($pwhash)) {
+                if ($pwhash === null) {
                     if ($pwhash != $row[$this->passwordhashcolumn]) {
                         Logger::error(sprintf(
                             'sqlauth:%s: column `%s` does not contain a password hash.',

psalm.xml

@@ -158,12 +158,12 @@ protected function connect(): PDO
     /**
      * Extract SQL columns into SAML attribute array
      *
-     * @param $attributes output place to store extracted attributes
+     * @param array $attributes output place to store extracted attributes
      * @param array  $data  Associative array from database in the format of PDO fetchAll
      * @param array  $forbiddenAttributes An array of attributes to never return
-     * @return $attributes
+     * @return array $attributes
      */
-    protected function extractAttributes(&$attributes, $data, $forbiddenAttributes = [])
+    protected function extractAttributes(array $attributes, array $data, array $forbiddenAttributes = []): array
     {
         foreach ($data as $row) {
             foreach ($row as $name => $value) {
@@ -195,8 +195,8 @@ protected function extractAttributes(&$attributes, $data, $forbiddenAttributes =
      * Execute the query with given parameters and return the tuples that result.
      *
      * @param string $query  SQL to execute
-     * @param array  $params parameters to the SQL query
-     * @return tuples that result
+     * @param array $params parameters to the SQL query
+     * @return array tuples that result
      */
     protected function executeQuery(PDO $db, string $query, array $params): array
     {