1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-06 03:02:34 +01:00
invoiceninja/app/Utils/Traits/InvoiceEmailBuilder.php
David Bomba 74a6c4f2ee
Reminders (#3630)
* Performance improvements moving from str_replace to strtr

* Remove legacy docs

* Clean up credit transformer

* Working on invoice emails

* Clean up for invoice designs

* Tests for light and dark theme emails

* Working on reminder scheduling

* Reminder Job Class

* Fixes for github actions

* PHP CS

* Test for reminders

* Test for reminders
2020-04-15 10:30:52 +10:00

140 lines
5.1 KiB
PHP

<?php
/**
* Invoice Ninja (https://invoiceninja.com)
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2020. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://opensource.org/licenses/AAL
*/
namespace App\Utils\Traits;
use App\Models\ClientContact;
use App\Models\Invoice;
use Illuminate\Support\Carbon;
use League\CommonMark\CommonMarkConverter;
use Parsedown;
/**
* Class InvoiceEmailBuilder
* @package App\Utils\Traits
*/
trait InvoiceEmailBuilder
{
/**
* Builds the correct template to send
* @param string $reminder_template The template name ie reminder1
* @return array
*/
public function getEmailData($reminder_template = null, $contact = null) :array
{
//client
//$client = $this->client;
if (!$reminder_template) {
$reminder_template = $this->calculateTemplate();
}
//Need to determine which email template we are producing
return $this->generateTemplateData($reminder_template, $contact);
}
private function generateTemplateData(string $reminder_template, $contact) :array
{
$data = [];
$client = $this->client;
$body_template = $client->getSetting('email_template_'.$reminder_template);
/* Use default translations if a custom message has not been set*/
if (iconv_strlen($body_template) == 0) {
$body_template = trans('texts.invoice_message', ['amount'=>$this->present()->amount(),'account'=>$this->company->present()->name()], null, $this->client->locale());
}
$subject_template = $client->getSetting('email_subject_'.$reminder_template);
if (iconv_strlen($subject_template) == 0) {
if ($reminder_template == 'invoice') {
$subject_template = trans('texts.invoice_subject', ['number'=>$this->present()->invoice_number(),'account'=>$this->company->present()->name()], null, $this->client->locale());
} else {
$subject_template = trans('texts.reminder_subject', ['number'=>$this->present()->invoice_number(),'account'=>$this->company->present()->name()], null, $this->client->locale());
}
}
$data['body'] = $this->parseTemplate($body_template, true, $contact);
$data['subject'] = $this->parseTemplate($subject_template, false, $contact);
if ($client->getSetting('pdf_email_attachment') !== false) {
$data['files'][] = $this->pdf_file_path();
}
return $data;
}
private function parseTemplate(string $template_data, bool $is_markdown = true, $contact = null) :string
{
$invoice_variables = $this->makeValues($contact);
//process variables
// $data = str_replace(array_keys($invoice_variables), array_values($invoice_variables), $template_data);
$data = strtr($template_data, $invoice_variables);
//process markdown
if ($is_markdown) {
$converter = new CommonMarkConverter([
'html_input' => 'allow',
'allow_unsafe_links' => true,
]);
$data = $converter->convertToHtml($data);
}
return $data;
}
// private function calculateTemplate() :string
// {
// //if invoice is currently a draft, or being marked as sent, this will be the initial email
// $client = $this->client;
// //if the invoice
// if ($this->status_id == Invoice::STATUS_DRAFT || Carbon::parse($this->due_date) > now()) {
// return 'invoice';
// } elseif ($client->getSetting('enable_reminder1') !== false && $this->inReminderWindow($client->getSetting('schedule_reminder1'), $client->getSetting('num_days_reminder1'))) {
// return 'template1';
// } elseif ($client->getSetting('enable_reminder2') !== false && $this->inReminderWindow($client->getSetting('schedule_reminder2'), $client->getSetting('num_days_reminder2'))) {
// return 'template2';
// } elseif ($client->getSetting('enable_reminder3') !== false && $this->inReminderWindow($client->getSetting('schedule_reminder3'), $client->getSetting('num_days_reminder3'))) {
// return 'template3';
// } else {
// return 'invoice';
// }
// //also implement endless reminders here
// }
// private function inReminderWindow($schedule_reminder, $num_days_reminder)
// {
// switch ($schedule_reminder) {
// case 'after_invoice_date':
// return Carbon::parse($this->date)->addDays($num_days_reminder)->startOfDay()->eq(Carbon::now()->startOfDay());
// break;
// case 'before_due_date':
// return Carbon::parse($this->due_date)->subDays($num_days_reminder)->startOfDay()->eq(Carbon::now()->startOfDay());
// break;
// case 'after_due_date':
// return Carbon::parse($this->due_date)->addDays($num_days_reminder)->startOfDay()->eq(Carbon::now()->startOfDay());
// break;
// default:
// # code...
// break;
// }
// }
}