laravel-interaction/interactions

View on GitHub
packages/subscribe/src/Concerns/Subscriber.php

Summary

Maintainability
D
1 day
Test Coverage
A
97%
<?php

declare(strict_types=1);

namespace LaravelInteraction\Subscribe\Concerns;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use LaravelInteraction\Subscribe\Subscription;

/**
 * @property-read \Illuminate\Database\Eloquent\Collection|\LaravelInteraction\Subscribe\Subscription[] $subscriberSubscriptions
 * @property-read int|null $subscriber_subscriptions_count
 */
trait Subscriber
{
    public function hasNotSubscribed(Model $object): bool
    {
        return ! $this->hasSubscribed($object);
    }

    public function hasSubscribed(Model $object): bool
    {
        return ($this->relationLoaded(
            'subscriberSubscriptions'
        ) ? $this->subscriberSubscriptions : $this->subscriberSubscriptions())
            ->where('subscribable_id', $object->getKey())
            ->where('subscribable_type', $object->getMorphClass())
            ->count() > 0;
    }

    public function subscribe(Model $object): Subscription
    {
        $attributes = [
            'subscribable_id' => $object->getKey(),
            'subscribable_type' => $object->getMorphClass(),
        ];

        return $this->subscriberSubscriptions()
            ->where($attributes)
            ->firstOr(function () use ($attributes) {
                $subscriberSubscriptionsLoaded = $this->relationLoaded('subscriberSubscriptions');
                if ($subscriberSubscriptionsLoaded) {
                    $this->unsetRelation('subscriberSubscriptions');
                }

                return $this->subscriberSubscriptions()
                    ->create($attributes);
            });
    }

    public function subscriberSubscriptions(): HasMany
    {
        return $this->hasMany(config('subscribe.models.pivot'), config('subscribe.column_names.user_foreign_key'));
    }

    public function toggleSubscribe(Model $object): bool|Subscription
    {
        return $this->hasSubscribed($object) ? $this->unsubscribe($object) : $this->subscribe($object);
    }

    public function unsubscribe(Model $object): bool
    {
        $hasNotSubscribed = $this->hasNotSubscribed($object);
        if ($hasNotSubscribed) {
            return true;
        }

        $subscriberSubscriptionsLoaded = $this->relationLoaded('subscriberSubscriptions');
        if ($subscriberSubscriptionsLoaded) {
            $this->unsetRelation('subscriberSubscriptions');
        }

        return (bool) $this->subscribedItems($object::class)
            ->detach($object->getKey());
    }

    protected function subscribedItems(string $class): MorphToMany
    {
        return $this->morphedByMany(
            $class,
            'subscribable',
            config('subscribe.models.pivot'),
            config('subscribe.column_names.user_foreign_key')
        )
            ->withTimestamps();
    }
}