fix: update type hints in model relationships for better type safety

Author: tanhongit

phpstan-baseline.neon

@@ -3,7 +3,5 @@ parameters:
         - message: '#Cannot cast mixed to string#'
           path: src/*
 
-        - message: '#Method CSlant\\LaravelLike\\Models\\Like::user\(\) return type with generic class Illuminate\\Database\\Eloquent\\Relations\\BelongsTo does not specify its types: TRelatedModel, TChildModel#'
-          path: src/Models/Like.php
         -
           identifier: trait.unused

src/Models/Like.php

@@ -6,6 +6,7 @@
 use CSlant\LaravelLike\Traits\InteractionRelationship;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Carbon;
 
@@ -27,23 +28,13 @@
  */
 class Like extends Model
 {
-    /**
-     * The attributes that are mass assignable.
-     *
-     * @var array<int, string>
-     */
     protected $fillable = [
         'user_id',
         'model_id',
         'model_type',
         'type',
     ];
 
-    /**
-     * The attributes that should be cast.
-     *
-     * @var array<string, string>
-     */
     protected $casts = [
         'model_type' => 'string',
         'type' => InteractionTypeEnum::class,
@@ -52,7 +43,7 @@ class Like extends Model
     /**
      * Get the user that owns the like.
      *
-     * @return BelongsTo<Model, self>
+     * @return BelongsTo<*, *>
      */
     public function user(): BelongsTo
     {
@@ -70,9 +61,9 @@ public function user(): BelongsTo
     /**
      * Get the model that the like belongs to.
      *
-     * @return BelongsTo<Model, self>
+     * @return MorphTo<*, *>
      */
-    public function model(): BelongsTo
+    public function model(): MorphTo
     {
         return $this->morphTo();
     }

src/Traits/InteractionRelationship.php

@@ -14,8 +14,8 @@
  * @package CSlant\LaravelLike\Traits
  * @mixin Model
  *
- * @method MorphOne<self, Model> morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
- * @method MorphMany<self, Model> morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
+ * @method MorphOne<self, *> morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
+ * @method MorphMany<self, *> morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
  */
 trait InteractionRelationship
 {

src/Traits/Like/LikeCount.php

@@ -11,8 +11,8 @@
  * @package CSlant\LaravelLike\Traits\Like
  * @mixin Model
  *
- * @method MorphMany<self, Model> likesTo()
- * @method MorphMany<self, Model> dislikesTo()
+ * @method MorphMany<self, *> likesTo()
+ * @method MorphMany<self, *> dislikesTo()
  */
 trait LikeCount
 {

src/Traits/Like/LikeScopes.php

@@ -13,8 +13,8 @@
  * @package CSlant\LaravelLike\Traits\Like
  * @mixin Model
  *
- * @method MorphOne<self, Model> likeOne()
- * @method MorphMany<self, Model> likes()
+ * @method MorphOne<self, *> likeOne()
+ * @method MorphMany<self, *> likes()
  * @method bool isInteractedBy(int $userId, null|InteractionTypeEnum $type)
  */
 trait LikeScopes

src/Traits/Love/LoveCount.php

@@ -11,7 +11,7 @@
  * @package CSlant\LaravelLike\Traits\Love
  * @mixin Model
  *
- * @method MorphMany<self, Model> lovesTo()
+ * @method MorphMany<self, *> lovesTo()
  */
 trait LoveCount
 {

src/Traits/Love/LoveScope.php

@@ -13,8 +13,8 @@
  * @package CSlant\LaravelLike\Traits\Love
  * @mixin Model
  *
- * @method MorphOne<self, Model> likeOne()
- * @method MorphMany<self, Model> likes()
+ * @method MorphOne<self, *> likeOne()
+ * @method MorphMany<self, *> likes()
  * @method bool isInteractedBy(int $userId, null|InteractionTypeEnum $type)
  */
 trait LoveScope

src/UserHasInteraction.php

@@ -20,7 +20,7 @@ trait UserHasInteraction
     /**
      * Get all likes of the user. This method is used for eager loading.
      *
-     * @return HasMany<Like, Model>
+     * @return HasMany<self, Model>
      */
     public function likes(): HasMany
     {