added notifications and email templates

Author: denisdulici

.gitignore

@@ -2,6 +2,6 @@
 /.vscode
 /.vagrant
 /node_modules
-/Resources/assets/js/my-blog.min.js
+/Resources/assets/js/*.min.js
 /storage/*.keyr
-/vendor
+/vendor

Database/Seeds/EmailTemplates.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Modules\MyBlog\Database\Seeds;
+
+use App\Abstracts\Model;
+use App\Models\Common\EmailTemplate;
+use Illuminate\Database\Seeder;
+
+class EmailTemplates extends Seeder
+{
+    public function run()
+    {
+        Model::unguard();
+
+        $this->create();
+
+        Model::reguard();
+    }
+
+    private function create()
+    {
+        $company_id = $this->command->argument('company');
+
+        $templates = [
+            [
+                'alias' => 'comment_new_author',
+                'class' => 'Modules\MyBlog\Notifications\Comment',
+                'name'  => 'my-blog::settings.email.templates.comment_new_author',
+            ],
+            [
+                'alias' => 'comment_delete_author',
+                'class' => 'Modules\MyBlog\Notifications\Comment',
+                'name'  => 'my-blog::settings.email.templates.comment_delete_author',
+            ],
+        ];
+
+        foreach ($templates as $template) {
+            EmailTemplate::firstOrCreate([
+                'company_id' => $company_id,
+                'alias'      => $template['alias'],
+                'class'      => $template['class'],
+                'name'       => $template['name'],
+                'subject'    => trans('my-blog::email_templates.' . $template['alias'] . '.subject'),
+                'body'       => trans('my-blog::email_templates.' . $template['alias'] . '.body'),
+            ]);
+        }
+    }
+}

Database/Seeds/Install.php

@@ -18,6 +18,7 @@ public function run()
 
         $this->call(Categories::class);
         $this->call(Dashboards::class);
+        $this->call(EmailTemplates::class);
 
         Model::reguard();
     }

Http/Controllers/Portal/Comments.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Modules\MyBlog\Http\Controllers\Portal;
+
+use App\Abstracts\Http\Controller;
+use Illuminate\Http\Response;
+use Modules\MyBlog\Http\Requests\Comment as Request;
+use Modules\MyBlog\Jobs\CreateComment;
+
+class Comments extends Controller
+{
+    /**
+     * Store a newly created resource in storage.
+     *
+     * @param  Request $request
+     *
+     * @return Response
+     */
+    public function store(Request $request)
+    {
+        $response = $this->ajaxDispatch(new CreateComment($request));
+
+        $response['redirect'] = route('portal.my-blog.posts.show', $request->get('post_id'));
+
+        if ($response['success']) {
+            $message = trans('messages.success.added', ['type' => trans_choice('my-blog::general.comments', 1)]);
+
+            flash($message)->success();
+        } else {
+            $message = $response['message'];
+
+            flash($message)->error()->important();
+        }
+
+        return response()->json($response);
+    }
+}

Http/Controllers/Portal/Posts.php

@@ -27,8 +27,17 @@ public function index()
      */
     public function show(Post $post)
     {
-        $post->load('comments');
+        if (setting('my-blog.enable_comments')) {
+            $post->load('category', 'comments');
 
-        return view('my-blog::portal.posts.show', compact('post'));
+            $limit = (int) request('limit', setting('default.list_limit', '25'));
+            $comments = $this->paginate($post->comments->sortByDesc('created_at'), $limit);
+        } else {
+            $post->load('category');
+
+            $comments = [];
+        }
+
+        return view('my-blog::portal.posts.show', compact('post', 'comments'));
     }
 }

