Merge pull request #4 from cslant/feat/new-interaction-scope

Feat/new interaction scopes

Author: tanhongit

src/Enums/InteractionTypeEnum.php

@@ -66,4 +66,23 @@ public function isLove(): bool
     {
         return $this === self::LOVE;
     }
+
+    /**
+     * Get the type by value.
+     * This method can be used to get the value of InteractionTypeEnum based on the passed string.
+     * You can use it to convert string value to enum value.
+     *
+     * @param  string  $value
+     *
+     * @return InteractionTypeEnum
+     */
+    public function getTypeByValue(string $value): InteractionTypeEnum
+    {
+        return match ($value) {
+            self::LIKE->value => self::LIKE,
+            self::DISLIKE->value => self::DISLIKE,
+            self::LOVE->value => self::LOVE,
+            default => self::DEFAULT,
+        };
+    }
 }

src/Traits/InteractionRelationship.php

@@ -2,6 +2,7 @@
 
 namespace CSlant\LaravelLike\Traits;
 
+use CSlant\LaravelLike\Enums\InteractionTypeEnum;
 use CSlant\LaravelLike\Models\Like;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
@@ -37,4 +38,57 @@ public function likes(): MorphMany
     {
         return $this->morphMany((string) config('like.interaction_model') ?? Like::class, 'model');
     }
+
+    /**
+     * Check if the model has been interacted by the given user.
+     *
+     * @param  int  $userId
+     * @param  null|InteractionTypeEnum  $interactionType
+     *
+     * @return bool
+     */
+    public function isInteractedBy(int $userId, ?InteractionTypeEnum $interactionType = null): bool
+    {
+        $userForeignKey = (string) (config('like.users.foreign_key') ?? 'user_id');
+
+        $query = $this->likes()->where($userForeignKey, $userId);
+
+        if (in_array($interactionType, InteractionTypeEnum::getValuesAsStrings())) {
+            $query->where('type', $interactionType);
+        }
+
+        return $query->exists();
+    }
+
+    /**
+     * Check and forget all recorded interactions of the given type.
+     *
+     * @param  string  $interactionType
+     *
+     * @return static
+     */
+    public function forgetInteractionsOfType(string $interactionType): static
+    {
+        $this->likes()->where('type', $interactionType)->delete();
+
+        return $this;
+    }
+
+    /**
+     * Check and forget all recorded interactions.
+     *
+     * @param  null|string  $interactionType
+     *
+     * @return static
+     */
+    public function forgetInteractions(?string $interactionType = null): static
+    {
+        if ($interactionType && in_array($interactionType, InteractionTypeEnum::getValuesAsStrings())) {
+            return $this->forgetInteractionsOfType($interactionType);
+        }
+
+        $this->likes()->delete();
+
+        return $this;
+    }
 }

src/Traits/Like/LikeScopes.php

@@ -57,4 +57,28 @@ public function dislikesTo(): MorphMany
     {
         return $this->likes()->where('type', InteractionTypeEnum::DISLIKE);
     }
+
+    /**
+     * Check if the model has been interacted by the given user.
+     *
+     * @param  int  $userId
+     *
+     * @return bool
+     */
+    public function isLikedBy(int $userId): bool
+    {
+        return $this->isInteractedBy($userId, InteractionTypeEnum::LIKE);
+    }
+
+    /**
+     * Check if the model has been interacted by the given user.
+     *
+     * @param  int  $userId
+     *
+     * @return bool
+     */
+    public function isDislikedBy(int $userId): bool
+    {
+        return $this->isInteractedBy($userId, InteractionTypeEnum::DISLIKE);
+    }
 }

src/Traits/Love/LoveScope.php

@@ -37,4 +37,16 @@ public function lovesTo(): MorphMany
     {
         return $this->likes()->where('type', InteractionTypeEnum::LOVE);
     }
+
+    /**
+     * Check if the model has been loved by the given user.
+     *
+     * @param  int  $userId
+     *
+     * @return bool
+     */
+    public function isLovedBy(int $userId): bool
+    {
+        return $this->isInteractedBy($userId, InteractionTypeEnum::LOVE);
+    }
 }

src/UserHasInteraction.php

@@ -2,6 +2,8 @@
 
 namespace CSlant\LaravelLike;
 
+use CSlant\LaravelLike\Enums\InteractionTypeEnum;
+use CSlant\LaravelLike\Models\Like;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
@@ -22,9 +24,41 @@ trait UserHasInteraction
      */
     public function likes(): HasMany
     {
-        $interactionModel = (string) (config('like.interaction_model') ?? 'CSlant\LaravelLike\Models\Like');
+        $interactionModel = (string) (config('like.interaction_model') ?? Like::class);
         $userForeignKey = (string) (config('like.users.foreign_key') ?? 'user_id');
 
         return $this->hasMany($interactionModel, $userForeignKey);
     }
+
+    /**
+     * Check if the user has liked the given model.
+     *
+     * @param  string  $interactionType
+     *
+     * @return static
+     */
+    public function forgetInteractionsOfType(string $interactionType): static
+    {
+        $this->likes()->where('type', $interactionType)->delete();
+
+        return $this;
+    }
+
+    /**
+     * Check if the user has liked the given model.
+     *
+     * @param  null|string  $interactionType
+     *
+     * @return static
+     */
+    public function forgetInteractions(?string $interactionType = null): static
+    {
+        if ($interactionType && in_array($interactionType, InteractionTypeEnum::getValuesAsStrings())) {
+            return $this->forgetInteractionsOfType($interactionType);
+        }
+
+        $this->likes()->delete();
+
+        return $this;
+    }
 }