Spatie\EmailCampaigns\Models\EmailList

Complexity

Total Complexity

17

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	8

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	subscribers()	0	4	1
A	allSubscribers()	0	4	1
A	subscriptions()	0	4	1
A	allSubscriptions()	0	4	1
A	campaigns()	0	4	1
A	subscribe()	0	6	1
A	subscribeNow()	0	6	1
A	createSubscriber()	0	18	2
A	isSubscribed()	0	12	3
A	getSubscription()	0	7	1
A	unsubscribe()	0	14	3
A	getSubscriptionStatus()	0	11	1

<?php

namespace Spatie\EmailCampaigns\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\Validator;
use Spatie\EmailCampaigns\Models\Concerns\HasUuid;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Spatie\EmailCampaigns\Enums\SubscriptionStatus;
use Spatie\EmailCampaigns\Exceptions\CouldNotSubscribe;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

class EmailList extends Model
{
    use HasUuid;

    public $guarded = [];

    public $casts = [
        'requires_double_opt_in' => 'boolean',
    ];

    public function subscribers(): BelongsToMany
    {
        return $this->allSubscribers()->wherePivot('status', SubscriptionStatus::SUBSCRIBED);
    }

    public function allSubscribers(): BelongsToMany
    {
        return $this->belongsToMany(Subscriber::class, 'email_list_subscriptions', 'email_list_id', 'email_list_subscriber_id');
    }

    public function subscriptions(): HasMany
    {
        return $this->hasMany(Subscription::class)->where('status', SubscriptionStatus::SUBSCRIBED);
    }

    public function allSubscriptions(): HasMany
    {
        return $this->hasMany(Subscription::class);
    }

    public function campaigns(): HasMany
    {
        return $this->hasMany(Campaign::class);
    }

    public function subscribe(string $email, array $attributes = [], array $extraAttributes = []): Subscription
    {
        $subscriber = $this->createSubscriber($email, $attributes, $extraAttributes);

        return $subscriber->subscribeTo($this);
    }

    public function subscribeNow(string $email, array $attributes = [], array $extraAttributes = []): Subscription
    {
        $subscriber = $this->createSubscriber($email, $attributes, $extraAttributes);

        return $subscriber->subscribeNowTo($this);
    }

    protected function createSubscriber(string $email, array $attributes = [], $extraAttributes = []): Subscriber
    {
        if (Validator::make(compact('email'), ['email' => 'email'])->fails()) {
            throw CouldNotSubscribe::invalidEmail($email);
        }

        /** @var \Spatie\EmailCampaigns\Models\Subscriber $subscriber */
        $subscriber = Subscriber::firstOrCreate([
            'email' => $email,
        ]);

        $subscriber->fill($attributes);

        $subscriber->extra_attributes = $extraAttributes;
        $subscriber->save();

        return $subscriber;
    }

    public function isSubscribed(string $email): bool
    {
        if (! $subscriber = Subscriber::findForEmail($email)) {
            return false;
        }

        if (! $subscription = $this->getSubscription($subscriber)) {
            return false;
        }

        return $subscription->status === SubscriptionStatus::SUBSCRIBED;
    }

    public function getSubscription(Subscriber $subscriber): ?Subscription
    {
        return Subscription::query()
            ->where('email_list_id', $this->id)
            ->where('email_list_subscriber_id', $subscriber->id)
            ->first();
    }

    public function unsubscribe(string $email): bool
    {
        if (! $subscriber = Subscriber::findForEmail($email)) {
            return false;
        }

        if (! $subscription = $this->getSubscription($subscriber)) {
            return false;
        }

        $subscription->markAsUnsubscribed();

        return true;
    }

    public function getSubscriptionStatus(string $email): ?string
    {
        $subscription = Subscription::query()

The method first does only exist in Illuminate\Database\Eloquent\Builder, but not in Illuminate\Database\Eloquent\Concerns\QueriesRelationships.

            ->where('email_list_id', $this->id)
            ->whereHas('subscriber', function (Builder $query) use ($email) {
                $query->where('email', $email);
            })
            ->first();

        return optional($subscription)->status;
    }
}