Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Working on reminders

Browse Source
This commit is contained in:
David Bomba 2020-11-05 13:59:19 +11:00
parent 8e2cea7129
commit cd08367ce6
2 changed files with 97 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
app/Jobs/Ninja/SendReminders.php
View File

@ -18,6 +18,7 @@ use App\Libraries\MultiDB;
use App\Models\Invoice;
use App\Utils\Ninja;
use App\Utils\Traits\MakesDates;
use App\Utils\Traits\MakesReminders;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
@ -27,7 +28,7 @@ use Illuminate\Support\Carbon;
class SendReminders implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, MakesDates;
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, MakesDates, MakesReminders;
/**
* Create a new job instance.
@ -115,34 +116,73 @@ class SendReminders implements ShouldQueue
}
}
/**
* Create a collection of all possible reminder dates
* and pass back the first one in chronology
*
* @param Invoice $invoice
* @return Carbon $date
*/
private function calculateNextSendDate($invoice)
{
$dates = collect();
$settings = $invoice->client->getMergedSettings();
if((int)$settings->schedule_reminder1 > 0)
$dates->push($this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder1, (int)$settings->num_days_reminder1));
$set_reminder1 = false;
$set_reminder2 = false;
$set_reminder3 = false;
if((int)$settings->num_days_reminder2 > 0)
$dates->push($this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder2, (int)$settings->num_days_reminder2));
if((int)$settings->schedule_reminder1 > 0){
if((int)$settings->num_days_reminder3 > 0)
$dates->push($this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder3, (int)$settings->num_days_reminder3));
$next_reminder_date = $this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder1, (int)$settings->num_days_reminder1);
if((int)$settings->endless_reminder_frequency_id > 0)
$dates->push();
if($next_reminder_date->gt(Carbon::parse($invoice->last_sent_date)));
$dates->push($next_reminder_date);
//calculate every potential date, then pluck the next one
if(!$invoice->reminder1_sent)
$set_reminder1 = true;
}
//reminder1,2,3, and endless could potentially be the NEXT_SEND_DATE
//
//we check num_days to determine if the setting is ACTIVE
if((int)$settings->num_days_reminder2 > 0){
$next_reminder_date = $this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder2, (int)$settings->num_days_reminder2);
if($next_reminder_date->gt(Carbon::parse($invoice->last_sent_date)));
$dates->push($next_reminder_date);
if(!$invoice->reminder2_sent)
$set_reminder3 = true;
}
if((int)$settings->num_days_reminder3 > 0){
$next_reminder_date = $this->calculateScheduledDate($invoice, (int)$settings->schedule_reminder3, (int)$settings->num_days_reminder3);
if($next_reminder_date->gt(Carbon::parse($invoice->last_sent_date)));
$dates->push($next_reminder_date);
if(!$invoice->reminder3_sent)
$set_reminder3 = true;
}
//If all the available reminders have fired, we then start to fire the endless reminders
if((int)$settings->endless_reminder_frequency_id > 0 && !$set_reminder1 && !$set_reminder2 && !$set_reminder3) {
$dates->push($this->addTimeInterval($invoice->last_sent_date, (int)$settings->endless_reminder_frequency_id));
}
//order the dates ascending and get first one
return $dates->sort()->first();
}
private function calculateScheduledDate($invoice, $schedule_reminder, $num_days_reminder)
/**
* Helper method which switches values based on the $schedule_reminder
* @param Invoice $invoice
* @param string $schedule_reminder
* @param int $num_days_reminder
* @return Carbon $date
*/
private function calculateScheduledDate($invoice, $schedule_reminder, $num_days_reminder) :?Carbon
{
switch ($schedule_reminder) {
case 'after_invoice_date':
@ -160,8 +200,14 @@ class SendReminders implements ShouldQueue
}
}
private function sendReminder($invoice, $template)
/**
* Sends the reminder and/or late fee for the invoice.
*
* @param Invoice $invoice
* @param string $template
* @return void
*/
private function sendReminder($invoice, $template) :void
{
$invoice = $this->calcLateFee($invoice, $template);
@ -183,11 +229,17 @@ class SendReminders implements ShouldQueue
if(in_array($template, ['reminder1', 'reminder2', 'reminder3']))
$invoice->{$template."_send"} = now();
//calculate next_send_date
$invoice->save();
}
/**
* Calculates the late if - if any - and rebuilds the invoice
*
* @param Invoice $invoice
* @param string $template
* @return Invoice
*/
private function calcLateFee($invoice, $template) :Invoice
{
$late_fee_amount = 0;
@ -220,12 +272,18 @@ class SendReminders implements ShouldQueue
}
/**
* Applies the late fee to the invoice line items
*
* @param Invoice $invoice
* @param float $amount The fee amount
* @param float $percent The fee percentage amount
* @return Invoice
*/
private function setLateFee($invoice, $amount, $percent) :Invoice
{
if ($amount <= 0 && $percent <= 0) {
if ($amount <= 0 && $percent <= 0)
return $invoice;
}
$fee = $amount;
@ -249,6 +307,7 @@ class SendReminders implements ShouldQueue
/**Refresh Invoice values*/
$invoice = $invoice->calc()->getInvoice();
//@todo update the ledger!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
return $invoice;
}

