mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
359 lines
8.8 KiB
PHP
359 lines
8.8 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\Models;
|
|
|
|
use App\Events\Credit\CreditWasUpdated;
|
|
use App\Helpers\Invoice\InvoiceSum;
|
|
use App\Helpers\Invoice\InvoiceSumInclusive;
|
|
use App\Jobs\Entity\CreateEntityPdf;
|
|
use App\Models\Presenters\CreditPresenter;
|
|
use App\Services\Credit\CreditService;
|
|
use App\Services\Ledger\LedgerService;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\Traits\MakesDates;
|
|
use App\Utils\Traits\MakesHash;
|
|
use App\Utils\Traits\MakesInvoiceValues;
|
|
use App\Utils\Traits\MakesReminders;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Illuminate\Support\Carbon;
|
|
use Illuminate\Support\Facades\Storage;
|
|
use Laracasts\Presenter\PresentableTrait;
|
|
|
|
class Credit extends BaseModel
|
|
{
|
|
use MakesHash;
|
|
use Filterable;
|
|
use MakesDates;
|
|
use SoftDeletes;
|
|
use PresentableTrait;
|
|
use MakesInvoiceValues;
|
|
use MakesReminders;
|
|
|
|
protected $presenter = CreditPresenter::class;
|
|
|
|
protected $fillable = [
|
|
'number',
|
|
'discount',
|
|
'po_number',
|
|
'date',
|
|
'due_date',
|
|
'terms',
|
|
'public_notes',
|
|
'private_notes',
|
|
'tax_name1',
|
|
'tax_rate1',
|
|
'tax_name2',
|
|
'tax_rate2',
|
|
'tax_name3',
|
|
'tax_rate3',
|
|
'is_amount_discount',
|
|
'partial',
|
|
'partial_due_date',
|
|
'project_id',
|
|
'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',
|
|
'subscription_id',
|
|
'vendor_id',
|
|
];
|
|
|
|
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',
|
|
'is_amount_discount' => 'bool',
|
|
|
|
];
|
|
|
|
protected $touches = [];
|
|
|
|
const STATUS_DRAFT = 1;
|
|
|
|
const STATUS_SENT = 2;
|
|
|
|
const STATUS_PARTIAL = 3;
|
|
|
|
const STATUS_APPLIED = 4;
|
|
|
|
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 assigned_user()
|
|
{
|
|
return $this->belongsTo(User::class, 'assigned_user_id', 'id')->withTrashed();
|
|
}
|
|
|
|
public function vendor()
|
|
{
|
|
return $this->belongsTo(Vendor::class);
|
|
}
|
|
|
|
public function history()
|
|
{
|
|
return $this->hasManyThrough(Backup::class, Activity::class);
|
|
}
|
|
|
|
public function activities()
|
|
{
|
|
return $this->hasMany(Activity::class)->orderBy('id', 'DESC')->take(50);
|
|
}
|
|
|
|
public function company()
|
|
{
|
|
return $this->belongsTo(Company::class);
|
|
}
|
|
|
|
public function user()
|
|
{
|
|
return $this->belongsTo(User::class)->withTrashed();
|
|
}
|
|
|
|
public function client()
|
|
{
|
|
return $this->belongsTo(Client::class)->withTrashed();
|
|
}
|
|
|
|
// public function contacts()
|
|
// {
|
|
// return $this->hasManyThrough(ClientContact::class, Client::class);
|
|
// }
|
|
|
|
public function invitations()
|
|
{
|
|
return $this->hasMany(CreditInvitation::class);
|
|
}
|
|
|
|
public function project()
|
|
{
|
|
return $this->belongsTo(Project::class)->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* The invoice which the credit has been created from.
|
|
*/
|
|
public function invoice()
|
|
{
|
|
return $this->belongsTo(Invoice::class);
|
|
}
|
|
|
|
public function company_ledger()
|
|
{
|
|
return $this->morphMany(CompanyLedger::class, 'company_ledgerable');
|
|
}
|
|
|
|
public function ledger()
|
|
{
|
|
return new LedgerService($this);
|
|
}
|
|
|
|
/**
|
|
* The invoice/s which the credit has
|
|
* been applied to.
|
|
*/
|
|
public function invoices()
|
|
{
|
|
return $this->belongsToMany(Invoice::class)->using(Paymentable::class);
|
|
}
|
|
|
|
public function payments()
|
|
{
|
|
return $this->morphToMany(Payment::class, 'paymentable');
|
|
}
|
|
|
|
public function documents()
|
|
{
|
|
return $this->morphMany(Document::class, 'documentable');
|
|
}
|
|
|
|
/**
|
|
* Access the invoice calculator object.
|
|
*
|
|
* @return stdClass The invoice calculator object getters
|
|
*/
|
|
public function calc()
|
|
{
|
|
$credit_calc = null;
|
|
|
|
if ($this->uses_inclusive_taxes) {
|
|
$credit_calc = new InvoiceSumInclusive($this);
|
|
} else {
|
|
$credit_calc = new InvoiceSum($this);
|
|
}
|
|
|
|
return $credit_calc->build();
|
|
}
|
|
|
|
public function service()
|
|
{
|
|
return new CreditService($this);
|
|
}
|
|
|
|
/**
|
|
* @param float $balance_adjustment
|
|
*/
|
|
public function updateBalance($balance_adjustment)
|
|
{
|
|
if ($this->is_deleted) {
|
|
return;
|
|
}
|
|
|
|
$balance_adjustment = floatval($balance_adjustment);
|
|
|
|
$this->balance = $this->balance + $balance_adjustment;
|
|
|
|
if ($this->balance == 0) {
|
|
$this->status_id = self::STATUS_APPLIED;
|
|
$this->save();
|
|
|
|
return;
|
|
}
|
|
|
|
$this->save();
|
|
}
|
|
|
|
public function setStatus($status)
|
|
{
|
|
$this->status_id = $status;
|
|
$this->save();
|
|
}
|
|
|
|
public function pdf_file_path($invitation = null, string $type = 'path', bool $portal = false)
|
|
{
|
|
if (! $invitation) {
|
|
if ($this->invitations()->exists()) {
|
|
$invitation = $this->invitations()->first();
|
|
} else {
|
|
$this->service()->createInvitations();
|
|
$invitation = $this->invitations()->first();
|
|
}
|
|
}
|
|
|
|
if (! $invitation) {
|
|
throw new \Exception('Hard fail, could not create an invitation - is there a valid contact?');
|
|
}
|
|
|
|
$file_path = $this->client->credit_filepath($invitation).$this->numberFormatter().'.pdf';
|
|
|
|
if (Ninja::isHosted() && $portal && Storage::disk(config('filesystems.default'))->exists($file_path)) {
|
|
return Storage::disk(config('filesystems.default'))->{$type}($file_path);
|
|
} elseif (Ninja::isHosted() && $portal) {
|
|
$file_path = (new CreateEntityPdf($invitation, config('filesystems.default')))->handle();
|
|
|
|
return Storage::disk(config('filesystems.default'))->{$type}($file_path);
|
|
}
|
|
|
|
try {
|
|
$file_exists = Storage::disk(config('filesystems.default'))->exists($file_path);
|
|
} catch (\Exception $e) {
|
|
nlog($e->getMessage());
|
|
}
|
|
|
|
if ($file_exists) {
|
|
return Storage::disk(config('filesystems.default'))->{$type}($file_path);
|
|
}
|
|
|
|
|
|
if (Storage::disk('public')->exists($file_path)) {
|
|
return Storage::disk('public')->{$type}($file_path);
|
|
}
|
|
|
|
$file_path = (new CreateEntityPdf($invitation))->handle();
|
|
|
|
return Storage::disk('public')->{$type}($file_path);
|
|
}
|
|
|
|
public function markInvitationsSent()
|
|
{
|
|
$this->invitations->each(function ($invitation) {
|
|
if (! isset($invitation->sent_date)) {
|
|
$invitation->sent_date = Carbon::now();
|
|
$invitation->save();
|
|
}
|
|
});
|
|
}
|
|
|
|
public function transaction_event()
|
|
{
|
|
$credit = $this->fresh();
|
|
|
|
return [
|
|
'credit_id' => $credit->id,
|
|
'credit_amount' => $credit->amount ?: 0,
|
|
'credit_balance' => $credit->balance ?: 0,
|
|
'credit_status' => $credit->status_id ?: 1,
|
|
];
|
|
}
|
|
|
|
public function translate_entity()
|
|
{
|
|
return ctrans('texts.credit');
|
|
}
|
|
|
|
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_APPLIED:
|
|
return ctrans('texts.applied');
|
|
break;
|
|
default:
|
|
return '';
|
|
break;
|
|
}
|
|
}
|
|
}
|