chore: Setup PHPStan Level 5

.editorconfig

@@ -20,3 +20,6 @@ indent_size = 4
 
 [tsconfig.json]
 indent_size = 2
+
+[*.neon]
+indent_style = tab

.github/workflows/REUSABLE_backend.yml

@@ -9,6 +9,12 @@ on:
         default: true
         required: false
 
+      enable_phpstan:
+        description: "Enable PHPStan Static Analysis?"
+        type: boolean
+        default: false
+        required: false
+
       backend_directory:
         description: The directory of the project where backend code is located. This should contain a `composer.json` file, and is generally the root directory of the repo.
         type: string
@@ -110,3 +116,33 @@ jobs:
         working-directory: ${{ inputs.backend_directory }}
         env:
           COMPOSER_PROCESS_TIMEOUT: 600
+
+  phpstan:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ${{ fromJSON(inputs.php_versions) }}
+
+    name: 'PHPStan PHP ${{ matrix.php }}'
+
+    if: inputs.enable_phpstan
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: xdebug
+          extensions: curl, dom, gd, json, mbstring, openssl, pdo_mysql, tokenizer, zip
+          tools: phpunit, composer:v2
+          ini-values: ${{ inputs.php_ini_values }}
+
+      - name: Install Composer dependencies
+        run: composer install
+        working-directory: ${{ inputs.backend_directory }}
+
+      - name: Run PHPStan
+        run: composer analyse:phpstan

.github/workflows/phpstan.yml

@@ -0,0 +1,12 @@
+name: Framework PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: ./.github/workflows/REUSABLE_backend.yml
+    with:
+      enable_backend_testing: false
+      enable_phpstan: true
+
+      backend_directory: .

composer.json

@@ -140,8 +140,8 @@
     "require-dev": {
         "mockery/mockery": "^1.4",
         "phpunit/phpunit": "^9.0",
-        "phpstan/phpstan-php-parser": "^1.0",
-        "phpstan/phpstan": "^1.2"
+        "phpstan/phpstan": "^1.2",
+        "nunomaduro/larastan": "^1.0"
     },
     "config": {
         "sort-packages": true
@@ -178,5 +178,11 @@
                 "extension.neon"
             ]
         }
+    },
+    "scripts": {
+        "analyse:phpstan": "phpstan analyse"
+    },
+    "scripts-descriptions": {
+        "analyse:phpstan": "Run static analysis"
     }
 }

framework/core/src/Admin/Content/AdminPayload.php

@@ -42,6 +42,11 @@ class AdminPayload
      */
     protected $db;
 
+    /**
+     * @var Dispatcher
+     */
+    protected $events;
+
     /**
      * @param Container $container
      * @param SettingsRepositoryInterface $settings

framework/core/src/Api/Client.php

@@ -11,7 +11,6 @@
 
 use Flarum\Http\RequestUtil;
 use Flarum\User\User;
-use Illuminate\Contracts\Container\Container;
 use Laminas\Diactoros\ServerRequestFactory;
 use Laminas\Diactoros\Uri;
 use Laminas\Stratigility\MiddlewarePipeInterface;
@@ -26,12 +25,12 @@ class Client
     protected $pipe;
 
     /**
-     * @var User
+     * @var User|null
      */
     protected $actor;
 
     /**
-     * @var ServerRequestInterface
+     * @var ServerRequestInterface|null
      */
     protected $parent;
 
@@ -45,9 +44,6 @@ class Client
      */
     protected $body = [];
 