30
app/Utils/Traits/MakesReminders.php
View File

@ -220,41 +220,41 @@ trait MakesReminders
private function checkEndlessReminder($last_sent_date, $endless_reminder_frequency_id) :bool
{
if(Carbon::now()->startOfDay()->eq($this->addTimeInterval($endless_reminder_frequency_id)))
if(Carbon::now()->startOfDay()->eq($this->addTimeInterval($last_sent_date, $endless_reminder_frequency_id)))
return true;
return false;
}
private function addTimeInterval($endless_reminder_frequency_id) :?Carbon
private function addTimeInterval($date, $endless_reminder_frequency_id) :?Carbon
{
if(!$this->next_send_date){
if(!$date)
return null;
}
switch ($endless_reminder_frequency_id) {
case RecurringInvoice::FREQUENCY_WEEKLY:
return Carbon::parse($this->last_sent_date)->addWeek()->startOfDay();
return Carbon::parse($date)->addWeek()->startOfDay();
case RecurringInvoice::FREQUENCY_TWO_WEEKS:
return Carbon::parse($this->last_sent_date)->addWeeks(2)->startOfDay();
return Carbon::parse($date)->addWeeks(2)->startOfDay();
case RecurringInvoice::FREQUENCY_FOUR_WEEKS:
return Carbon::parse($this->last_sent_date)->addWeeks(4)->startOfDay();
return Carbon::parse($date)->addWeeks(4)->startOfDay();
case RecurringInvoice::FREQUENCY_MONTHLY:
return Carbon::parse($this->last_sent_date)->addMonthNoOverflow()->startOfDay();
return Carbon::parse($date)->addMonthNoOverflow()->startOfDay();
case RecurringInvoice::FREQUENCY_TWO_MONTHS:
return Carbon::parse($this->last_sent_date)->addMonthsNoOverflow(2)->startOfDay();
return Carbon::parse($date)->addMonthsNoOverflow(2)->startOfDay();
case RecurringInvoice::FREQUENCY_THREE_MONTHS:
return Carbon::parse($this->last_sent_date)->addMonthsNoOverflow(3)->startOfDay();
return Carbon::parse($date)->addMonthsNoOverflow(3)->startOfDay();
case RecurringInvoice::FREQUENCY_FOUR_MONTHS:
return Carbon::parse($this->last_sent_date)->addMonthsNoOverflow(4)->startOfDay();
return Carbon::parse($date)->addMonthsNoOverflow(4)->startOfDay();
case RecurringInvoice::FREQUENCY_SIX_MONTHS:
return Carbon::parse($this->last_sent_date)->addMonthsNoOverflow(6)->startOfDay();
return Carbon::parse($date)->addMonthsNoOverflow(6)->startOfDay();
case RecurringInvoice::FREQUENCY_ANNUALLY:
return Carbon::parse($this->last_sent_date)->addYear()->startOfDay();
return Carbon::parse($date)->addYear()->startOfDay();
case RecurringInvoice::FREQUENCY_TWO_YEARS:
return Carbon::parse($this->last_sent_date)->addYears(2)->startOfDay();
return Carbon::parse($date)->addYears(2)->startOfDay();
case RecurringInvoice::FREQUENCY_THREE_YEARS:
return Carbon::parse($this->last_sent_date)->addYears(3)->startOfDay();
return Carbon::parse($date)->addYears(3)->startOfDay();
default:
return null;
}