Custom model option

Author: Pascal Baljet

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-user-email` will be documented in this file
 
+## 1.0.7 - 2020-01-08
+
+- support for custom model
+
 ## 1.0.6 - 2020-01-06
 
 - added `web` middleware to verification route

config/config.php

@@ -16,6 +16,11 @@
      */
     'login_after_verification' => true,
 
+    /**
+     * Model class that will be used to store and retrieve the tokens.
+     */
+    'model' => \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail::class,
+
     /**
      * The Mailable that will be sent when the User wants to verify
      * its initial email address (that got used with registering).

src/Http/VerifiesPendingEmails.php

@@ -3,7 +3,6 @@
 namespace ProtoneMedia\LaravelVerifyNewEmail\Http;
 
 use Illuminate\Support\Facades\Auth;
-use ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail;
 
 trait VerifiesPendingEmails
 {
@@ -16,11 +15,11 @@ trait VerifiesPendingEmails
      */
     public function verify(string $token)
     {
-        $user = PendingUserEmail::whereToken($token)->firstOr(['*'], function () {
+        $user = app(config('verify-new-email.model'))->whereToken($token)->firstOr(['*'], function () {
             throw new InvalidVerificationLinkException(
                 __('The verification link is not valid anymore.')
             );
-        })->tap(function (PendingUserEmail $pendingUserEmail) {
+        })->tap(function ($pendingUserEmail) {
             $pendingUserEmail->activate();
         })->user;
 

src/Mail/VerifyFirstEmail.php

@@ -4,16 +4,16 @@
 
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Mail\Mailable;
 use Illuminate\Queue\SerializesModels;
-use ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail;
 
 class VerifyFirstEmail extends Mailable implements ShouldQueue
 {
     use Queueable, SerializesModels;
 
     /**
-     * @var \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
+     * @var \Illuminate\Database\Eloquent\Model
      */
     public $pendingUserEmail;
 
@@ -22,7 +22,7 @@ class VerifyFirstEmail extends Mailable implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(PendingUserEmail $pendingUserEmail)
+    public function __construct(Model $pendingUserEmail)
     {
         $this->pendingUserEmail = $pendingUserEmail;
     }

src/Mail/VerifyNewEmail.php

@@ -4,16 +4,16 @@
 
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Mail\Mailable;
 use Illuminate\Queue\SerializesModels;
-use ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail;
 
 class VerifyNewEmail extends Mailable implements ShouldQueue
 {
     use Queueable, SerializesModels;
 
     /**
-     * @var \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
+     * @var \Illuminate\Database\Eloquent\Model
      */
     public $pendingUserEmail;
 
@@ -22,7 +22,7 @@ class VerifyNewEmail extends Mailable implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(PendingUserEmail $pendingUserEmail)
+    public function __construct(Model $pendingUserEmail)
     {
         $this->pendingUserEmail = $pendingUserEmail;
     }

src/MustVerifyNewEmail.php

@@ -2,9 +2,9 @@
 
 namespace ProtoneMedia\LaravelVerifyNewEmail;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Mail;
 use Illuminate\Support\Facades\Password;
-use ProtoneMedia\LaravelVerifyNewEmail\Mail\VerifyNewEmail;
 
 trait MustVerifyNewEmail
 {
@@ -14,15 +14,15 @@ trait MustVerifyNewEmail
      * to the new email address.
      *
      * @param string $email
-     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
+     * @return \Illuminate\Database\Eloquent\Model|null
      */
-    public function newEmail(string $email):?PendingUserEmail
+    public function newEmail(string $email):?Model
     {
         if ($this->getEmailForVerification() === $email && $this->hasVerifiedEmail()) {
             return null;
         }
 
-        return $this->createPendingUserEmailModel($email)->tap(function (PendingUserEmail $model) {
+        return $this->createPendingUserEmailModel($email)->tap(function ($model) {
             $this->sendPendingEmailVerificationMail($model);
         });
     }
@@ -31,13 +31,13 @@ public function newEmail(string $email):?PendingUserEmail
      * Createsa new PendingUserModel model for the given email.
      *
      * @param string $email
-     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
+     * @return \Illuminate\Database\Eloquent\Model
      */
-    public function createPendingUserEmailModel(string $email): PendingUserEmail
+    public function createPendingUserEmailModel(string $email): Model
     {
         $this->clearPendingEmail();
 
-        return PendingUserEmail::create([
+        return app(config('verify-new-email.model'))->create([
             'user_type' => get_class($this),
             'user_id'   => $this->getKey(),
             'email'     => $email,
@@ -52,7 +52,7 @@ public function createPendingUserEmailModel(string $email): PendingUserEmail
      */
     public function getPendingEmail():?string
     {
-        return PendingUserEmail::forUser($this)->value('email');
+        return app(config('verify-new-email.model'))->forUser($this)->value('email');
     }
 
     /**
@@ -62,16 +62,16 @@ public function getPendingEmail():?string
      */
     public function clearPendingEmail()
     {
-        PendingUserEmail::forUser($this)->get()->each->delete();
+        app(config('verify-new-email.model'))->forUser($this)->get()->each->delete();
     }
 
     /**
      * Sends the VerifyNewEmail Mailable to the new email address.
      *
-     * @param \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail $pendingUserEmail
+     * @param \Illuminate\Database\Eloquent\Model $pendingUserEmail
      * @return mixed
      */
-    public function sendPendingEmailVerificationMail(PendingUserEmail $pendingUserEmail)
+    public function sendPendingEmailVerificationMail(Model $pendingUserEmail)
     {
         $mailableClass = config('verify-new-email.mailable_for_first_verification');
 
@@ -87,11 +87,11 @@ public function sendPendingEmailVerificationMail(PendingUserEmail $pendingUserEm
     /**
      * Grabs the pending user email address, generates a new token and sends the Mailable.
      *
-     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
+     * @return \Illuminate\Database\Eloquent\Model|null
      */
-    public function resendPendingEmailVerificationMail():?PendingUserEmail
+    public function resendPendingEmailVerificationMail():?Model
     {
-        $pendingUserEmail = PendingUserEmail::forUser($this)->firstOrFail();
+        $pendingUserEmail = app(config('verify-new-email.model'))->forUser($this)->firstOrFail();
 
         return $this->newEmail($pendingUserEmail->email);
     }

src/PendingUserEmail.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Auth\Events\Verified;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Support\Facades\URL;
 use Illuminate\Support\Traits\Tappable;
 
@@ -26,7 +27,7 @@ class PendingUserEmail extends Model
      *
      * @return \Illuminate\Database\Eloquent\Relations\MorphTo
      */
-    public function user()
+    public function user():MorphTo
     {
         return $this->morphTo('user');
     }