mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-09-20 16:31:33 +02:00
19080933b6
Shift automatically applies the Laravel coding style - which uses the PSR-2 coding style as a base with some minor additions. You may customize the code style applied by adding a [PHP CS Fixer][1] or [PHP CodeSniffer][2] ruleset to your project root. Feel free to use [Shift's Laravel ruleset][3] to help you get started. For more information on customizing the code style applied by Shift, [watch this short video][4]. [1]: https://github.com/FriendsOfPHP/PHP-CS-Fixer [2]: https://github.com/squizlabs/PHP_CodeSniffer [3]: https://gist.github.com/laravel-shift/cab527923ed2a109dda047b97d53c200 [4]: https://laravelshift.com/videos/shift-code-style
308 lines
19 KiB
PHP
308 lines
19 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2022. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Mail\Engine;
|
|
|
|
use App\DataMapper\EmailTemplateDefaults;
|
|
use App\Models\Account;
|
|
use App\Utils\Helpers;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\Number;
|
|
use App\Utils\Traits\MakesDates;
|
|
use Illuminate\Support\Facades\App;
|
|
|
|
class PaymentEmailEngine extends BaseEmailEngine
|
|
{
|
|
use MakesDates;
|
|
|
|
public $client;
|
|
|
|
public $payment;
|
|
|
|
public $template_data;
|
|
|
|
public $settings;
|
|
|
|
public $company;
|
|
|
|
public $contact;
|
|
|
|
private $helpers;
|
|
|
|
private $payment_template_body;
|
|
|
|
private $payment_template_subject;
|
|
|
|
public function __construct($payment, $contact, $template_data = null)
|
|
{
|
|
$this->payment = $payment;
|
|
$this->company = $payment->company;
|
|
$this->client = $payment->client;
|
|
$this->contact = $contact ?: $this->client->contacts()->first();
|
|
$this->contact->load('client.company');
|
|
$this->settings = $this->client->getMergedSettings();
|
|
$this->template_data = $template_data;
|
|
$this->helpers = new Helpers();
|
|
}
|
|
|
|
public function build()
|
|
{
|
|
App::forgetInstance('translator');
|
|
$t = app('translator');
|
|
App::setLocale($this->contact->preferredLocale());
|
|
$t->replace(Ninja::transformTranslations($this->client->getMergedSettings()));
|
|
|
|
$this->resolvePaymentTemplate();
|
|
|
|
if (is_array($this->template_data) && array_key_exists('body', $this->template_data) && strlen($this->template_data['body']) > 0) {
|
|
$body_template = $this->template_data['body'];
|
|
} elseif (strlen($this->client->getSetting($this->payment_template_body)) > 0) {
|
|
$body_template = $this->client->getSetting($this->payment_template_body);
|
|
} else {
|
|
$body_template = EmailTemplateDefaults::getDefaultTemplate($this->payment_template_body, $this->client->locale());
|
|
}
|
|
|
|
if (is_array($this->template_data) && array_key_exists('subject', $this->template_data) && strlen($this->template_data['subject']) > 0) {
|
|
$subject_template = $this->template_data['subject'];
|
|
} elseif (strlen($this->client->getSetting($this->payment_template_subject)) > 0) {
|
|
$subject_template = $this->client->getSetting($this->payment_template_subject);
|
|
} else {
|
|
$subject_template = EmailTemplateDefaults::getDefaultTemplate($this->payment_template_subject, $this->client->locale());
|
|
}
|
|
|
|
$this->setTemplate($this->client->getSetting('email_style'))
|
|
->setContact($this->contact)
|
|
->setVariables($this->makeValues())
|
|
->setSubject($subject_template)
|
|
->setBody($body_template)
|
|
->setFooter('')
|
|
->setViewLink('')
|
|
->setViewText('');
|
|
|
|
if ($this->client->getSetting('pdf_email_attachment') !== false && $this->company->account->hasFeature(Account::FEATURE_PDF_ATTACHMENT)) {
|
|
$this->payment->invoices->each(function ($invoice) {
|
|
if (Ninja::isHosted()) {
|
|
$this->setAttachments([$invoice->pdf_file_path($invoice->invitations->first(), 'url', true)]);
|
|
} else {
|
|
$this->setAttachments([$invoice->pdf_file_path($invoice->invitations->first())]);
|
|
}
|
|
});
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Helper method to resolve which payment template
|
|
* to use. We need to check the invoice balances to
|
|
* determine if this is a partial payment, or full payment.
|
|
*
|
|
* @return $this
|
|
*/
|
|
private function resolvePaymentTemplate()
|
|
{
|
|
$partial = $this->payment->invoices->contains(function ($invoice) {
|
|
return $invoice->balance > 0;
|
|
});
|
|
|
|
if ($partial) {
|
|
$this->payment_template_body = 'email_template_payment_partial';
|
|
$this->payment_template_subject = 'email_subject_payment_partial';
|
|
} else {
|
|
$this->payment_template_body = 'email_template_payment';
|
|
$this->payment_template_subject = 'email_subject_payment';
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function makePaymentVariables()
|
|
{
|
|
$data = [];
|
|
|
|
$data['$from'] = ['value' => '', 'label' => ctrans('texts.from')];
|
|
$data['$to'] = ['value' => '', 'label' => ctrans('texts.to')];
|
|
$data['$number'] = ['value' => $this->payment->number ?: ' ', 'label' => ctrans('texts.payment_number')];
|
|
$data['$payment.number'] = &$data['$number'];
|
|
$data['$entity'] = ['value' => '', 'label' => ctrans('texts.payment')];
|
|
$data['$payment.amount'] = ['value' => Number::formatMoney($this->payment->amount, $this->client) ?: ' ', 'label' => ctrans('texts.amount')];
|
|
$data['$payment.refunded'] = ['value' => Number::formatMoney($this->payment->refunded, $this->client) ?: ' ', 'label' => ctrans('texts.refund')];
|
|
$data['$amount'] = &$data['$payment.amount'];
|
|
$data['$payment.date'] = ['value' => $this->translateDate($this->payment->date, $this->client->date_format(), $this->client->locale()), 'label' => ctrans('texts.payment_date')];
|
|
$data['$transaction_reference'] = ['value' => $this->payment->transaction_reference, 'label' => ctrans('texts.transaction_reference')];
|
|
$data['$public_notes'] = ['value' => $this->payment->public_notes, 'label' => ctrans('texts.notes')];
|
|
|
|
$data['$payment1'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'payment1', $this->payment->custom_value1, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'payment1')];
|
|
$data['$payment2'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'payment2', $this->payment->custom_value2, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'payment2')];
|
|
$data['$payment3'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'payment3', $this->payment->custom_value3, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'payment3')];
|
|
$data['$payment4'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'payment4', $this->payment->custom_value4, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'payment4')];
|
|
// $data['$type'] = ['value' => $this->payment->type->name ?: '', 'label' => ctrans('texts.payment_type')];
|
|
|
|
$data['$client1'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'client1', $this->client->custom_value1, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'client1')];
|
|
$data['$client2'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'client2', $this->client->custom_value2, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'client2')];
|
|
$data['$client3'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'client3', $this->client->custom_value3, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'client3')];
|
|
$data['$client4'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'client4', $this->client->custom_value4, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'client4')];
|
|
$data['$address1'] = ['value' => $this->client->address1 ?: ' ', 'label' => ctrans('texts.address1')];
|
|
$data['$address2'] = ['value' => $this->client->address2 ?: ' ', 'label' => ctrans('texts.address2')];
|
|
$data['$id_number'] = ['value' => $this->client->id_number ?: ' ', 'label' => ctrans('texts.id_number')];
|
|
$data['$client.number'] = ['value' => $this->client->number ?: ' ', 'label' => ctrans('texts.number')];
|
|
$data['$vat_number'] = ['value' => $this->client->vat_number ?: ' ', 'label' => ctrans('texts.vat_number')];
|
|
$data['$website'] = ['value' => $this->client->present()->website() ?: ' ', 'label' => ctrans('texts.website')];
|
|
$data['$phone'] = ['value' => $this->client->present()->phone() ?: ' ', 'label' => ctrans('texts.phone')];
|
|
$data['$country'] = ['value' => isset($this->client->country->name) ? $this->client->country->name : '', 'label' => ctrans('texts.country')];
|
|
$data['$email'] = ['value' => isset($this->contact) ? $this->contact->email : 'no contact email on record', 'label' => ctrans('texts.email')];
|
|
$data['$client_name'] = ['value' => $this->client->present()->name() ?: ' ', 'label' => ctrans('texts.client_name')];
|
|
$data['$client.name'] = &$data['$client_name'];
|
|
$data['$client'] = &$data['$client_name'];
|
|
$data['$client.address1'] = &$data['$address1'];
|
|
$data['$client.address2'] = &$data['$address2'];
|
|
$data['$client_address'] = ['value' => $this->client->present()->address() ?: ' ', 'label' => ctrans('texts.address')];
|
|
$data['$client.address'] = &$data['$client_address'];
|
|
$data['$client.id_number'] = &$data['$id_number'];
|
|
$data['$client.vat_number'] = &$data['$vat_number'];
|
|
$data['$client.website'] = &$data['$website'];
|
|
$data['$client.phone'] = &$data['$phone'];
|
|
$data['$city_state_postal'] = ['value' => $this->client->present()->cityStateZip($this->client->city, $this->client->state, $this->client->postal_code, false) ?: ' ', 'label' => ctrans('texts.city_state_postal')];
|
|
$data['$client.city_state_postal'] = &$data['$city_state_postal'];
|
|
$data['$postal_city_state'] = ['value' => $this->client->present()->cityStateZip($this->client->city, $this->client->state, $this->client->postal_code, true) ?: ' ', 'label' => ctrans('texts.postal_city_state')];
|
|
$data['$client.postal_city_state'] = &$data['$postal_city_state'];
|
|
$data['$client.country'] = &$data['$country'];
|
|
$data['$client.email'] = &$data['$email'];
|
|
|
|
$data['$client.balance'] = ['value' => Number::formatMoney($this->client->balance, $this->client), 'label' => ctrans('texts.account_balance')];
|
|
$data['$outstanding'] = ['value' => Number::formatMoney($this->client->balance, $this->client), 'label' => ctrans('texts.account_balance')];
|
|
$data['$client_balance'] = ['value' => Number::formatMoney($this->client->balance, $this->client), 'label' => ctrans('texts.account_balance')];
|
|
$data['$paid_to_date'] = ['value' => Number::formatMoney($this->client->paid_to_date, $this->client), 'label' => ctrans('texts.paid_to_date')];
|
|
|
|
$data['$contact.full_name'] = ['value' => isset($this->contact) ? $this->contact->present()->name() : '', 'label' => ctrans('texts.name')];
|
|
$data['$contact.email'] = ['value' => isset($this->contact) ? $this->contact->email : '', 'label' => ctrans('texts.email')];
|
|
$data['$contact.phone'] = ['value' => isset($this->contact) ? $this->contact->phone : '', 'label' => ctrans('texts.phone')];
|
|
|
|
$data['$contact.name'] = ['value' => isset($this->contact) ? $this->contact->present()->name() : 'no contact name on record', 'label' => ctrans('texts.contact_name')];
|
|
$data['$contact.first_name'] = ['value' => isset($this->contact) ? $this->contact->first_name : '', 'label' => ctrans('texts.first_name')];
|
|
$data['$contact.last_name'] = ['value' => isset($this->contact) ? $this->contact->last_name : '', 'label' => ctrans('texts.last_name')];
|
|
$data['$contact.custom1'] = ['value' => isset($this->contact) ? $this->contact->custom_value1 : ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'contact1')];
|
|
$data['$contact.custom2'] = ['value' => isset($this->contact) ? $this->contact->custom_value2 : ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'contact1')];
|
|
$data['$contact.custom3'] = ['value' => isset($this->contact) ? $this->contact->custom_value3 : ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'contact1')];
|
|
$data['$contact.custom4'] = ['value' => isset($this->contact) ? $this->contact->custom_value4 : ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'contact1')];
|
|
$data['$firstName'] = &$data['$contact.first_name'];
|
|
|
|
$data['$company.city_state_postal'] = ['value' => $this->company->present()->cityStateZip($this->settings->city, $this->settings->state, $this->settings->postal_code, false) ?: ' ', 'label' => ctrans('texts.city_state_postal')];
|
|
$data['$company.postal_city_state'] = ['value' => $this->company->present()->cityStateZip($this->settings->city, $this->settings->state, $this->settings->postal_code, true) ?: ' ', 'label' => ctrans('texts.postal_city_state')];
|
|
$data['$company.name'] = ['value' => $this->company->present()->name() ?: ' ', 'label' => ctrans('texts.company_name')];
|
|
$data['$company.address1'] = ['value' => $this->settings->address1 ?: ' ', 'label' => ctrans('texts.address1')];
|
|
$data['$company.address2'] = ['value' => $this->settings->address2 ?: ' ', 'label' => ctrans('texts.address2')];
|
|
$data['$company.city'] = ['value' => $this->settings->city ?: ' ', 'label' => ctrans('texts.city')];
|
|
$data['$company.state'] = ['value' => $this->settings->state ?: ' ', 'label' => ctrans('texts.state')];
|
|
$data['$company.postal_code'] = ['value' => $this->settings->postal_code ?: ' ', 'label' => ctrans('texts.postal_code')];
|
|
//$data['$company.country'] = ['value' => $this->getCountryName(), 'label' => ctrans('texts.country')];
|
|
$data['$company.phone'] = ['value' => $this->settings->phone ?: ' ', 'label' => ctrans('texts.phone')];
|
|
$data['$company.email'] = ['value' => $this->settings->email ?: ' ', 'label' => ctrans('texts.email')];
|
|
$data['$company.vat_number'] = ['value' => $this->settings->vat_number ?: ' ', 'label' => ctrans('texts.vat_number')];
|
|
$data['$company.id_number'] = ['value' => $this->settings->id_number ?: ' ', 'label' => ctrans('texts.id_number')];
|
|
$data['$company.website'] = ['value' => $this->settings->website ?: ' ', 'label' => ctrans('texts.website')];
|
|
$data['$company.address'] = ['value' => $this->company->present()->address($this->settings) ?: ' ', 'label' => ctrans('texts.address')];
|
|
|
|
$logo = $this->company->present()->logo($this->settings);
|
|
|
|
$data['$company.logo'] = ['value' => $logo ?: ' ', 'label' => ctrans('texts.logo')];
|
|
$data['$company_logo'] = &$data['$company.logo'];
|
|
$data['$company1'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'company1', $this->settings->custom_value1, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'company1')];
|
|
$data['$company2'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'company2', $this->settings->custom_value2, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'company2')];
|
|
$data['$company3'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'company3', $this->settings->custom_value3, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'company3')];
|
|
$data['$company4'] = ['value' => $this->helpers->formatCustomFieldValue($this->company->custom_fields, 'company4', $this->settings->custom_value4, $this->client) ?: ' ', 'label' => $this->helpers->makeCustomField($this->company->custom_fields, 'company4')];
|
|
|
|
$data['$view_link'] = ['value' => '<a class="button" href="'.$this->payment->getLink().'">'.ctrans('texts.view_payment').'</a>', 'label' => ctrans('texts.view_payment')];
|
|
$data['$view_button'] = &$data['$view_link'];
|
|
$data['$viewLink'] = &$data['$view_link'];
|
|
$data['$paymentLink'] = &$data['$view_link'];
|
|
$data['$portalButton'] = ['value' => "<a href='{$this->payment->getPortalLink()}'>".ctrans('texts.login').'</a>', 'label' =>''];
|
|
$data['$portal_url'] = &$data['$portalButton'];
|
|
|
|
$data['$view_url'] = ['value' => $this->payment->getLink(), 'label' => ctrans('texts.view_payment')];
|
|
$data['$signature'] = ['value' => $this->settings->email_signature ?: ' ', 'label' => ''];
|
|
$data['$emailSignature'] = &$data['$signature'];
|
|
|
|
$data['$invoices'] = ['value' => $this->formatInvoices(), 'label' => ctrans('texts.invoices')];
|
|
$data['$invoice_references'] = ['value' => $this->formatInvoiceReferences(), 'label' => ctrans('texts.invoices')];
|
|
$data['$invoice'] = ['value' => $this->formatInvoice(), 'label' => ctrans('texts.invoices')];
|
|
$data['$invoice.po_number'] = ['value' => $this->formatPoNumber(), 'label' => ctrans('texts.po_number')];
|
|
$data['$poNumber'] = &$data['$invoice.po_number'];
|
|
$data['$payment.status'] = ['value' => $this->payment->stringStatus($this->payment->status_id), 'label' => ctrans('texts.payment_status')];
|
|
|
|
$arrKeysLength = array_map('strlen', array_keys($data));
|
|
array_multisort($arrKeysLength, SORT_DESC, $data);
|
|
|
|
return $data;
|
|
}
|
|
|
|
private function formatInvoice()
|
|
{
|
|
$invoice = '';
|
|
|
|
if ($this->payment->invoices()->exists()) {
|
|
$invoice = ctrans('texts.invoice_number_short').implode(',', $this->payment->invoices->pluck('number')->toArray());
|
|
}
|
|
|
|
return $invoice;
|
|
}
|
|
|
|
private function formatPoNumber()
|
|
{
|
|
$invoice = '';
|
|
|
|
if ($this->payment->invoices()->exists()) {
|
|
$invoice = ctrans('texts.po_number_short').implode(',', $this->payment->invoices->pluck('po_number')->toArray());
|
|
}
|
|
|
|
return $invoice;
|
|
}
|
|
|
|
private function formatInvoices()
|
|
{
|
|
$invoice_list = '<br><br>';
|
|
|
|
foreach ($this->payment->invoices as $invoice) {
|
|
$invoice_list .= ctrans('texts.invoice_number_short')." {$invoice->number} - ".Number::formatMoney($invoice->pivot->amount, $this->client).'<br>';
|
|
}
|
|
|
|
return $invoice_list;
|
|
}
|
|
|
|
private function formatInvoiceReferences()
|
|
{
|
|
$invoice_list = '<br><br>';
|
|
|
|
foreach ($this->payment->invoices as $invoice) {
|
|
$invoice_list .= ctrans('texts.po_number')." {$invoice->po_number} <br>";
|
|
$invoice_list .= ctrans('texts.invoice_number_short')." {$invoice->number} <br>";
|
|
$invoice_list .= ctrans('texts.invoice_amount').' '.Number::formatMoney($invoice->pivot->amount, $this->client).'<br>';
|
|
$invoice_list .= ctrans('texts.invoice_balance').' '.Number::formatMoney($invoice->fresh()->balance, $this->client).'<br>';
|
|
$invoice_list .= '-----<br>';
|
|
}
|
|
|
|
return $invoice_list;
|
|
}
|
|
|
|
public function makeValues() :array
|
|
{
|
|
$data = [];
|
|
|
|
$values = $this->makePaymentVariables();
|
|
|
|
foreach ($values as $key => $value) {
|
|
$data[$key] = $value['value'];
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|