fix: phpstan (with some cheating - wip)

Author: imorland

extensions/realtime/src/Push/Discussion/NewActivity.php

@@ -20,7 +20,7 @@
 
 class NewActivity extends Subscriber
 {
-    public function subscribe(Dispatcher $events)
+    public function subscribe(Dispatcher $events): void
     {
         // Created and Posted both are lined up for dispatching
         // after saving by Discussion::create and CommentPost::reply
@@ -29,7 +29,10 @@ public function subscribe(Dispatcher $events)
         $this->listen(Posted::class, [$this, 'replied']);
 
         // Best answer setting or unsetting its best answer.
-        $this->listen([BestAnswer\BestAnswerSet::class, BestAnswer\BestAnswerUnset::class], [$this, 'bestAnswer']);
+        if (class_exists(BestAnswer\BestAnswerSet::class) && class_exists(BestAnswer\BestAnswerUnset::class)) {
+            /** @phpstan-ignore-next-line */
+            $this->listen([BestAnswer\BestAnswerSet::class, BestAnswer\BestAnswerUnset::class], [$this, 'bestAnswer']);
+        }
 
         // Locking or unlocking a discussion via `flarum/lock`.
         $this->listen([Lock\DiscussionWasLocked::class, Lock\DiscussionWasUnlocked::class], [$this, 'locked']);
@@ -50,7 +53,7 @@ public function started(Started $event)
         ));
     }
 
-    public function replied(Posted $event)
+    public function replied(Posted $event): void
     {
         // Prevent sending for the OP, because the Created event
         // was also fired.
@@ -65,7 +68,7 @@ public function replied(Posted $event)
         ));
     }
 
-    public function bestAnswer($event)
+    public function bestAnswer(object $event): void
     {
         $this->queue()->push(new SendTriggerJob(
             'bestAnswerMutation',
@@ -87,7 +90,7 @@ public function locked($event)
         ));
     }
 
