mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
ba75a44eb8
* Adopt Laravel coding style The Laravel framework adopts the PSR-2 coding style with some additions. Laravel apps *should* adopt this coding style as well. However, Shift allows you to customize the adopted coding style by adding your own [PHP CS Fixer][1] `.php_cs` config to your project. You may use [Shift's .php_cs][2] file as a base. [1]: https://github.com/FriendsOfPHP/PHP-CS-Fixer [2]: https://gist.github.com/laravel-shift/cab527923ed2a109dda047b97d53c200 * Shift bindings PHP 5.5.9+ adds the new static `class` property which provides the fully qualified class name. This is preferred over using class name strings as these references are checked by the parser. * Shift core files * Shift to Throwable * Add laravel/ui dependency * Unindent vendor mail templates * Shift config files * Default config files In an effort to make upgrading the constantly changing config files easier, Shift defaulted them so you can review the commit diff for changes. Moving forward, you should use ENV variables or create a separate config file to allow the core config files to remain automatically upgradeable. * Shift Laravel dependencies * Shift cleanup * Upgrade to Laravel 7 Co-authored-by: Laravel Shift <shift@laravelshift.com>
496 lines
14 KiB
PHP
496 lines
14 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\Models;
|
|
|
|
use App\Events\Invoice\InvoiceWasMarkedSent;
|
|
use App\Events\Invoice\InvoiceWasPaid;
|
|
use App\Events\Invoice\InvoiceWasUpdated;
|
|
use App\Helpers\Invoice\InvoiceSum;
|
|
use App\Helpers\Invoice\InvoiceSumInclusive;
|
|
use App\Jobs\Client\UpdateClientBalance;
|
|
use App\Jobs\Company\UpdateCompanyLedgerWithInvoice;
|
|
use App\Jobs\Invoice\CreateInvoicePdf;
|
|
use App\Models\Backup;
|
|
use App\Models\CompanyLedger;
|
|
use App\Models\Currency;
|
|
use App\Models\Filterable;
|
|
use App\Models\PaymentTerm;
|
|
use App\Services\Invoice\InvoiceService;
|
|
use App\Services\Ledger\LedgerService;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\Number;
|
|
use App\Utils\Traits\Archivable;
|
|
use App\Utils\Traits\Invoice\ActionsInvoice;
|
|
use App\Utils\Traits\InvoiceEmailBuilder;
|
|
use App\Utils\Traits\MakesDates;
|
|
use App\Utils\Traits\MakesInvoiceValues;
|
|
use App\Utils\Traits\MakesReminders;
|
|
use App\Utils\Traits\NumberFormatter;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Illuminate\Support\Carbon;
|
|
use Illuminate\Support\Facades\File;
|
|
use Illuminate\Support\Facades\Storage;
|
|
use Laracasts\Presenter\PresentableTrait;
|
|
|
|
class Invoice extends BaseModel
|
|
{
|
|
use SoftDeletes;
|
|
use Filterable;
|
|
use NumberFormatter;
|
|
use MakesDates;
|
|
use PresentableTrait;
|
|
use MakesInvoiceValues;
|
|
use InvoiceEmailBuilder;
|
|
use MakesReminders;
|
|
use ActionsInvoice;
|
|
|
|
protected $presenter = \App\Models\Presenters\InvoicePresenter::class;
|
|
|
|
protected $touches = [];
|
|
|
|
protected $hidden = [
|
|
'id',
|
|
'private_notes',
|
|
'user_id',
|
|
'client_id',
|
|
'company_id',
|
|
];
|
|
|
|
protected $fillable = [
|
|
'number',
|
|
'discount',
|
|
'po_number',
|
|
'date',
|
|
'due_date',
|
|
'terms',
|
|
'public_notes',
|
|
'private_notes',
|
|
'invoice_type_id',
|
|
'tax_name1',
|
|
'tax_rate1',
|
|
'tax_name2',
|
|
'tax_rate2',
|
|
'tax_name3',
|
|
'tax_rate3',
|
|
'is_amount_discount',
|
|
'footer',
|
|
'partial',
|
|
'partial_due_date',
|
|
'custom_value1',
|
|
'custom_value2',
|
|
'custom_value3',
|
|
'custom_value4',
|
|
'line_items',
|
|
'client_id',
|
|
'footer',
|
|
'custom_surcharge1',
|
|
'custom_surcharge2',
|
|
'custom_surcharge3',
|
|
'custom_surcharge4',
|
|
'custom_surcharge_tax1',
|
|
'custom_surcharge_tax2',
|
|
'custom_surcharge_tax3',
|
|
'custom_surcharge_tax4',
|
|
'design_id',
|
|
'assigned_user_id',
|
|
'exchange_rate',
|
|
];
|
|
|
|
protected $casts = [
|
|
// 'date' => 'date:Y-m-d',
|
|
// 'due_date' => 'date:Y-m-d',
|
|
// 'partial_due_date' => 'date:Y-m-d',
|
|
'line_items' => 'object',
|
|
'backup' => 'object',
|
|
'updated_at' => 'timestamp',
|
|
'created_at' => 'timestamp',
|
|
'deleted_at' => 'timestamp',
|
|
];
|
|
|
|
protected $with = [];
|
|
|
|
protected $appends = [
|
|
'hashed_id',
|
|
'status',
|
|
];
|
|
|
|
const STATUS_DRAFT = 1;
|
|
const STATUS_SENT = 2;
|
|
const STATUS_PARTIAL = 3;
|
|
const STATUS_PAID = 4;
|
|
const STATUS_CANCELLED = 5;
|
|
const STATUS_REVERSED = 6;
|
|
|
|
const STATUS_OVERDUE = -1; //status < 4 || < 3 && !is_deleted && !trashed() && due_date < now()
|
|
const STATUS_UNPAID = -2; //status < 4 || < 3 && !is_deleted && !trashed()
|
|
|
|
public function getEntityType()
|
|
{
|
|
return self::class;
|
|
}
|
|
|
|
public function getDateAttribute($value)
|
|
{
|
|
return $this->dateMutator($value);
|
|
}
|
|
|
|
public function getDueDateAttribute($value)
|
|
{
|
|
return $this->dateMutator($value);
|
|
}
|
|
|
|
public function getPartialDueDateAttribute($value)
|
|
{
|
|
return $this->dateMutator($value);
|
|
}
|
|
|
|
public function company()
|
|
{
|
|
return $this->belongsTo(Company::class);
|
|
}
|
|
|
|
public function user()
|
|
{
|
|
return $this->belongsTo(User::class)->withTrashed();
|
|
}
|
|
|
|
public function assigned_user()
|
|
{
|
|
return $this->belongsTo(User::class, 'assigned_user_id', 'id')->withTrashed();
|
|
}
|
|
|
|
public function invitations()
|
|
{
|
|
return $this->hasMany(InvoiceInvitation::class);
|
|
}
|
|
|
|
public function client()
|
|
{
|
|
return $this->belongsTo(Client::class)->withTrashed();
|
|
}
|
|
|
|
// public function contacts()
|
|
// {
|
|
// return $this->hasManyThrough(ClientContact::class, Client::class);
|
|
// }
|
|
|
|
public function documents()
|
|
{
|
|
return $this->morphMany(Document::class, 'documentable');
|
|
}
|
|
|
|
public function payments()
|
|
{
|
|
return $this->morphToMany(Payment::class, 'paymentable')->withPivot('amount', 'refunded')->withTimestamps()->withTrashed();
|
|
}
|
|
|
|
public function company_ledger()
|
|
{
|
|
return $this->morphMany(CompanyLedger::class, 'company_ledgerable');
|
|
}
|
|
|
|
public function activities()
|
|
{
|
|
return $this->hasMany(Activity::class);
|
|
}
|
|
|
|
public function history()
|
|
{
|
|
return $this->hasManyThrough(Backup::class, Activity::class);
|
|
}
|
|
|
|
public function credits()
|
|
{
|
|
return $this->hasMany(Credit::class);
|
|
}
|
|
|
|
// public function credits()
|
|
// {
|
|
// return $this->belongsToMany(Credit::class)->using(Paymentable::class)->withPivot(
|
|
// 'amount',
|
|
// 'refunded'
|
|
// )->withTimestamps();
|
|
// }
|
|
|
|
/**
|
|
* Service entry points.
|
|
*/
|
|
public function service() :InvoiceService
|
|
{
|
|
return new InvoiceService($this);
|
|
}
|
|
|
|
public function ledger()
|
|
{
|
|
return new LedgerService($this);
|
|
}
|
|
|
|
/* ---------------- */
|
|
/* Settings getters */
|
|
/* ---------------- */
|
|
|
|
public function getStatusAttribute()
|
|
{
|
|
if ($this->status_id == self::STATUS_SENT && $this->due_date > Carbon::now()) {
|
|
return self::STATUS_UNPAID;
|
|
} elseif ($this->status_id == self::STATUS_PARTIAL && $this->partial_due_date > Carbon::now()) {
|
|
return self::STATUS_UNPAID;
|
|
} elseif ($this->status_id == self::STATUS_SENT && $this->due_date < Carbon::now()) {
|
|
return self::STATUS_OVERDUE;
|
|
} elseif ($this->status_id == self::STATUS_PARTIAL && $this->partial_due_date < Carbon::now()) {
|
|
return self::STATUS_OVERDUE;
|
|
} else {
|
|
return $this->status_id;
|
|
}
|
|
}
|
|
|
|
public function isPayable(): bool
|
|
{
|
|
if ($this->status_id == self::STATUS_DRAFT && $this->is_deleted == false) {
|
|
return true;
|
|
} elseif ($this->status_id == self::STATUS_SENT && $this->is_deleted == false) {
|
|
return true;
|
|
} elseif ($this->status_id == self::STATUS_PARTIAL && $this->is_deleted == false) {
|
|
return true;
|
|
} elseif ($this->status_id == self::STATUS_SENT && $this->is_deleted == false) {
|
|
return true;
|
|
} elseif ($this->status_id == self::STATUS_DRAFT && $this->is_deleted == false) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function isRefundable(): bool
|
|
{
|
|
if ($this->is_deleted) {
|
|
return false;
|
|
}
|
|
|
|
if (($this->amount - $this->balance) == 0) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isPartial(): bool
|
|
{
|
|
return $this->status_id >= self::STATUS_PARTIAL;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function hasPartial(): bool
|
|
{
|
|
return ($this->partial && $this->partial > 0) === true;
|
|
}
|
|
|
|
public static function badgeForStatus(int $status)
|
|
{
|
|
switch ($status) {
|
|
case self::STATUS_DRAFT:
|
|
return '<h5><span class="badge badge-light">'.ctrans('texts.draft').'</span></h5>';
|
|
break;
|
|
case self::STATUS_SENT:
|
|
return '<h5><span class="badge badge-primary">'.ctrans('texts.sent').'</span></h5>';
|
|
break;
|
|
case self::STATUS_PARTIAL:
|
|
return '<h5><span class="badge badge-primary">'.ctrans('texts.partial').'</span></h5>';
|
|
break;
|
|
case self::STATUS_PAID:
|
|
return '<h5><span class="badge badge-success">'.ctrans('texts.paid').'</span></h5>';
|
|
break;
|
|
case self::STATUS_CANCELLED:
|
|
return '<h5><span class="badge badge-secondary">'.ctrans('texts.cancelled').'</span></h5>';
|
|
break;
|
|
case self::STATUS_OVERDUE:
|
|
return '<h5><span class="badge badge-danger">'.ctrans('texts.overdue').'</span></h5>';
|
|
break;
|
|
case self::STATUS_UNPAID:
|
|
return '<h5><span class="badge badge-warning">'.ctrans('texts.unpaid').'</span></h5>';
|
|
break;
|
|
case self::STATUS_REVERSED:
|
|
return '<h5><span class="badge badge-info">'.ctrans('texts.reversed').'</span></h5>';
|
|
break;
|
|
default:
|
|
// code...
|
|
break;
|
|
}
|
|
}
|
|
|
|
public static function stringStatus(int $status)
|
|
{
|
|
switch ($status) {
|
|
case self::STATUS_DRAFT:
|
|
return ctrans('texts.draft');
|
|
break;
|
|
case self::STATUS_SENT:
|
|
return ctrans('texts.sent');
|
|
break;
|
|
case self::STATUS_PARTIAL:
|
|
return ctrans('texts.partial');
|
|
break;
|
|
case self::STATUS_PAID:
|
|
return ctrans('texts.paid');
|
|
break;
|
|
case self::STATUS_CANCELLED:
|
|
return ctrans('texts.cancelled');
|
|
break;
|
|
case self::STATUS_OVERDUE:
|
|
return ctrans('texts.overdue');
|
|
break;
|
|
case self::STATUS_UNPAID:
|
|
return ctrans('texts.unpaid');
|
|
break;
|
|
case self::STATUS_REVERSED:
|
|
return ctrans('texts.reversed');
|
|
break;
|
|
default:
|
|
// code...
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Access the invoice calculator object.
|
|
*
|
|
* @return object The invoice calculator object getters
|
|
*/
|
|
public function calc()
|
|
{
|
|
$invoice_calc = null;
|
|
|
|
if ($this->uses_inclusive_taxes) {
|
|
$invoice_calc = new InvoiceSumInclusive($this);
|
|
} else {
|
|
$invoice_calc = new InvoiceSum($this);
|
|
}
|
|
|
|
return $invoice_calc->build();
|
|
}
|
|
|
|
public function pdf_file_path($invitation = null)
|
|
{
|
|
if (! $invitation) {
|
|
$invitation = $this->invitations->first();
|
|
}
|
|
|
|
$storage_path = Storage::url($this->client->invoice_filepath().$this->number.'.pdf');
|
|
|
|
if (! Storage::exists($this->client->invoice_filepath().$this->number.'.pdf')) {
|
|
event(new InvoiceWasUpdated($this, $this->company, Ninja::eventVars()));
|
|
CreateInvoicePdf::dispatchNow($invitation);
|
|
}
|
|
|
|
return $storage_path;
|
|
}
|
|
|
|
/**
|
|
* Updates Invites to SENT.
|
|
*/
|
|
public function markInvitationsSent()
|
|
{
|
|
$this->invitations->each(function ($invitation) {
|
|
if (! isset($invitation->sent_date)) {
|
|
$invitation->sent_date = Carbon::now();
|
|
$invitation->save();
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Filtering logic to determine
|
|
* whether an invoice is locked
|
|
* based on the current status of the invoice.
|
|
* @return bool [description]
|
|
*/
|
|
public function isLocked() :bool
|
|
{
|
|
$locked_status = $this->client->getSetting('lock_invoices');
|
|
|
|
switch ($locked_status) {
|
|
case 'off':
|
|
return false;
|
|
break;
|
|
case 'when_sent':
|
|
return $this->status_id == self::STATUS_DRAFT;
|
|
break;
|
|
case 'when_paid':
|
|
return $this->status_id == self::STATUS_PAID || $this->status_id == self::STATUS_PARTIAL;
|
|
break;
|
|
default:
|
|
return false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* Graveyard */
|
|
|
|
// /**
|
|
// * Determines if invoice overdue.
|
|
// *
|
|
// * @param float $balance The balance
|
|
// * @param date. $due_date The due date
|
|
// *
|
|
// * @return boolean True if overdue, False otherwise.
|
|
// */
|
|
// public static function isOverdue($balance, $due_date)
|
|
// {
|
|
// if (! $this->formatValue($balance,2) > 0 || ! $due_date) {
|
|
// return false;
|
|
// }
|
|
//
|
|
// // it isn't considered overdue until the end of the day
|
|
// return strtotime($this->createClientDate(date(), $this->client->timezone()->name)) > (strtotime($due_date) + (60 * 60 * 24));
|
|
// }
|
|
|
|
/**
|
|
* @param bool $save
|
|
*
|
|
* Has this been dragged from V1?
|
|
*/
|
|
// public function updatePaidStatus($paid = false, $save = true) : bool
|
|
// {
|
|
// $status_id = false;
|
|
// if ($paid && $this->balance == 0) {
|
|
// $status_id = self::STATUS_PAID;
|
|
// } elseif ($paid && $this->balance > 0 && $this->balance < $this->amount) {
|
|
// $status_id = self::STATUS_PARTIAL;
|
|
// } elseif ($this->hasPartial() && $this->balance > 0) {
|
|
// $status_id = ($this->balance == $this->amount ? self::STATUS_SENT : self::STATUS_PARTIAL);
|
|
// }
|
|
|
|
// if ($status_id && $status_id != $this->status_id) {
|
|
// $this->status_id = $status_id;
|
|
// if ($save) {
|
|
// $this->save();
|
|
// }
|
|
// }
|
|
// }
|
|
|
|
public function getBalanceDueAttribute()
|
|
{
|
|
return $this->balance;
|
|
}
|
|
|
|
public function getTotalAttribute()
|
|
{
|
|
return $this->calc()->getTotal();
|
|
}
|
|
}
|