Notifications/Comment.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Modules\MyBlog\Notifications;
+
+use App\Abstracts\Notification;
+use App\Models\Common\EmailTemplate;
+use Illuminate\Notifications\Messages\MailMessage;
+use Modules\MyBlog\Models\Comment as Model;
+
+class Comment extends Notification
+{
+    /**
+     * The comment model.
+     *
+     * @var Model
+     */
+    public $comment;
+
+    /**
+     * The email template.
+     *
+     * @var EmailTemplate
+     */
+    public $template;
+
+    public function __construct($comment = null, $template_alias = null)
+    {
+        parent::__construct();
+
+        $this->comment = $comment;
+        $this->template = EmailTemplate::alias($template_alias)->first();
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     */
+    public function toMail($notifiable): MailMessage
+    {
+        $message = $this->initMessage();
+
+        return $message;
+    }
+
+    /**
+     * Get the array representation of the notification.
+     */
+    public function toArray($notifiable): array
+    {
+        return [
+            'template_alias' => $this->template->alias,
+            'post_id' => $this->comment->post->id,
+            'post_name' => $this->comment->post->name,
+            'comment_id' => $this->comment->id,
+            'comment_author' => $this->comment->owner->name,
+        ];
+    }
+
+    public function getTags(): array
+    {
+        return [
+            '{post_name}',
+            '{post_author}',
+            '{comment_author}',
+            '{comment_description}',
+            '{company_name}',
+        ];
+    }
+
+    public function getTagsReplacement(): array
+    {
+        return [
+            $this->comment->post->name,
+            $this->comment->post->owner->name,
+            $this->comment->owner->name,
+            $this->comment->description,
+            $this->comment->company->name,
+        ];
+    }
+}

Observers/Comment.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Modules\MyBlog\Observers;
+
+use App\Abstracts\Observer;
+use Modules\MyBlog\Notifications\Comment as Notification;
+use Modules\MyBlog\Models\Comment as Model;
+
+class Comment extends Observer
+{
+    /**
+     * Listen to the created event.
+     *
+     * @param  Model $comment
+     *
+     * @return void
+     */
+    public function created(Model $comment)
+    {
+        $user = $comment->post->owner;
+
+        $user->notify(new Notification($comment, 'comment_new_author'));
+    }
+
+    /**
+     * Listen to the deleted event.
+     *
+     * @param  Model $comment
+     *
+     * @return void
+     */
+    public function deleted(Model $comment)
+    {
+        $user = $comment->post->owner;
+
+        $user->notify(new Notification($comment, 'comment_delete_author'));
+    }
+}

Providers/Observer.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Modules\MyBlog\Providers;
+
+use Illuminate\Support\ServiceProvider as Provider;
+use Modules\MyBlog\Models\Comment;
+
+class Observer extends Provider
+{
+    /**
+     * Boot the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        Comment::observe('Modules\MyBlog\Observers\Comment');
+    }
+}

README.md

@@ -24,12 +24,13 @@ This is an example module with beyond CRUD functions for admin and is shown in t
 - [x] Dashboard ([seed](Database/Seeds/Install.php#L20))
 - [x] ~~Document Type~~
 - [x] Dynamic Relationships ([define](Providers/Main.php#L35), [use](Widgets/PostsByCategory.php#L18))
-- [ ] Email Templates
+- [x] Email Templates ([seed](Database/Seeds/Install.php#L21), [content](Resources/lang/en-GB/email_templates.php))
 - [x] Exports ([controller](Http/Controllers/Posts.php#L244), [class](Exports))
 - [x] Imports ([controller](Http/Controllers/Posts.php#L117), [class](Imports))
 - [x] Jobs ([bulk action](BulkActions/Posts.php#L47), [ui](Http/Controllers/Posts.php#L222), [api](Http/Controllers/Api/Posts.php#L104))
 - [x] Menu ([admin](Listeners/AddToAdminMenu.php), [portal](Listeners/AddToPortalMenu.php))
-- [ ] Notifications
+- [x] Notifications ([trigger](Observers/Comment.php#L22), [class](Notifications/Comment.php))
+- [x] Observers ([define](module.json#L9), [provider](Providers/Observer.php), [class](Observers/Comment.php))
 - [x] Ownership (`created_by` [field](Models/Post.php#L14), [controller](Http/Controllers/Posts.php#L26), [blade](Resources/views/posts/index.blade.php#L54))
 - [x] Permissions ([listener](Listeners/FinishInstallation.php#L32))
 - [x] Reports ([define](module.json#L13), [report](Reports/PostSummary.php), [listener](Listeners/AddCategoriesToReport.php))

Resources/assets/js/comments.js

@@ -0,0 +1,32 @@
+/**
+ * First we will load all of this project's JavaScript dependencies which
+ * includes Vue and other libraries. It is a great starting point when
+ * building robust, powerful web applications using Vue and Laravel.
+ */
+
+require('./../../../../../resources/assets/js/bootstrap');
+
+import Vue from 'vue';
+
+import Global from './../../../../../resources/assets/js/mixins/global';
+import DashboardPlugin from './../../../../../resources/assets/js/plugins/dashboard-plugin';
+import Form from './../../../../../resources/assets/js/plugins/form';
+import BulkAction from './../../../../../resources/assets/js/plugins/bulk-action';
+
+// plugin setup
+Vue.use(DashboardPlugin);
+
+const app = new Vue({
+    el: '#main-body',
+
+    mixins: [
+        Global
+    ],
+
+    data() {
+        return {
+            form: new Form('comment'),
+            bulk_action: new BulkAction('comments')
+        }
+    },
+});