-    /**
-     * @param Container $container
-     */
     public function __construct(MiddlewarePipeInterface $pipe)
     {
         $this->pipe = $pipe;

framework/core/src/Api/Controller/AbstractSerializeController.php

@@ -88,7 +88,7 @@ abstract class AbstractSerializeController implements RequestHandlerInterface
     protected static $beforeSerializationCallbacks = [];
 
     /**
-     * @var string[]
+     * @var string[][]
      */
     protected static $loadRelations = [];
 

framework/core/src/Api/Controller/ListNotificationsController.php

@@ -113,15 +113,15 @@ private function loadSubjectDiscussions(array $notifications)
         $ids = [];
 
         foreach ($notifications as $notification) {
-            if ($notification->subject && $notification->subject->discussion_id) {
+            if ($notification->subject && isset($notification->subject->discussion_id)) {
                 $ids[] = $notification->subject->discussion_id;
             }
         }
 
-        $discussions = Discussion::find(array_unique($ids));
+        $discussions = Discussion::query()->find(array_unique($ids));
 
         foreach ($notifications as $notification) {
-            if ($notification->subject && $notification->subject->discussion_id) {
+            if ($notification->subject && isset($notification->subject->discussion_id)) {
                 $notification->subject->setRelation('discussion', $discussions->find($notification->subject->discussion_id));
             }
         }

framework/core/src/Api/Serializer/AbstractSerializer.php

@@ -42,12 +42,12 @@ abstract class AbstractSerializer extends BaseAbstractSerializer
     protected static $container;
 
     /**
-     * @var callable[]
+     * @var array<string, callable[]>
      */
     protected static $attributeMutators = [];
 
     /**
-     * @var array
+     * @var array<string, array<string, callable>>
      */
     protected static $customRelations = [];
 
@@ -189,12 +189,12 @@ public function hasMany($model, $serializer, $relation = null)
      * @param string|Closure|\Tobscure\JsonApi\SerializerInterface $serializer
      * @param string|null $relation
      * @param bool $many
-     * @return Relationship
+     * @return Relationship|null
      */
     protected function buildRelationship($model, $serializer, $relation = null, $many = false)
     {
         if (is_null($relation)) {
-            list(, , $caller) = debug_backtrace(false, 3);
+            list(, , $caller) = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 3);
 
             $relation = $caller['function'];
         }
@@ -210,6 +210,8 @@ protected function buildRelationship($model, $serializer, $relation = null, $man
 
             return new Relationship($element);
         }
+
+        return null;
     }
 
     /**

framework/core/src/Api/Serializer/ExtensionReadmeSerializer.php

@@ -12,7 +12,8 @@
 class ExtensionReadmeSerializer extends AbstractSerializer
 {
     /**
-     * {@inheritdoc}
+     * @param \Flarum\Extension\Extension $extension
+     * @return array
      */
     protected function getDefaultAttributes($extension)
     {

framework/core/src/Api/Serializer/ForumSerializer.php

@@ -15,6 +15,7 @@
 use Flarum\Settings\SettingsRepositoryInterface;
 use Illuminate\Contracts\Filesystem\Cloud;
 use Illuminate\Contracts\Filesystem\Factory;
+use Illuminate\Contracts\Filesystem\Filesystem;
 
 class ForumSerializer extends AbstractSerializer
 {
@@ -39,7 +40,7 @@ class ForumSerializer extends AbstractSerializer
     protected $url;
 
     /**
-     * @var Cloud
+     * @var Filesystem
      */
     protected $assetsFilesystem;
 
@@ -62,7 +63,7 @@ public function __construct(Config $config, Factory $filesystemFactory, Settings
      */
     public function getId($model)
     {
-        return 1;
+        return '1';
     }
 
     /**
@@ -132,6 +133,9 @@ protected function getFaviconUrl()
 
     public function getAssetUrl($assetPath): string
     {
-        return $this->assetsFilesystem->url($assetPath);
+        /** @var Cloud $assetsFilesystem */
+        $assetsFilesystem = $this->assetsFilesystem;
+
+        return $assetsFilesystem->url($assetPath);
     }
 }

framework/core/src/Console/Schedule.php

@@ -18,17 +18,20 @@ class Schedule extends LaravelSchedule
     public function dueEvents($container)
     {
         return (new Collection($this->events))->filter->isDue(new class($container) {
+            /** @var Config */
+            protected $config;
+
             public function __construct($container)
             {
                 $this->config = $container->make(Config::class);
             }
 
-            public function isDownForMaintenance()
+            public function isDownForMaintenance(): bool
             {
                 return $this->config->inMaintenanceMode();
             }
 
-            public function environment()
+            public function environment(): string
             {
                 return '';
             }

framework/core/src/Database/AbstractModel.php

@@ -20,6 +20,8 @@
  * Adds the ability for custom relations to be added to a model during runtime.
  * These relations behave in the same way that you would expect; they can be
  * queried, eager loaded, and accessed as an attribute.
+ *
+ * @property-read int|null $id
  */
 abstract class AbstractModel extends Eloquent
 {
@@ -82,7 +84,7 @@ public static function boot()
     /**
      * {@inheritdoc}
      */
-    public function __construct(array $attributes = [])
+    final public function __construct(array $attributes = [])
     {
         $this->attributes = [];
 

framework/core/src/Database/Console/GenerateDumpCommand.php

@@ -12,6 +12,7 @@
 use Flarum\Console\AbstractCommand;
 use Flarum\Foundation\Paths;
 use Illuminate\Database\Connection;
+use Illuminate\Database\MySqlConnection;
 
 class GenerateDumpCommand extends AbstractCommand
 {
@@ -53,7 +54,7 @@ protected function configure()
     protected function fire()
     {
         $dumpPath = __DIR__.'/../../../migrations/install.dump';
-        /** @var Connection */
+        /** @var Connection&MySqlConnection */
         $connection = resolve('db.connection');
 
         $connection

framework/core/src/Database/DatabaseMigrationRepository.php

@@ -9,14 +9,14 @@
 
 namespace Flarum\Database;
 
-use Illuminate\Database\ConnectionInterface;
+use Illuminate\Database\Connection;
 
 class DatabaseMigrationRepository implements MigrationRepositoryInterface
 {
     /**
      * The name of the database connection to use.
      *
-     * @var ConnectionInterface
+     * @var Connection
      */
     protected $connection;
 
@@ -30,10 +30,10 @@ class DatabaseMigrationRepository implements MigrationRepositoryInterface
     /**
      * Create a new database migration repository instance.
      *
-     * @param  \Illuminate\Database\ConnectionInterface $connection
-     * @param  string                                   $table
+     * @param  Connection $connection
+     * @param  string $table
      */
-    public function __construct(ConnectionInterface $connection, $table)
+    public function __construct(Connection $connection, $table)
     {
         $this->connection = $connection;
         $this->table = $table;

framework/core/src/Database/DatabaseServiceProvider.php

@@ -23,6 +23,7 @@ class DatabaseServiceProvider extends AbstractServiceProvider
     public function register()
     {
         $this->container->singleton(Manager::class, function (Container $container) {
+            /** @var \Illuminate\Container\Container $container */
             $manager = new Manager($container);
 
             $config = $container['flarum']->config('database');