CSlant\LaravelLike\Traits\InteractionRelationship

Complexity

Total Complexity

10

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	likes()	0	3	1
A	likeOne()	0	3	1
A	withInteractionBy()	0	11	3
A	isInteractedBy()	0	3	1
A	forgetInteractions()	0	9	3
A	forgetInteractionsOfType()	0	5	1

<?php

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;
use Illuminate\Database\Eloquent\Relations\MorphOne;

/**
 * Trait InteractionRelationship
 *
 * @package CSlant\LaravelLike\Traits
 * @mixin Model
 *
 * @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
{
    /**
     * Interaction has one relationship with the model.
     *
     * @return MorphOne
     */
    public function likeOne(): MorphOne
    {
        return $this->morphOne((string) config('like.interaction_model') ?? Like::class, 'model');
    }

    /**
     * Interaction has many relationship with the model.
     *
     * @return MorphMany
     */
    public function likes(): MorphMany
    {
        return $this->morphMany((string) config('like.interaction_model') ?? Like::class, 'model');
    }

    /**
     * Get the interaction of the given user.
     *
     * @param  int  $userId
     * @param  null|InteractionTypeEnum  $interactionType
     *
     * @return MorphMany
     */
    public function withInteractionBy(int $userId, ?InteractionTypeEnum $interactionType = null): MorphMany
    {
        $userForeignKey = (string) (config('like.users.foreign_key') ?? 'user_id');

        $query = $this->likes()->where($userForeignKey, $userId);

        if ($interactionType && InteractionTypeEnum::isValid($interactionType)) {
            $query->where('type', $interactionType);
        }

        return $query;
    }

    /**
     * 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
    {
        return $this->withInteractionBy($userId, $interactionType)->exists();
    }

    /**
     * Check and forget all recorded interactions of the given type.
     *
     * @param  string  $interactionType
     *
     * @return static

The type CSlant\LaravelLike\Traits\InteractionRelationship was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    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;
    }
}