chore: update codebase to php8.1 (#3827)

* chore: set minimum php version to 8.1

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* chore: update codebase to php8.1

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* Apply fixes from StyleCI

* chore: update workflow php version

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: more caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: phpstan caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* Apply fixes from StyleCI

* fix: test-caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: test-caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: test-caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: introduce `Flarum\Locale\TranslatorInterface`

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* Apply fixes from StyleCI

* chore: remove mixin

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: test-caught errors

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* fix: one last error

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

---------

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>
Co-authored-by: StyleCI Bot <bot@styleci.io>

extensions/flags/src/Access/ScopeFlagVisibility.php

@@ -16,17 +16,12 @@ use Illuminate\Database\Eloquent\Builder;
 
 class ScopeFlagVisibility
 {
-    /**
-     * @var ExtensionManager
-     */
-    protected $extensions;
-
-    public function __construct(ExtensionManager $extensions)
-    {
-        $this->extensions = $extensions;
+    public function __construct(
+        protected ExtensionManager $extensions
+    ) {
     }
 
-    public function __invoke(User $actor, Builder $query)
+    public function __invoke(User $actor, Builder $query): void
     {
         if ($this->extensions->isEnabled('flarum-tags')) {
             $query

extensions/flags/src/AddCanFlagAttribute.php

@@ -16,20 +16,12 @@ use Flarum\User\User;
 
 class AddCanFlagAttribute
 {
-    /**
-     * @var SettingsRepositoryInterface
-     */
-    protected $settings;
-
-    /**
-     * @param SettingsRepositoryInterface $settings
-     */
-    public function __construct(SettingsRepositoryInterface $settings)
-    {
-        $this->settings = $settings;
+    public function __construct(
+        protected SettingsRepositoryInterface $settings
+    ) {
     }
 
-    public function __invoke(PostSerializer $serializer, Post $post)
+    public function __invoke(PostSerializer $serializer, Post $post): bool
     {
         return $serializer->getActor()->can('flag', $post) && $this->checkFlagOwnPostSetting($serializer->getActor(), $post);
     }

extensions/flags/src/AddFlagsApiAttributes.php

@@ -15,20 +15,12 @@ use Flarum\User\User;
 
 class AddFlagsApiAttributes
 {
-    /**
-     * @var SettingsRepositoryInterface
-     */
-    protected $settings;
-
-    /**
-     * @param SettingsRepositoryInterface $settings
-     */
-    public function __construct(SettingsRepositoryInterface $settings)
-    {
-        $this->settings = $settings;
+    public function __construct(
+        protected SettingsRepositoryInterface $settings
+    ) {
     }
 
-    public function __invoke(ForumSerializer $serializer)
+    public function __invoke(ForumSerializer $serializer): array
     {
         $attributes = [
             'canViewFlags' => $serializer->getActor()->hasPermissionLike('discussion.viewFlags')
@@ -41,11 +33,7 @@ class AddFlagsApiAttributes
         return $attributes;
     }
 
-    /**
-     * @param User $actor
-     * @return int
-     */
-    protected function getFlagCount(User $actor)
+    protected function getFlagCount(User $actor): int
     {
         return Flag::whereVisibleTo($actor)->distinct()->count('flags.post_id');
     }

extensions/flags/src/AddNewFlagCountAttribute.php

@@ -14,16 +14,12 @@ use Flarum\User\User;
 
 class AddNewFlagCountAttribute
 {
-    public function __invoke(CurrentUserSerializer $serializer, User $user)
+    public function __invoke(CurrentUserSerializer $serializer, User $user): int
     {
-        return (int) $this->getNewFlagCount($user);
+        return $this->getNewFlagCount($user);
     }
 
-    /**
-     * @param User $actor
-     * @return int
-     */
-    protected function getNewFlagCount(User $actor)
+    protected function getNewFlagCount(User $actor): int
     {
         $query = Flag::whereVisibleTo($actor);
 

extensions/flags/src/Api/Controller/CreateFlagController.php

@@ -12,6 +12,7 @@ namespace Flarum\Flags\Api\Controller;
 use Flarum\Api\Controller\AbstractCreateController;
 use Flarum\Flags\Api\Serializer\FlagSerializer;
 use Flarum\Flags\Command\CreateFlag;
+use Flarum\Flags\Flag;
 use Flarum\Http\RequestUtil;
 use Illuminate\Contracts\Bus\Dispatcher;
 use Illuminate\Support\Arr;
@@ -20,37 +21,20 @@ use Tobscure\JsonApi\Document;
 
 class CreateFlagController extends AbstractCreateController
 {
-    /**
-     * {@inheritdoc}
-     */
-    public $serializer = FlagSerializer::class;
+    public ?string $serializer = FlagSerializer::class;
 
-    /**
-     * {@inheritdoc}
-     */
-    public $include = [
+    public array $include = [
         'post',
         'post.flags',
         'user'
     ];
 
-    /**
-     * @var Dispatcher
-     */
-    protected $bus;
-
-    /**
-     * @param Dispatcher $bus
-     */
-    public function __construct(Dispatcher $bus)
-    {
-        $this->bus = $bus;
+    public function __construct(
+        protected Dispatcher $bus
+    ) {
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function data(ServerRequestInterface $request, Document $document)
+    protected function data(ServerRequestInterface $request, Document $document): Flag
     {
         return $this->bus->dispatch(
             new CreateFlag(RequestUtil::getActor($request), Arr::get($request->getParsedBody(), 'data', []))

extensions/flags/src/Api/Controller/DeleteFlagsController.php

@@ -18,23 +18,12 @@ use Psr\Http\Message\ServerRequestInterface;
 
 class DeleteFlagsController extends AbstractDeleteController
 {
-    /**
-     * @var Dispatcher
-     */
-    protected $bus;
-
-    /**
-     * @param Dispatcher $bus
-     */
-    public function __construct(Dispatcher $bus)
-    {
-        $this->bus = $bus;
+    public function __construct(
+        protected Dispatcher $bus
+    ) {
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function delete(ServerRequestInterface $request)
+    protected function delete(ServerRequestInterface $request): void
     {
         $this->bus->dispatch(
             new DeleteFlags(Arr::get($request->getQueryParams(), 'id'), RequestUtil::getActor($request), $request->getParsedBody())

extensions/flags/src/Api/Controller/ListFlagsController.php

@@ -19,25 +19,16 @@ use Tobscure\JsonApi\Document;
 
 class ListFlagsController extends AbstractListController
 {
-    /**
-     * {@inheritdoc}
-     */
-    public $serializer = FlagSerializer::class;
+    public ?string $serializer = FlagSerializer::class;
 
-    /**
-     * {@inheritdoc}
-     */
-    public $include = [
+    public array $include = [
         'user',
         'post',
         'post.user',
         'post.discussion'
     ];
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function data(ServerRequestInterface $request, Document $document)
+    protected function data(ServerRequestInterface $request, Document $document): iterable
     {
         $actor = RequestUtil::getActor($request);
         $include = $this->extractInclude($request);

extensions/flags/src/Api/Serializer/FlagSerializer.php

@@ -14,42 +14,34 @@ use Flarum\Api\Serializer\BasicUserSerializer;
 use Flarum\Api\Serializer\PostSerializer;
 use Flarum\Flags\Flag;
 use InvalidArgumentException;
+use Tobscure\JsonApi\Relationship;
 
 class FlagSerializer extends AbstractSerializer
 {
-    /**
-     * {@inheritdoc}
-     */
     protected $type = 'flags';
 
-    protected function getDefaultAttributes($flag)
+    protected function getDefaultAttributes(object|array $model): array
     {
-        if (! ($flag instanceof Flag)) {
+        if (! ($model instanceof Flag)) {
             throw new InvalidArgumentException(
                 get_class($this).' can only serialize instances of '.Flag::class
             );
         }
 
         return [
-            'type'         => $flag->type,
-            'reason'       => $flag->reason,
-            'reasonDetail' => $flag->reason_detail,
-            'createdAt'    => $this->formatDate($flag->created_at),
+            'type'         => $model->type,
+            'reason'       => $model->reason,
+            'reasonDetail' => $model->reason_detail,
+            'createdAt'    => $this->formatDate($model->created_at),
         ];
     }
 
-    /**
-     * @return \Tobscure\JsonApi\Relationship
-     */
-    protected function post($flag)
+    protected function post(Flag $flag): ?Relationship
     {
         return $this->hasOne($flag, PostSerializer::class);
     }
 
-    /**
-     * @return \Tobscure\JsonApi\Relationship
-     */
-    protected function user($flag)
+    protected function user(Flag $flag): ?Relationship
     {
         return $this->hasOne($flag, BasicUserSerializer::class);
     }

extensions/flags/src/Command/CreateFlag.php

@@ -13,27 +13,9 @@ use Flarum\User\User;
 
 class CreateFlag
 {
-    /**
-     * The user performing the action.
-     *
-     * @var User
-     */
-    public $actor;
-
-    /**
-     * The attributes of the new flag.
-     *
-     * @var array
-     */
-    public $data;
-
-    /**
-     * @param User $actor The user performing the action.
-     * @param array $data The attributes of the new flag.
-     */
-    public function __construct(User $actor, array $data)
-    {
-        $this->actor = $actor;
-        $this->data = $data;
+    public function __construct(
+        public User $actor,
+        public array $data
+    ) {
     }
 }

extensions/flags/src/Command/CreateFlagHandler.php

@@ -13,58 +13,26 @@ use Carbon\Carbon;
 use Flarum\Flags\Event\Created;
 use Flarum\Flags\Flag;
 use Flarum\Foundation\ValidationException;
+use Flarum\Locale\TranslatorInterface;
 use Flarum\Post\CommentPost;
 use Flarum\Post\PostRepository;
 use Flarum\Settings\SettingsRepositoryInterface;
 use Flarum\User\Exception\PermissionDeniedException;
 use Illuminate\Events\Dispatcher;
 use Illuminate\Support\Arr;
-use Symfony\Contracts\Translation\TranslatorInterface;
 use Tobscure\JsonApi\Exception\InvalidParameterException;
 
 class CreateFlagHandler
 {
-    /**
-     * @var PostRepository
-     */
-    protected $posts;
-
-    /**
-     * @var TranslatorInterface
-     */
-    protected $translator;
-
-    /**
-     * @var SettingsRepositoryInterface
-     */
-    protected $settings;
-
-    /**
-     * @var Dispatcher
-     */
-    protected $events;
-
-    /**
-     * @param PostRepository $posts
-     * @param TranslatorInterface $translator
-     * @param SettingsRepositoryInterface $settings
-     * @param Dispatcher $events
-     */
-    public function __construct(PostRepository $posts, TranslatorInterface $translator, SettingsRepositoryInterface $settings, Dispatcher $events)
-    {
-        $this->posts = $posts;
-        $this->translator = $translator;
-        $this->settings = $settings;
-        $this->events = $events;
+    public function __construct(
+        protected PostRepository $posts,
+        protected TranslatorInterface $translator,
+        protected SettingsRepositoryInterface $settings,
+        protected Dispatcher $events
+    ) {
     }
 
-    /**
-     * @param CreateFlag $command
-     * @return Flag
-     * @throws InvalidParameterException
-     * @throws ValidationException
-     */
-    public function handle(CreateFlag $command)
+    public function handle(CreateFlag $command): Flag
     {
         $actor = $command->actor;
         $data = $command->data;

extensions/flags/src/Command/DeleteFlags.php

@@ -13,34 +13,10 @@ use Flarum\User\User;
 
 class DeleteFlags
 {
-    /**
-     * The ID of the post to delete flags for.
-     *
-     * @var int
-     */
-    public $postId;
-
-    /**
-     * The user performing the action.
-     *
-     * @var User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    /**
-     * @param int $postId The ID of the post to delete flags for.
-     * @param User $actor The user performing the action.
-     * @param array $data
-     */
-    public function __construct($postId, User $actor, array $data = [])
-    {
-        $this->postId = $postId;
-        $this->actor = $actor;
-        $this->data = $data;
+    public function __construct(
+        public int $postId,
+        public User $actor,
+        public array $data = []
+    ) {
     }
 }

extensions/flags/src/Command/DeleteFlagsHandler.php

@@ -17,31 +17,13 @@ use Illuminate\Events\Dispatcher;
 
 class DeleteFlagsHandler
 {
-    /**
-     * @var PostRepository
-     */
-    protected $posts;
-
-    /**
-     * @var Dispatcher
-     */
-    protected $events;
-
-    /**
-     * @param PostRepository $posts
-     * @param Dispatcher $events
-     */
-    public function __construct(PostRepository $posts, Dispatcher $events)
-    {
-        $this->posts = $posts;
-        $this->events = $events;
+    public function __construct(
+        protected PostRepository $posts,
+        protected Dispatcher $events
+    ) {
     }
 
-    /**
-     * @param DeleteFlags $command
-     * @return Post
-     */
-    public function handle(DeleteFlags $command)
+    public function handle(DeleteFlags $command): Post
     {
         $actor = $command->actor;
 

extensions/flags/src/Event/Created.php

@@ -14,30 +14,10 @@ use Flarum\User\User;
 
 class Created
 {
-    /**
-     * @var Flag
-     */
-    public $flag;
-
-    /**
-     * @var User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    /**
-     * @param Flag $flag
-     * @param User $actor
-     * @param array $data
-     */
-    public function __construct(Flag $flag, User $actor, array $data = [])
-    {
-        $this->flag = $flag;
-        $this->actor = $actor;
-        $this->data = $data;
+    public function __construct(
+        public Flag $flag,
+        public User $actor,
+        public array $data = []
+    ) {
     }
 }

extensions/flags/src/Event/Deleting.php

@@ -14,30 +14,10 @@ use Flarum\User\User;
 
 class Deleting
 {
-    /**
-     * @var Flag
-     */
-    public $flag;
-
-    /**
-     * @var User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    /**
-     * @param Flag $flag
-     * @param User $actor
-     * @param array $data
-     */
-    public function __construct(Flag $flag, User $actor, array $data = [])
-    {
-        $this->flag = $flag;
-        $this->actor = $actor;
-        $this->data = $data;
+    public function __construct(
+        public Flag $flag,
+        public User $actor,
+        public array $data = []
+    ) {
     }
 }

extensions/flags/src/Event/FlagsWillBeDeleted.php

@@ -18,30 +18,10 @@ use Flarum\User\User;
  */
 class FlagsWillBeDeleted
 {
-    /**
-     * @var Post
-     */
-    public $post;
-
-    /**
-     * @var User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    /**
-     * @param Post $post
-     * @param User $actor
-     * @param array $data
-     */
-    public function __construct(Post $post, User $actor, array $data = [])
-    {
-        $this->post = $post;
-        $this->actor = $actor;
-        $this->data = $data;
+    public function __construct(
+        public Post $post,
+        public User $actor,
+        public array $data = []
+    ) {
     }
 }

extensions/flags/src/Flag.php

@@ -14,6 +14,7 @@ use Flarum\Database\AbstractModel;
 use Flarum\Database\ScopeVisibilityTrait;
 use Flarum\Post\Post;
 use Flarum\User\User;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * @property int $post_id
@@ -30,23 +31,14 @@ class Flag extends AbstractModel
 {
     use ScopeVisibilityTrait;
 
-    /**
-     * {@inheritdoc}
-     */
     protected $dates = ['created_at'];
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function post()
+    public function post(): BelongsTo
     {
         return $this->belongsTo(Post::class);
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function user()
+    public function user(): BelongsTo
     {
         return $this->belongsTo(User::class);
     }

extensions/flags/src/Listener/DeleteFlags.php

@@ -13,10 +13,7 @@ use Flarum\Post\Event\Deleted;
 
 class DeleteFlags
 {
-    /**
-     * @param Deleted $event
-     */
-    public function handle(Deleted $event)
+    public function handle(Deleted $event): void
     {
         $event->post->flags()->delete();
     }

extensions/flags/src/PrepareFlagsApiData.php

@@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface;
 
 class PrepareFlagsApiData
 {
-    public function __invoke(Controller\AbstractSerializeController $controller, $data, ServerRequestInterface $request)
+    public function __invoke(Controller\AbstractSerializeController $controller, mixed $data, ServerRequestInterface $request): void
     {
         // For any API action that allows the 'flags' relationship to be
         // included, we need to preload this relationship onto the data (Post