chore: enable phpstan, apply fixes

.github/workflows/backend.yml

@@ -7,5 +7,6 @@ jobs:
     uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
     with:
       enable_backend_testing: true
+      enable_phpstan: true
 
       backend_directory: .

composer.json

@@ -76,15 +76,19 @@
         ],
         "test:unit": "phpunit -c tests/phpunit.unit.xml",
         "test:integration": "phpunit -c tests/phpunit.integration.xml",
-        "test:setup": "@php tests/integration/setup.php"
+        "test:setup": "@php tests/integration/setup.php",
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
     },
     "scripts-descriptions": {
         "test": "Runs all tests.",
         "test:unit": "Runs all unit tests.",
         "test:integration": "Runs all integration tests.",
-        "test:setup": "Sets up a database for use with integration tests. Execute this only once."
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once.",
+        "analyse:phpstan": "Run static analysis"
     },
     "require-dev": {
-        "flarum/testing": "^1.0.0"
+        "flarum/testing": "^1.0.0",
+        "flarum/phpstan": "*"
     }
 }

extend.php

@@ -61,7 +61,7 @@
         ->modelPolicy(User::class, Access\UserPolicy::class),
 
     (new Extend\ApiSerializer(Serializer\PostSerializer::class))
-        ->attributes(function (AbstractSerializer $serializer, AbstractModel $post, array $attributes): array {
+        ->attributes(function (AbstractSerializer $serializer, Post $post, array $attributes): array {
             $attributes['canBanIP'] = $serializer->getActor()->can('banIP', $post->user);
 
             return $attributes;
@@ -95,7 +95,7 @@
     (new Extend\ApiController(Controller\ListPostsController::class))
         ->addInclude(['banned_ip', 'banned_ip.user']),
 
-    (new Extend\ApiController(Controller\ShowPostsController::class))
+    (new Extend\ApiController(Controller\ShowPostController::class))
         ->addInclude(['banned_ip', 'banned_ip.user']),
 
     (new Extend\ApiController(Controller\CreatePostController::class))

phpstan.neon

@@ -0,0 +1,13 @@
+includes:
+  - vendor/flarum/phpstan/extension.neon
+
+parameters:
+  # The level will be increased in Flarum 2.0
+  level: 5
+  paths:
+    - extend.php
+    - src
+  excludePaths:
+    - *.blade.php
+  checkMissingIterableValueType: false
+  databaseMigrationsPath: ['migrations']

src/Commands/BanUserHandler.php

@@ -16,17 +16,11 @@
 use FoF\BanIPs\Events\IPWasBanned;
 use FoF\BanIPs\Repositories\BannedIPRepository;
 use FoF\BanIPs\Validators\BannedIPValidator;
-use Illuminate\Contracts\Bus\Dispatcher;
 use Illuminate\Events\Dispatcher as DispatcherEvents;
 use Illuminate\Support\Arr;
 
 class BanUserHandler
 {
-    /**
-     * @var Dispatcher
-     */
-    private $bus;
-
     /**
      * @var DispatcherEvents
      */
@@ -43,14 +37,12 @@ class BanUserHandler
     private $validator;
 
     /**
-     * @param Dispatcher         $bus
      * @param DispatcherEvents   $events
      * @param BannedIPRepository $bannedIPs
      * @param BannedIPValidator  $validator
      */
-    public function __construct(Dispatcher $bus, DispatcherEvents $events, BannedIPRepository $bannedIPs, BannedIPValidator $validator)
+    public function __construct(DispatcherEvents $events, BannedIPRepository $bannedIPs, BannedIPValidator $validator)
     {
-        $this->bus = $bus;
         $this->events = $events;
         $this->bannedIPs = $bannedIPs;
         $this->validator = $validator;

src/Commands/DeleteBannedIPHandler.php

@@ -26,11 +26,6 @@ public function __construct(BannedIPRepository $bannedIPs)
         $this->bannedIPs = $bannedIPs;
     }
 
-    /**
-     * @param DeleteBannedIP $command
-     *
-     * @return BanIP
-     */
     public function handle(DeleteBannedIP $command)
     {
         /**

src/Commands/EditBannedIPHandler.php

@@ -15,29 +15,21 @@
 use Flarum\User\Exception\PermissionDeniedException;
 use Flarum\User\User;
 use FoF\BanIPs\BannedIP;
-use FoF\BanIPs\Repositories\BannedIPRepository;
 use FoF\BanIPs\Validators\BannedIPValidator;
 use Illuminate\Support\Arr;
 
 class EditBannedIPHandler
 {
-    /**
-     * @var BannedIPRepository
-     */
-    private $bannedIPs;
-
     /**
      * @var BannedIPValidator
      */
     private $validator;
 
     /**
-     * @param BannedIPRepository $bannedIPs
      * @param BannedIPValidator  $validator
      */
-    public function __construct(BannedIPRepository $bannedIPs, BannedIPValidator $validator)
+    public function __construct(BannedIPValidator $validator)
     {
-        $this->bannedIPs = $bannedIPs;
         $this->validator = $validator;
     }
 

src/Commands/UnbanUserHandler.php

@@ -14,17 +14,10 @@
 use Flarum\User\User;
 use FoF\BanIPs\Events\IPWasUnbanned;
 use FoF\BanIPs\Repositories\BannedIPRepository;
-use FoF\BanIPs\Validators\BannedIPValidator;
-use Illuminate\Contracts\Bus\Dispatcher;
 use Illuminate\Events\Dispatcher as DispatcherEvents;
 
 class UnbanUserHandler
 {
-    /**
-     * @var Dispatcher
-     */
-    private $bus;
-
     /**
      * @var DispatcherEvents
      */
@@ -36,26 +29,17 @@ class UnbanUserHandler
     private $bannedIPs;
 
     /**
-     * @var BannedIPValidator
-     */
-    private $validator;
-
-    /**
-     * @param Dispatcher         $bus
      * @param DispatcherEvents   $events
      * @param BannedIPRepository $bannedIPs
-     * @param BannedIPValidator  $validator
      */
-    public function __construct(Dispatcher $bus, DispatcherEvents $events, BannedIPRepository $bannedIPs, BannedIPValidator $validator)
+    public function __construct(DispatcherEvents $events, BannedIPRepository $bannedIPs)
     {
-        $this->bus = $bus;
         $this->events = $events;
         $this->bannedIPs = $bannedIPs;
-        $this->validator = $validator;
     }
 
     /**
-     * @param BanUser $command
+     * @param UnbanUser $command
      *
      * @return mixed
      */

src/Listeners/RemoveAccessToBannedUsers.php

@@ -11,7 +11,6 @@
 
 namespace FoF\BanIPs\Listeners;
 
-use Flarum\Http\SessionAuthenticator;
 use Flarum\User\User;
 use FoF\BanIPs\Events\IPWasBanned;
 use FoF\BanIPs\Repositories\BannedIPRepository;
@@ -23,14 +22,8 @@ class RemoveAccessToBannedUsers
      */
     private $bannedIPs;
 
-    /**
-     * @var SessionAuthenticator
-     */
-    private $authenticator;
-
-    public function __construct(SessionAuthenticator $authenticator, BannedIPRepository $bannedIPs)
+    public function __construct(BannedIPRepository $bannedIPs)
     {
-        $this->authenticator = $authenticator;
         $this->bannedIPs = $bannedIPs;
     }
 

src/Repositories/BannedIPRepository.php

@@ -31,7 +31,7 @@ class BannedIPRepository
     private static $ips = [];
 
     /**
-     * Get a new query builder for the pages table.
+     * Get a new query builder for the banned IP table.
      *
      * @return Builder
      */
@@ -47,8 +47,6 @@ public function query()
      * @param User $actor
      *
      * @throws ModelNotFoundException
-     *
-     * @return BannedIP
      */
     public function findOrFail($id, User $actor = null)
     {
@@ -111,7 +109,7 @@ public function findUsers($ips)
      */
     public function isUserBanned(User $user)
     {
-        if (Arr::has(self::$bans, $user->id)) {
+        if (Arr::has(self::$bans, [$user->id])) {
             return (bool) self::$bans[$user->id];
         }
 
@@ -120,7 +118,7 @@ public function isUserBanned(User $user)
 
     public function getUserIPs(User $user): Collection
     {
-        if (Arr::has(self::$ips, $user->id)) {
+        if (Arr::has(self::$ips, [$user->id])) {
             return self::$ips[$user->id];
         }
 

src/Search/NxGambit.php

@@ -35,5 +35,6 @@ public function filter(FilterState $filterState, string $filterValue, bool $nega
     public function apply(SearchState $search, $bit)
     {
         // Does nothing
+        return false;
     }
 }