Purchase Order Notifications

app/Listeners/PurchaseOrder/PurchaseOrderAcceptedListener.php

@@ -21,12 +21,10 @@ use App\Notifications\Admin\EntitySentNotification;
 use App\Utils\Traits\Notifications\UserNotifies;
 use Illuminate\Contracts\Queue\ShouldQueue;
 
-class PurchaseOrderAcceptedNotification implements ShouldQueue
+class PurchaseOrderAcceptedListener implements ShouldQueue
 {
     use UserNotifies;
 
-    public $delay = 5;
-
     public function __construct()
     {
     }

app/Listeners/PurchaseOrder/PurchaseOrderCreatedListener.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * PurchaseOrder Ninja (https://purchase_orderninja.com).
+ *
+ * @link https://github.com/purchase_orderninja/purchase_orderninja source repository
+ *
+ * @copyright Copyright (c) 2022. PurchaseOrder Ninja LLC (https://purchase_orderninja.com)
+ *
+ * @license https://www.elastic.co/licensing/elastic-license
+ */
+
+namespace App\Listeners\PurchaseOrder;
+
+use App\Events\PurchaseOrder\PurchaseOrderWasCreated;
+use App\Jobs\Mail\NinjaMailer;
+use App\Jobs\Mail\NinjaMailerJob;
+use App\Jobs\Mail\NinjaMailerObject;
+use App\Libraries\MultiDB;
+use App\Mail\Admin\EntityCreatedObject;
+use App\Notifications\Admin\EntitySentNotification;
+use App\Utils\Traits\Notifications\UserNotifies;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+class PurchaseOrderCreatedListener implements ShouldQueue
+{
+    use UserNotifies;
+
+    public function __construct()
+    {
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  object  $event
+     * @return void
+     */
+    public function handle(PurchaseOrderWasCreated $event)
+    {
+        
+        MultiDB::setDb($event->company->db);
+
+        $first_notification_sent = true;
+
+        $purchase_order = $event->purchase_order;
+
+        $nmo = new NinjaMailerObject;
+        $nmo->mailable = new NinjaMailer((new EntityCreatedObject($purchase_order, 'purchase_order'))->build());
+        $nmo->company = $purchase_order->company;
+        $nmo->settings = $purchase_order->company->settings;
+
+        /* We loop through each user and determine whether they need to be notified */
+        foreach ($event->company->company_users as $company_user) {
+
+            /* The User */
+            $user = $company_user->user;
+
+            if (! $user) {
+                continue;
+            }
+
+            /* This is only here to handle the alternate message channels - ie Slack */
+            // $notification = new EntitySentNotification($event->invitation, 'purchase_order');
+
+            /* Returns an array of notification methods */
+            $methods = $this->findUserNotificationTypes($purchase_order->invitations()->first(), $company_user, 'purchase_order', ['all_notifications', 'purchase_order_created', 'purchase_order_created_all']);
+            /* If one of the methods is email then we fire the EntitySentMailer */
+
+            if (($key = array_search('mail', $methods)) !== false) {
+                unset($methods[$key]);
+
+                $nmo->to_user = $user;
+
+                NinjaMailerJob::dispatch($nmo);
+
+                /* This prevents more than one notification being sent */
+                $first_notification_sent = false;
+            }
+        }
+    }
+}

app/Listeners/PurchaseOrder/PurchaseOrderEmailedNotification.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * PurchaseOrder Ninja (https://purchase_orderninja.com).
+ *
+ * @link https://github.com/purchase_orderninja/purchase_orderninja source repository
+ *
+ * @copyright Copyright (c) 2022. PurchaseOrder Ninja LLC (https://purchase_orderninja.com)
+ *
+ * @license https://www.elastic.co/licensing/elastic-license
+ */
+
+namespace App\Listeners\PurchaseOrder;
+
+use App\Jobs\Mail\NinjaMailer;
+use App\Jobs\Mail\NinjaMailerJob;
+use App\Jobs\Mail\NinjaMailerObject;
+use App\Libraries\MultiDB;
+use App\Mail\Admin\EntitySentObject;
+use App\Notifications\Admin\EntitySentNotification;
+use App\Utils\Traits\Notifications\UserNotifies;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+class PurchaseOrderEmailedNotification implements ShouldQueue
+{
+    use UserNotifies;
+
+    public $delay = 5;
+
+    public function __construct()
+    {
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  object  $event
+     * @return void
+     */
+    public function handle($event)
+    {
+        MultiDB::setDb($event->company->db);
+
+        $first_notification_sent = true;
+
+        $purchase_order = $event->invitation->purchase_order->fresh();
+        $purchase_order->last_sent_date = now();
+        $purchase_order->saveQuietly();
+
+        $nmo = new NinjaMailerObject;
+        $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'purchase_order', 'purchase_order'))->build());
+        $nmo->company = $purchase_order->company;
+        $nmo->settings = $purchase_order->company->settings;
+
+        /* We loop through each user and determine whether they need to be notified */
+        foreach ($event->invitation->company->company_users as $company_user) {
+
+            /* The User */
+            $user = $company_user->user;
+
+            /* This is only here to handle the alternate message channels - ie Slack */
+            // $notification = new EntitySentNotification($event->invitation, 'purchase_order');
+
+            /* Returns an array of notification methods */
+            $methods = $this->findUserNotificationTypes($event->invitation, $company_user, 'purchase_order', ['all_notifications', 'purchase_order_sent', 'purchase_order_sent_all']);
+
+            /* If one of the methods is email then we fire the EntitySentMailer */
+            if (($key = array_search('mail', $methods)) !== false) {
+                unset($methods[$key]);
+
+                $nmo->to_user = $user;
+
+                NinjaMailerJob::dispatch($nmo);
+
+                /* This prevents more than one notification being sent */
+                $first_notification_sent = false;
+            }
+
+            /* Override the methods in the Notification Class */
+            // $notification->method = $methods;
+
+            //  Notify on the alternate channels
+            // $user->notify($notification);
+        }
+    }
+}

app/Mail/Admin/EntityCreatedObject.php

@@ -13,6 +13,7 @@ namespace App\Mail\Admin;
 
 use App\Utils\Ninja;
 use App\Utils\Number;
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\Facades\App;
 use stdClass;
 
@@ -38,7 +39,11 @@ class EntityCreatedObject
         $this->entity = $entity;
     }
 
-    public function build()
+    /**
+     * @return stdClass 
+     * @throws BindingResolutionException 
+     */
+    public function build() :stdClass
     {
         App::forgetInstance('translator');
         /* Init a new copy of the translator*/
@@ -47,26 +52,64 @@ class EntityCreatedObject
         App::setLocale($this->entity->company->getLocale());
         /* Set customized translations _NOW_ */
         $t->replace(Ninja::transformTranslations($this->entity->company->settings));
+        $this->setTemplate();
+        $this->company = $this->entity->company;
+
+        if($this->entity_type == 'purchase_order')
+        {
+
+            $this->entity->load('vendor.company');
+
+            $mail_obj = new stdClass;
+            $mail_obj->amount = Number::formatMoney($this->entity->amount, $this->entity->vendor);
+            
+            $mail_obj->subject = ctrans($this->template_subject,
+                                [
+                                    'vendor' => $this->entity->vendor->present()->name(),
+                                    'purchase_order' => $this->entity->number,
+                                ]
+                            );
+
+            $mail_obj->markdown = 'email.admin.generic';
+            $mail_obj->tag = $this->company->company_key;
+            $mail_obj->data = [
+                                'title' => $mail_obj->subject,
+                                'message' => ctrans($this->template_body,
+                                            [
+                                                'amount' => $mail_obj->amount,
+                                                'vendor' => $this->entity->vendor->present()->name(),
+                                                'purchase_order' => $this->entity->number,
+                                            ]
+                                        ),
+                                'url' => $this->entity->invitations()->first()->getAdminLink(),
+                                'button' => ctrans("texts.view_{$this->entity_type}"),
+                                'signature' => $this->company->settings->email_signature,
+                                'logo' => $this->company->present()->logo(),
+                                'settings' => $this->company->settings,
+                                'whitelabel' => $this->company->account->isPaid() ? true : false,
+                            ];
+
+
+        }
+        else {
 
             $this->entity->load('client.country', 'client.company');
             $this->client = $this->entity->client;
-        $this->company = $this->entity->company;
-
-        $this->setTemplate();
 
             $mail_obj = new stdClass;
             $mail_obj->amount = $this->getAmount();
             $mail_obj->subject = $this->getSubject();
             $mail_obj->data = $this->getData();
             $mail_obj->markdown = 'email.admin.generic';
-        $mail_obj->tag = $this->company->company_key;
+            $mail_obj->tag = $this->entity->company->company_key;
+
+        }
         
         return $mail_obj;
     }
 
     private function setTemplate()
     {
-        // nlog($this->template);
 
         switch ($this->entity_type) {
             case 'invoice':
@@ -81,7 +124,10 @@ class EntityCreatedObject
                 $this->template_subject = 'texts.notification_credit_created_subject';
                 $this->template_body = 'texts.notification_credit_created_body';
                 break;
-
+            case 'purchase_order':
+                $this->template_subject = 'texts.notification_purchase_order_created_subject';
+                $this->template_body = 'texts.notification_purchase_order_created_body';
+                break;
             default:
                 $this->template_subject = 'texts.notification_invoice_created_subject';
                 $this->template_body = 'texts.notification_invoice_created_body';

app/Mail/Admin/EntitySentObject.php

@@ -58,6 +58,39 @@ class EntitySentObject
 
         $this->setTemplate();
 
+        if($this->template == 'purchase_order')
+        {
+
+            $mail_obj = new stdClass;
+            $mail_obj->amount = Number::formatMoney($this->entity->amount, $this->entity->vendor);
+            $mail_obj->subject = ctrans($this->template_subject,
+                [
+                    'vendor' => $this->contact->vendor->present()->name(),
+                    'purchase_order' => $this->entity->number,
+                ]
+            );
+            $mail_obj->data = [
+                'title' => $mail_obj->subject,
+                'message' => ctrans($this->template_body,
+                            [
+                                'amount' => $mail_obj->amount,
+                                'vendor' => $this->contact->vendor->present()->name(),
+                                'purchase_order' => $this->entity->number,
+                            ]
+                        ),
+                'url' => $this->invitation->getAdminLink(),
+                'button' => ctrans("texts.view_{$this->entity_type}"),
+                'signature' => $this->company->settings->email_signature,
+                'logo' => $this->company->present()->logo(),
+                'settings' => $this->company->settings,
+                'whitelabel' => $this->company->account->isPaid() ? true : false,
+            ];
+            $mail_obj->markdown = 'email.admin.generic';
+            $mail_obj->tag = $this->company->company_key;
+        
+        }
+        else {
+        
             $mail_obj = new stdClass;
             $mail_obj->amount = $this->getAmount();
             $mail_obj->subject = $this->getSubject();
@@ -65,6 +98,8 @@ class EntitySentObject
             $mail_obj->markdown = 'email.admin.generic';
             $mail_obj->tag = $this->company->company_key;
         
+        }
+        
         return $mail_obj;
     }
 
@@ -101,7 +136,10 @@ class EntitySentObject
                 $this->template_subject = 'texts.notification_credit_sent_subject';
                 $this->template_body = 'texts.notification_credit_sent';
                 break;
-
+            case 'purchase_order':
+                $this->template_subject = 'texts.notification_purchase_order_sent_subject';
+                $this->template_body = 'texts.notification_purchase_order_sent';
+                break;
             default:
                 $this->template_subject = 'texts.notification_invoice_sent_subject';
                 $this->template_body = 'texts.notification_invoice_sent';

app/Providers/EventServiceProvider.php

@@ -157,15 +157,14 @@ use App\Listeners\Credit\CreditRestoredActivity;
 use App\Listeners\Credit\CreditViewedActivity;
 use App\Listeners\Document\DeleteCompanyDocuments;
 use App\Listeners\Invoice\CreateInvoiceActivity;
-use App\Listeners\Invoice\CreateInvoiceHtmlBackup;
 use App\Listeners\Invoice\CreateInvoicePdf;
 use App\Listeners\Invoice\InvoiceArchivedActivity;
 use App\Listeners\Invoice\InvoiceCancelledActivity;
 use App\Listeners\Invoice\InvoiceCreatedNotification;
 use App\Listeners\Invoice\InvoiceDeletedActivity;
 use App\Listeners\Invoice\InvoiceEmailActivity;
-use App\Listeners\Invoice\InvoiceEmailedNotification;
 use App\Listeners\Invoice\InvoiceEmailFailedActivity;
+use App\Listeners\Invoice\InvoiceEmailedNotification;
 use App\Listeners\Invoice\InvoiceFailedEmailNotification;
 use App\Listeners\Invoice\InvoicePaidActivity;
 use App\Listeners\Invoice\InvoiceReminderEmailActivity;
@@ -175,18 +174,21 @@ use App\Listeners\Invoice\InvoiceViewedActivity;
 use App\Listeners\Invoice\UpdateInvoiceActivity;
 use App\Listeners\Mail\MailSentListener;
 use App\Listeners\Misc\InvitationViewedListener;
-use App\Listeners\Payment\PaymentEmailedActivity;
 use App\Listeners\Payment\PaymentEmailFailureActivity;
+use App\Listeners\Payment\PaymentEmailedActivity;
 use App\Listeners\Payment\PaymentNotification;
 use App\Listeners\Payment\PaymentRestoredActivity;
 use App\Listeners\PurchaseOrder\CreatePurchaseOrderActivity;
 use App\Listeners\PurchaseOrder\PurchaseOrderAcceptedActivity;
-use App\Listeners\PurchaseOrder\PurchaseOrderAcceptedNotification;
+use App\Listeners\PurchaseOrder\PurchaseOrderAcceptedListener;
 use App\Listeners\PurchaseOrder\PurchaseOrderArchivedActivity;
+use App\Listeners\PurchaseOrder\PurchaseOrderCreatedListener;
 use App\Listeners\PurchaseOrder\PurchaseOrderDeletedActivity;
 use App\Listeners\PurchaseOrder\PurchaseOrderEmailActivity;
+use App\Listeners\PurchaseOrder\PurchaseOrderEmailedNotification;
 use App\Listeners\PurchaseOrder\PurchaseOrderRestoredActivity;
 use App\Listeners\PurchaseOrder\PurchaseOrderViewedActivity;
+use App\Listeners\PurchaseOrder\PurchaseOrderViewedNotification;
 use App\Listeners\PurchaseOrder\UpdatePurchaseOrderActivity;
 use App\Listeners\Quote\QuoteApprovedActivity;
 use App\Listeners\Quote\QuoteApprovedNotification;
@@ -219,8 +221,8 @@ use App\Listeners\User\ArchivedUserActivity;
 use App\Listeners\User\CreatedUserActivity;
 use App\Listeners\User\DeletedUserActivity;
 use App\Listeners\User\RestoredUserActivity;
-use App\Listeners\User\UpdatedUserActivity;
 use App\Listeners\User\UpdateUserLastLogin;
+use App\Listeners\User\UpdatedUserActivity;
 use App\Models\Account;
 use App\Models\Client;
 use App\Models\Company;
@@ -398,7 +400,6 @@ class EventServiceProvider extends ServiceProvider
         ],
         //Invoices
         InvoiceWasMarkedSent::class => [
-            CreateInvoiceHtmlBackup::class,
         ],
         InvoiceWasUpdated::class => [
             UpdateInvoiceActivity::class,
@@ -458,12 +459,14 @@ class EventServiceProvider extends ServiceProvider
         ],
         PurchaseOrderWasCreated::class => [
             CreatePurchaseOrderActivity::class,
+            PurchaseOrderCreatedListener::class,
         ],
         PurchaseOrderWasDeleted::class => [
             PurchaseOrderDeletedActivity::class,
         ],
         PurchaseOrderWasEmailed::class => [
             PurchaseOrderEmailActivity::class,
+            PurchaseOrderEmailedNotification::class,
         ],
         PurchaseOrderWasRestored::class => [
             PurchaseOrderRestoredActivity::class,
@@ -475,8 +478,8 @@ class EventServiceProvider extends ServiceProvider
             PurchaseOrderViewedActivity::class,
         ],
         PurchaseOrderWasAccepted::class => [
+            PurchaseOrderAcceptedListener::class,
             PurchaseOrderAcceptedActivity::class,
-            PurchaseOrderAcceptedNotification::class,
         ],
         CompanyDocumentsDeleted::class => [
             DeleteCompanyDocuments::class,

lang/en/texts.php

@@ -4906,7 +4906,10 @@ $LANG = array(
     'backup_restore' => 'Backup | Restore',
     'export_company' => 'Create company backup',
     'backup' => 'Backup',
-    
+    'notification_purchase_order_created_body' => 'The following purchase_order :purchase_order was created for vendor :vendor for :amount.',
+    'notification_purchase_order_created_subject' => 'Purchase Order :purchase_order was created for :vendor',    
+    'notification_purchase_order_sent_subject' => 'Purchase Order :purchase_order was sent to :vendor',
+    'notification_purchase_order_sent' => 'The following vendor :vendor was emailed Purchase Order :purchase_order for :amount.',
 );
 
 return $LANG;