1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-21 08:51:34 +02:00
invoiceninja/app/Utils/Traits/MakesReminders.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

214 lines
6.9 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 Illuminate\Support\Carbon;
/**
* Class MakesReminders.
*/
trait MakesReminders
{
public function setReminder($settings = null)
{
if (!$settings) {
$settings = $this->client->getMergedSettings();
}
if (!$this->isPayable()) {
$this->next_send_date = null;
$this->save();
return; //exit early
}
$nsd = null; //abbreviation for next_send_date
if ($settings->enable_reminder1 !== false &&
$settings->schedule_reminder1 == 'after_invoice_date' &&
$settings->num_days_reminder1 > 0) {
$reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder1);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder1 !== false &&
$settings->schedule_reminder1 == 'before_due_date' &&
$settings->num_days_reminder1 > 0) {
$reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder1);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder1 !== false &&
$settings->schedule_reminder1 == 'after_due_date' &&
$settings->num_days_reminder1 > 0) {
$reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder1);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder2 !== false &&
$settings->schedule_reminder2 == 'after_invoice_date' &&
$settings->num_days_reminder2 > 0) {
$reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder2);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder2 !== false &&
$settings->schedule_reminder2 == 'before_due_date' &&
$settings->num_days_reminder2 > 0) {
$reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder2);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder2 !== false &&
$settings->schedule_reminder2 == 'after_due_date' &&
$settings->num_days_reminder2 > 0) {
$reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder2);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder3 !== false &&
$settings->schedule_reminder3 == 'after_invoice_date' &&
$settings->num_days_reminder3 > 0) {
$reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder3);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder3 !== false &&
$settings->schedule_reminder3 == 'before_due_date' &&
$settings->num_days_reminder3 > 0) {
$reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder3);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
if ($settings->enable_reminder3 !== false &&
$settings->schedule_reminder3 == 'after_due_date' &&
$settings->num_days_reminder3 > 0) {
$reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder3);
if (!$nsd) {
$nsd = $reminder_date->format('Y-m-d');
}
if ($reminder_date->lt($nsd)) {
$nsd = $reminder_date->format('Y-m-d');
}
}
$this->next_send_date = $nsd;
$this->save();
}
public 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:
return null;
break;
}
}
public 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 ($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
}
}