ProtoneMedia\LaravelVerifyNewEmail\MustVerifyNewEmail

Complexity

Total Complexity

9

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	newEmail()	0	12	3
A	createPendingUserEmailModel()	0	9	1
A	getPendingEmail()	0	4	1
A	clearPendingEmail()	0	4	1
A	sendPendingEmailVerificationMail()	0	12	2
A	resendPendingEmailVerificationMail()	0	6	1

<?php

namespace ProtoneMedia\LaravelVerifyNewEmail;

use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Password;
use ProtoneMedia\LaravelVerifyNewEmail\Mail\VerifyNewEmail;

trait MustVerifyNewEmail
{
    /**
     * Deletes all previous attempts for this user, creates a new model/token
     * to verify the given email address and send the verification URL
     * to the new email address.
     *
     * @param string $email
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
     */
    public function newEmail(string $email):?PendingUserEmail
    {
        $this->clearPendingEmail();

        if ($this->getEmailForVerification() === $email && $this->hasVerifiedEmail()) {

It seems like getEmailForVerification() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like hasVerifiedEmail() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return null;
        }

        return $this->createPendingUserEmailModel($email)->tap(function (PendingUserEmail $model) {
            $this->sendPendingEmailVerificationMail($model);
        });
    }

    /**
     * Createsa new PendingUserModel model for the given email.
     *
     * @param string $email
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
     */
    public function createPendingUserEmailModel(string $email): PendingUserEmail
    {
        return PendingUserEmail::create([
            'user_type' => get_class($this),
            'user_id'   => $this->getKey(),

It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'email'     => $email,
            'token'     => Password::broker()->getRepository()->createNewToken(),
        ]);
    }

    /**
     * Returns the pending email address.
     *
     * @return string|null
     */
    public function getPendingEmail():?string
    {
        return PendingUserEmail::forUser($this)->value('email');
    }

    /**
     * Deletes the pending email address models for this user.
     *
     * @return void
     */
    public function clearPendingEmail()
    {
        PendingUserEmail::forUser($this)->get()->each->delete();
    }

    /**
     * Sends the VerifyNewEmail Mailable to the new email address.
     *
     * @param \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail $pendingUserEmail
     * @return mixed
     */
    public function sendPendingEmailVerificationMail(PendingUserEmail $pendingUserEmail)
    {
        $mailableClass = config('verify-new-email.mailable_for_first_verification');

        if ($pendingUserEmail->User->hasVerifiedEmail()) {
            $mailableClass = config('verify-new-email.mailable_for_new_email');
        }

        $mailable = new $mailableClass($pendingUserEmail);

        return Mail::to($pendingUserEmail->email)->send($mailable);
    }

    /**
     * Grabs the pending user email address, generates a new token and sends the Mailable.
     *
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
     */
    public function resendPendingEmailVerificationMail():?PendingUserEmail
    {
        $pendingUserEmail = PendingUserEmail::forUser($this)->firstOrFail();

        return $this->newEmail($pendingUserEmail->email);
    }
}