Allow users to receive notifications for replies

Author: driesvints

app/Events/ReplyWasCreated.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\Reply;
+use Illuminate\Queue\SerializesModels;
+
+class ReplyWasCreated
+{
+    use SerializesModels;
+
+    /**
+     * @var \App\Models\Reply
+     */
+    public $reply;
+
+    public function __construct(Reply $reply)
+    {
+        $this->reply = $reply;
+    }
+}

app/Helpers/ReceivesReplies.php

@@ -3,6 +3,7 @@
 namespace App\Helpers;
 
 use App\Models\Reply;
+use App\Models\Subscription;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 
 trait ReceivesReplies
@@ -32,4 +33,17 @@ public function repliesRelation(): MorphMany
     {
         return $this->morphMany(Reply::class, 'replyable');
     }
+
+    /**
+     * @return \App\Models\Subscription[]
+     */
+    public function subscriptions()
+    {
+        return $this->subscriptionsRelation;
+    }
+
+    public function subscriptionsRelation(): MorphMany
+    {
+        return $this->morphMany(Subscription::class, 'subscriptionable');
+    }
 }

app/Jobs/CreateReply.php

@@ -5,6 +5,7 @@
 use App\User;
 use App\Models\Reply;
 use App\Models\ReplyAble;
+use App\Events\ReplyWasCreated;
 use App\Http\Requests\CreateReplyRequest;
 
 class CreateReply
@@ -49,6 +50,8 @@ public function handle(): Reply
         $reply->to($this->replyAble);
         $reply->save();
 
+        event(new ReplyWasCreated($reply));
+
         return $reply;
     }
 }

app/Listeners/SendNewReplyNotification.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\ReplyWasCreated;
+use App\Notifications\NewReply;
+
+class SendNewReplyNotification
+{
+    public function handle(ReplyWasCreated $event)
+    {
+        foreach ($event->reply->replyAble()->subscriptions() as $subscription) {
+            $subscription->user()->notify(new NewReply());
+        }
+    }
+}

app/Models/ReplyAble.php

@@ -22,4 +22,11 @@ public function latestReplies(int $amount = 5);
     public function deleteReplies();
 
     public function repliesRelation(): MorphMany;
+
+    /**
+     * @return \App\Models\Subscription[]
+     */
+    public function subscriptions();
+
+    public function subscriptionsRelation(): MorphMany;
 }

app/Models/Subscription.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Models;
+
+use App\User;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+class Subscription extends Model
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected $table = 'subscriptions';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected $fillable = [
+        'subscriptionable_id',
+        'subscriptionable_type',
+    ];
+
+    public function user(): User
+    {
+        return $this->userRelation;
+    }
+
+    public function userRelation(): BelongsTo
+    {
+        return $this->belongsTo(User::class, 'user_id');
+    }
+}

app/Notifications/NewReply.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace App\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+
+class NewReply extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['mail'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage)
+                    ->line('A new reply was posted to this thread.');
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            //
+        ];
+    }
+}

app/Providers/EventServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Providers;
+
+use App\Events\ReplyWasCreated;
+use App\Listeners\SendNewReplyNotification;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+        ReplyWasCreated::class => [
+            SendNewReplyNotification::class,
+        ],
+    ];
+}

config/app.php

@@ -173,6 +173,7 @@
          */
         App\Providers\AppServiceProvider::class,
         App\Providers\AuthServiceProvider::class,
+        App\Providers\EventServiceProvider::class,
         App\Providers\RouteServiceProvider::class,
         App\Markdown\MarkdownServiceProvider::class,
         App\Spam\SpamServiceProvider::class,

database/factories/SubscriptionFactory.php

@@ -0,0 +1,13 @@
+<?php
+
+use App\User;
+use App\Models\Thread;
+use App\Models\Subscription;
+
+$factory->define(Subscription::class, function (Faker\Generator $faker) {
+    return [
+        'user_id' => factory(User::class)->create()->id(),
+        'subscriptionable_id' => factory(Thread::class)->create()->id(),
+        'subscriptionable_type' => Thread::TABLE,
+    ];
+});