invoiceninja/app/Jobs/Entity/EmailEntity.php

163 lines
4.9 KiB
PHP
Raw Normal View History

2020-10-27 11:05:42 +11:00
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
2020-10-27 11:05:42 +11:00
*
2021-06-16 16:58:16 +10:00
* @license https://www.elastic.co/licensing/elastic-license
2020-10-27 11:05:42 +11:00
*/
2020-10-27 22:57:12 +11:00
namespace App\Jobs\Entity;
2020-10-27 11:05:42 +11:00
2020-11-09 21:17:20 +11:00
use App\Events\Invoice\InvoiceReminderWasEmailed;
2020-10-27 11:05:42 +11:00
use App\Events\Invoice\InvoiceWasEmailed;
use App\Events\Invoice\InvoiceWasEmailedAndFailed;
2021-01-20 12:59:39 +11:00
use App\Jobs\Mail\EntityFailedSendMailer;
2021-02-16 23:56:12 +11:00
use App\Jobs\Mail\NinjaMailerJob;
use App\Jobs\Mail\NinjaMailerObject;
2020-10-27 11:05:42 +11:00
use App\Libraries\MultiDB;
use App\Mail\TemplateEmail;
2020-11-09 21:17:20 +11:00
use App\Models\Activity;
2020-10-27 11:05:42 +11:00
use App\Models\Company;
use App\Models\CreditInvitation;
use App\Models\InvoiceInvitation;
use App\Models\QuoteInvitation;
use App\Models\RecurringInvoiceInvitation;
2020-10-27 22:57:12 +11:00
use App\Utils\HtmlEngine;
2020-10-27 11:05:42 +11:00
use App\Utils\Ninja;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Mail;
2020-10-27 22:57:12 +11:00
use Illuminate\Support\Str;
2021-04-06 08:35:27 +10:00
use Illuminate\Support\Facades\App;
2020-10-27 11:05:42 +11:00
/*Multi Mailer implemented*/
2021-02-17 00:31:00 +11:00
class EmailEntity implements ShouldQueue
2020-10-27 11:05:42 +11:00
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
2021-01-20 14:49:22 +11:00
public $invitation; //The entity invitation
2020-10-27 11:05:42 +11:00
2021-01-20 14:49:22 +11:00
public $company; //The company
2020-10-27 11:05:42 +11:00
2021-01-20 14:49:22 +11:00
public $settings; //The settings object
2020-10-27 11:05:42 +11:00
2021-01-20 14:49:22 +11:00
public $entity_string; //The entity string ie. invoice, quote, credit
2020-10-27 11:05:42 +11:00
2021-01-20 14:49:22 +11:00
public $reminder_template; //The base template we are using
2020-10-27 22:57:12 +11:00
2021-01-20 14:49:22 +11:00
public $entity; //The entity object
2020-10-27 22:57:12 +11:00
2021-01-20 14:49:22 +11:00
public $html_engine; //The HTMLEngine object
2020-10-27 22:57:12 +11:00
2021-01-20 14:49:22 +11:00
public $email_entity_builder; //The email builder which merges the template and text
2020-10-27 22:57:12 +11:00
2021-01-20 14:49:22 +11:00
public $template_data; //The data to be merged into the template
2021-04-30 09:01:56 +10:00
public $tries = 1;
2020-10-27 11:05:42 +11:00
/**
* EmailEntity constructor.
2021-01-20 14:49:22 +11:00
*
*
2020-10-27 11:05:42 +11:00
* @param Invitation $invitation
2020-10-27 22:57:12 +11:00
* @param Company $company
* @param ?string $reminder_template
2021-01-20 14:49:22 +11:00
* @param array $template_data
2020-10-27 11:05:42 +11:00
*/
2020-11-06 15:43:10 +11:00
public function __construct($invitation, Company $company, ?string $reminder_template = null, $template_data = null)
2020-10-27 11:05:42 +11:00
{
$this->company = $company;
$this->invitation = $invitation;
$this->settings = $invitation->contact->client->getMergedSettings();
$this->entity_string = $this->resolveEntityString();
2020-10-27 22:57:12 +11:00
$this->entity = $invitation->{$this->entity_string};
2020-11-04 20:32:49 +11:00
$this->reminder_template = $reminder_template ?: $this->entity->calculateTemplate($this->entity_string);
2020-10-27 22:57:12 +11:00
$this->html_engine = new HtmlEngine($invitation);
2020-11-05 21:14:30 +11:00
$this->template_data = $template_data;
2020-10-27 22:57:12 +11:00
$this->email_entity_builder = $this->resolveEmailBuilder();
2020-10-27 11:05:42 +11:00
}
/**
* Execute the job.
*
*
* @return void
*/
public function handle()
{
2021-01-20 14:49:22 +11:00
/* Don't fire emails if the company is disabled */
if ($this->company->is_disabled)
2020-11-01 14:19:03 +11:00
return true;
2021-01-20 14:49:22 +11:00
/* Set DB */
2020-10-27 11:05:42 +11:00
MultiDB::setDB($this->company->db);
2021-04-06 08:35:27 +10:00
App::setLocale($this->invitation->contact->preferredLocale());
2021-02-16 23:56:12 +11:00
$nmo = new NinjaMailerObject;
2021-06-10 11:15:21 +10:00
$nmo->mailable = new TemplateEmail($this->email_entity_builder, $this->invitation->contact, $this->invitation);
2021-02-16 23:56:12 +11:00
$nmo->company = $this->company;
$nmo->settings = $this->settings;
$nmo->to_user = $this->invitation->contact;
$nmo->entity_string = $this->entity_string;
$nmo->invitation = $this->invitation;
$nmo->reminder_template = $this->reminder_template;
2021-02-18 10:30:31 +11:00
$nmo->entity = $this->entity;
2021-08-02 07:41:46 +10:00
NinjaMailerJob::dispatchNow($nmo);
2021-02-16 23:56:12 +11:00
2020-10-27 22:57:12 +11:00
/* Mark entity sent */
$this->entity->service()->markSent()->save();
2020-10-27 11:05:42 +11:00
}
private function resolveEntityString() :string
{
2020-11-25 15:19:52 +01:00
if ($this->invitation instanceof InvoiceInvitation) {
2020-10-27 11:05:42 +11:00
return 'invoice';
2020-11-25 15:19:52 +01:00
} elseif ($this->invitation instanceof QuoteInvitation) {
2020-10-27 11:05:42 +11:00
return 'quote';
2020-11-25 15:19:52 +01:00
} elseif ($this->invitation instanceof CreditInvitation) {
2020-10-27 11:05:42 +11:00
return 'credit';
2020-11-25 15:19:52 +01:00
} elseif ($this->invitation instanceof RecurringInvoiceInvitation) {
2020-10-27 11:05:42 +11:00
return 'recurring_invoice';
2020-11-25 15:19:52 +01:00
}
2020-10-27 11:05:42 +11:00
}
2021-02-16 23:56:12 +11:00
/* Switch statement to handle failure notifications */
2020-10-27 11:05:42 +11:00
private function entityEmailFailed($message)
{
switch ($this->entity_string) {
case 'invoice':
2021-05-07 07:12:07 +10:00
event(new InvoiceWasEmailedAndFailed($this->invitation, $this->company, $message, $this->reminder_template, Ninja::eventVars(auth()->user() ? auth()->user()->id : null)));
2020-10-27 11:05:42 +11:00
break;
2020-10-28 21:10:49 +11:00
2020-10-27 11:05:42 +11:00
default:
# code...
break;
}
}
2021-01-20 14:49:22 +11:00
/* Builds the email builder object */
2020-10-27 22:57:12 +11:00
private function resolveEmailBuilder()
{
$class = 'App\Mail\Engine\\' . ucfirst(Str::camel($this->entity_string)) . "EmailEngine";
2020-11-05 21:14:30 +11:00
return (new $class($this->invitation, $this->reminder_template, $this->template_data))->build();
2020-10-27 22:57:12 +11:00
}
2020-10-27 11:05:42 +11:00
}