mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-08 20:22:42 +01:00
293 lines
6.3 KiB
PHP
293 lines
6.3 KiB
PHP
<?php namespace App\Models;
|
|
|
|
use Utils;
|
|
use Laracasts\Presenter\PresentableTrait;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use App\Events\ExpenseWasCreated;
|
|
use App\Events\ExpenseWasUpdated;
|
|
use App\Events\ExpenseWasDeleted;
|
|
|
|
/**
|
|
* Class Expense
|
|
*/
|
|
class Expense extends EntityModel
|
|
{
|
|
// Expenses
|
|
use SoftDeletes;
|
|
use PresentableTrait;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $dates = ['deleted_at'];
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $presenter = 'App\Ninja\Presenters\ExpensePresenter';
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $fillable = [
|
|
'client_id',
|
|
'vendor_id',
|
|
'expense_currency_id',
|
|
'expense_date',
|
|
'invoice_currency_id',
|
|
'amount',
|
|
'foreign_amount',
|
|
'exchange_rate',
|
|
'private_notes',
|
|
'public_notes',
|
|
'bank_id',
|
|
'transaction_id',
|
|
'expense_category_id',
|
|
'tax_rate1',
|
|
'tax_name1',
|
|
'tax_rate2',
|
|
'tax_name2',
|
|
];
|
|
|
|
public static function getImportColumns()
|
|
{
|
|
return [
|
|
'client',
|
|
'vendor',
|
|
'amount',
|
|
'public_notes',
|
|
'expense_category',
|
|
'expense_date',
|
|
];
|
|
}
|
|
|
|
public static function getImportMap()
|
|
{
|
|
return [
|
|
'amount|total' => 'amount',
|
|
'category' => 'expense_category',
|
|
'client' => 'client',
|
|
'vendor' => 'vendor',
|
|
'notes|details' => 'public_notes',
|
|
'date' => 'expense_date',
|
|
];
|
|
}
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function expense_category()
|
|
{
|
|
return $this->belongsTo('App\Models\ExpenseCategory')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function account()
|
|
{
|
|
return $this->belongsTo('App\Models\Account');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function user()
|
|
{
|
|
return $this->belongsTo('App\Models\User')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function vendor()
|
|
{
|
|
return $this->belongsTo('App\Models\Vendor')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function client()
|
|
{
|
|
return $this->belongsTo('App\Models\Client')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function invoice()
|
|
{
|
|
return $this->belongsTo('App\Models\Invoice')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function documents()
|
|
{
|
|
return $this->hasMany('App\Models\Document')->orderBy('id');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getName()
|
|
{
|
|
if ($this->transaction_id) {
|
|
return $this->transaction_id;
|
|
} elseif ($this->public_notes) {
|
|
return mb_strimwidth($this->public_notes, 0, 16, "...");
|
|
} else {
|
|
return '#' . $this->public_id;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getDisplayName()
|
|
{
|
|
return $this->getName();
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getRoute()
|
|
{
|
|
return "/expenses/{$this->public_id}";
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getEntityType()
|
|
{
|
|
return ENTITY_EXPENSE;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isExchanged()
|
|
{
|
|
return $this->invoice_currency_id != $this->expense_currency_id || $this->exchange_rate != 1;
|
|
}
|
|
|
|
/**
|
|
* @return float
|
|
*/
|
|
public function convertedAmount()
|
|
{
|
|
return round($this->amount * $this->exchange_rate, 2);
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function toArray()
|
|
{
|
|
$array = parent::toArray();
|
|
|
|
if (empty($this->visible) || in_array('converted_amount', $this->visible)) {
|
|
$array['converted_amount'] = $this->convertedAmount();
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* @param $query
|
|
* @param null $bankdId
|
|
* @return mixed
|
|
*/
|
|
public function scopeBankId($query, $bankdId = null)
|
|
{
|
|
if ($bankdId) {
|
|
$query->whereBankId($bankId);
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
public function amountWithTax()
|
|
{
|
|
return Utils::calculateTaxes($this->amount, $this->tax_rate1, $this->tax_rate2);
|
|
}
|
|
|
|
public static function getStatuses($entityType = false)
|
|
{
|
|
$statuses = [];
|
|
$statuses[EXPENSE_STATUS_LOGGED] = trans('texts.logged');
|
|
$statuses[EXPENSE_STATUS_INVOICED] = trans('texts.invoiced');
|
|
$statuses[EXPENSE_STATUS_PAID] = trans('texts.paid');
|
|
|
|
return $statuses;
|
|
}
|
|
|
|
public static function calcStatusLabel($shouldBeInvoiced, $invoiceId, $balance)
|
|
{
|
|
if ($invoiceId) {
|
|
if (floatval($balance) > 0) {
|
|
$label = 'invoiced';
|
|
} else {
|
|
$label = 'paid';
|
|
}
|
|
} elseif ($shouldBeInvoiced) {
|
|
$label = 'pending';
|
|
} else {
|
|
$label = 'logged';
|
|
}
|
|
|
|
return trans("texts.{$label}");
|
|
}
|
|
|
|
public static function calcStatusClass($shouldBeInvoiced, $invoiceId, $balance)
|
|
{
|
|
if ($invoiceId) {
|
|
if (floatval($balance) > 0) {
|
|
return 'default';
|
|
} else {
|
|
return 'success';
|
|
}
|
|
} elseif ($shouldBeInvoiced) {
|
|
return 'warning';
|
|
} else {
|
|
return 'primary';
|
|
}
|
|
}
|
|
|
|
public function statusClass()
|
|
{
|
|
$balance = $this->invoice ? $this->invoice->balance : 0;
|
|
|
|
return static::calcStatusClass($this->should_be_invoiced, $this->invoice_id, $balance);
|
|
}
|
|
|
|
public function statusLabel()
|
|
{
|
|
$balance = $this->invoice ? $this->invoice->balance : 0;
|
|
|
|
return static::calcStatusLabel($this->should_be_invoiced, $this->invoice_id, $balance);
|
|
}
|
|
}
|
|
|
|
Expense::creating(function ($expense) {
|
|
$expense->setNullValues();
|
|
});
|
|
|
|
Expense::created(function ($expense) {
|
|
event(new ExpenseWasCreated($expense));
|
|
});
|
|
|
|
Expense::updating(function ($expense) {
|
|
$expense->setNullValues();
|
|
});
|
|
|
|
Expense::updated(function ($expense) {
|
|
event(new ExpenseWasUpdated($expense));
|
|
});
|
|
|
|
Expense::deleting(function ($expense) {
|
|
$expense->setNullValues();
|
|
});
|