UserHasInteraction::forgetInteractions() - Code Metrics - Inspection of "a1fa3aa54e1904f7259e60ba6189cda2354e3b77" - cslant/laravel-like - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — main (a1fa3a)

by Tan

created 2024-10-06 11:43 UTC

UserHasInteraction::forgetInteractions() A

↳ Parent: UserHasInteraction

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	4
c	1
b	0
f	1
dl	0
loc	9
rs	10
cc	3
nc	2
nop	1

<?php

namespace CSlant\LaravelLike;

use CSlant\LaravelLike\Enums\InteractionTypeEnum;
use CSlant\LaravelLike\Models\Like;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;

/**
 * Trait UserInteraction
 * use this trait in your User model
 *
 * @package CSlant\LaravelLike\Traits
 * @mixin Model
 * @method HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)
 */
trait UserHasInteraction
{
    /**
     * Get all likes of the user. This method is used for eager loading.
     *
     * @return HasMany
     */
    public function likes(): HasMany
    {
        $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;
    }
}


1			<?php
2
3			namespace CSlant\LaravelLike;
4
5			use CSlant\LaravelLike\Enums\InteractionTypeEnum;
6			use CSlant\LaravelLike\Models\Like;
7			use Illuminate\Database\Eloquent\Model;
8			use Illuminate\Database\Eloquent\Relations\HasMany;
9
10			/**
11			* Trait UserInteraction
12			* use this trait in your User model
13			*
14			* @package CSlant\LaravelLike\Traits
15			* @mixin Model
16			* @method HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)
17			*/
18			trait UserHasInteraction
19			{
20			/**
21			* Get all likes of the user. This method is used for eager loading.
22			*
23			* @return HasMany
24			*/
25			public function likes(): HasMany
26			{
27			$interactionModel = (string) (config('like.interaction_model') ?? Like::class);
28			$userForeignKey = (string) (config('like.users.foreign_key') ?? 'user_id');
29
30			return $this->hasMany($interactionModel, $userForeignKey);
31			}
32
33			/**
34			* Check if the user has liked the given model.
35			*
36			* @param string $interactionType
37			*
38			* @return static
39			*/
40			public function forgetInteractionsOfType(string $interactionType): static
41			{
42			$this->likes()->where('type', $interactionType)->delete();
43
44			return $this;
45			}
46
47			/**
48			* Check if the user has liked the given model.
49			*
50			* @param null\|string $interactionType
51			*
52			* @return static
53			*/
54			public function forgetInteractions(?string $interactionType = null): static
55			{
56			if ($interactionType && in_array($interactionType, InteractionTypeEnum::getValuesAsStrings())) {
57			return $this->forgetInteractionsOfType($interactionType);
58			}
59
60			$this->likes()->delete();
61
62			return $this;
63			}
64			}
65

cslant / laravel-like

Branch — main (a1fa3a)

UserHasInteraction::forgetInteractions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like