-    public function renamed(Renamed $event)
+    public function renamed(Renamed $event): void
     {
         $this->queue()->push(new SendTriggerJob(
             'discussionRenamed',

extensions/realtime/src/Push/Jobs/SendDialogMessageJob.php

@@ -27,7 +27,7 @@ public function __construct(
         parent::__construct();
     }
 
-    public function __invoke(Queue $queue)
+    public function __invoke(Queue $queue): void
     {
         /** @var DialogMessage $message */
         $message = $this->model;
@@ -72,7 +72,7 @@ private function getConnectedDialogUsers(Dialog $dialog): Collection
         })->values();
     }
 
-    public function middleware()
+    public function middleware(): array
     {
         $key = sprintf(
             '%s:%s.%s',

extensions/realtime/src/Push/Jobs/SendFlaggedJob.php

@@ -19,7 +19,7 @@ public function __construct(private Discussion $discussion)
         parent::__construct();
     }
 
-    public function handle(Queue $queue)
+    public function handle(Queue $queue): void
     {
         $users = $this->connectedUsers($this->discussion);
 

extensions/realtime/src/Push/Jobs/SendGeneratedPayloadJob.php

@@ -22,7 +22,7 @@ public function __construct(private string $event, private AbstractModel $model,
         parent::__construct();
     }
 
-    public function handle(Generator $generator, Pusher $pusher)
+    public function handle(Generator $generator, Pusher $pusher): void
     {
         $channel = $this->recipient
             ? "private-user={$this->recipient->id}"
@@ -42,7 +42,7 @@ public function handle(Generator $generator, Pusher $pusher)
         );
     }
 
-    public function middleware()
+    public function middleware(): array
     {
         $key = sprintf(
             '%s:%s:%s-%s:%s',

extensions/realtime/src/Push/Jobs/SendNotificationsJob.php

@@ -21,7 +21,7 @@ public function __construct(private BlueprintInterface $blueprint, private array
         parent::__construct();
     }
 
-    public function handle(Queue $queue)
+    public function handle(Queue $queue): void
     {
         // Only dispatch notification jobs for users on the socket.
         $intersect = $this->connectedUsers()->intersect($this->recipients);

extensions/realtime/src/Push/Jobs/SendTriggerJob.php

@@ -25,7 +25,7 @@ public function __construct(
         parent::__construct();
     }
 
-    public function __invoke(Queue $queue)
+    public function __invoke(Queue $queue): void
     {
         // Resolve a discussion for use with `visibleTo` permission checks.
         if ($this->model instanceof Discussion) {
@@ -58,7 +58,7 @@ public function __invoke(Queue $queue)
         }
     }
 
-    public function middleware()
+    public function middleware(): array
     {
         $key = sprintf(
             '%s:%s.%s',

extensions/realtime/src/Push/Post/NewActivity.php

@@ -24,26 +24,33 @@
 
 class NewActivity extends Subscriber
 {
-    public function subscribe(Dispatcher $events)
+    public function subscribe(Dispatcher $events): void
     {
         $this->listen(Flagged::class, [$this, 'flagged']);
         $this->listen(FlagDismissed::class, [$this, 'flagged']);
 
         $this->listen(PostWasLiked::class, [$this, 'likes']);
         $this->listen(PostWasUnliked::class, [$this, 'likes']);
 
-        $this->listen(PostWasVoted::class, [$this, 'voted']);
+        if (class_exists(PostWasVoted::class)) {
+            /** @phpstan-ignore-next-line */
+            $this->listen(PostWasVoted::class, [$this, 'voted']);
+        }
 
-        $this->listen(PostWasReacted::class, [$this, 'reactions']);
-        $this->listen(PostWasUnreacted::class, [$this, 'reactions']);
+        if (class_exists(PostWasReacted::class) && class_exists(PostWasUnreacted::class)) {
+            /** @phpstan-ignore-next-line */
+            $this->listen(PostWasReacted::class, [$this, 'reactions']);
+            /** @phpstan-ignore-next-line */
+            $this->listen(PostWasUnreacted::class, [$this, 'reactions']);
+        }
 
         $this->listen(Revised::class, [$this, 'revised']);
     }
 
     /**
      * @param Flagged|FlagDismissed $event
      */
-    public function flagged($event)
+    public function flagged(object $event): void
     {
         $discussion = $event->flag->post->discussion;
 
@@ -60,7 +67,7 @@ public function flagged($event)
     /**
      * @param PostWasUnliked|PostWasLiked $event
      */
-    public function likes($event)
+    public function likes(object $event): void
     {
         $this->queue()->push(new SendTriggerJob(
             'likesMutation',
@@ -72,28 +79,38 @@ public function likes($event)
     /**
      * @param PostWasVoted $event
      * @return void
+     * @phpstan-ignore-next-line
      */
-    public function voted(PostWasVoted $event)
+    public function voted(object $event): void
     {
+        /** @phpstan-ignore-next-line */
+        $post = $event->vote->post;
+
         $this->queue()->push(new SendTriggerJob(
             'votedMutation',
-            $event->vote->post
+            $post
         ));
     }
 
     /**
      * @param PostWasReacted|PostWasUnreacted $event
+     * @phpstan-ignore-next-line
      */
-    public function reactions($event)
+    public function reactions(object $event): void
     {
+        /** @phpstan-ignore-next-line */
+        $post = $event->post;
+        /** @phpstan-ignore-next-line */
+        $user = $event->user;
+
         $this->queue()->push(new SendTriggerJob(
             'reactionsMutation',
-            $event->post,
-            $event->user
+            $post,
+            $user
         ));
     }
 
-    public function revised(Revised $event)
+    public function revised(Revised $event): void
     {
         $this->queue()->push(new SendTriggerJob(
             'revisedEvent',

extensions/realtime/src/Websocket/Channel/Channel.php

@@ -62,7 +62,7 @@ public function hasConnection(ConnectionInterface $connection): bool
         return isset($this->connections[$connection->socketId]);
     }
 
-    public function saveConnection(ConnectionInterface $connection)
+    public function saveConnection(ConnectionInterface $connection): void
     {
         /** @phpstan-ignore-next-line */
         $this->connections[$connection->socketId] = $connection;
@@ -94,7 +94,7 @@ public function broadcastToEveryoneExcept(stdClass $payload, ?string $socketId):
         return true;
     }
 
-    protected function verifySignature(ConnectionInterface $connection, stdClass $payload)
+    protected function verifySignature(ConnectionInterface $connection, stdClass $payload): void
     {
         /** @phpstan-ignore-next-line */
         $signature = "{$connection->socketId}:{$this->getName()}";

extensions/realtime/src/Websocket/Channel/Manager.php

@@ -198,6 +198,7 @@ public function getChannelMembers(string $channel): PromiseInterface
     {
         $members = $this->users[$channel] ?? [];
 
+        /** @phpstan-ignore-next-line */
         $members = collect($members)->map(function ($user) {
             return json_decode($user);
         })->unique('user_id')->toArray();
@@ -219,7 +220,7 @@ public function getChannelsMembersCount(array $channelNames): PromiseInterface
         return $this->createFulfilledPromise($results);
     }
 
-    public function getMemberSockets($userId, string $channel): PromiseInterface
+    public function getMemberSockets(int|string $userId, string $channel): PromiseInterface
     {
         return $this->createFulfilledPromise($this->userSockets["$channel:$userId"] ?? []);
     }

extensions/realtime/src/Websocket/Channel/PresenceChannel.php

@@ -38,6 +38,7 @@ public function subscribe(ConnectionInterface $connection, stdClass $payload): b
                             'channel' => $this->getName(),
                             'data' => json_encode([
                                 'presence' => [
+                                    /** @phpstan-ignore-next-line */
                                     'ids' => collect($users)->map(function ($user) {
                                         return (string) $user->user_id;
                                     })->values(),