65 lines
1.7 KiB
PHP
65 lines
1.7 KiB
PHP
<?php
|
|
|
|
namespace App\Models;
|
|
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Concerns\HasUuids;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
|
|
/**
|
|
* @property Carbon $start_date
|
|
* @property Carbon $end_date
|
|
*/
|
|
class BudgetPeriod extends Model
|
|
{
|
|
use HasFactory, HasUuids;
|
|
|
|
protected $fillable = [
|
|
'budget_id',
|
|
'start_date',
|
|
'end_date',
|
|
'allocated_amount',
|
|
'carried_over_amount',
|
|
'processing_historical',
|
|
'close_to_limit_notified',
|
|
'over_limit_notified',
|
|
];
|
|
|
|
protected function casts(): array
|
|
{
|
|
return [
|
|
'start_date' => 'date',
|
|
'end_date' => 'date',
|
|
'allocated_amount' => 'integer',
|
|
'carried_over_amount' => 'integer',
|
|
'processing_historical' => 'boolean',
|
|
'close_to_limit_notified' => 'boolean',
|
|
'over_limit_notified' => 'boolean',
|
|
];
|
|
}
|
|
|
|
/** @return BelongsTo<Budget, $this> */
|
|
public function budget(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Budget::class);
|
|
}
|
|
|
|
/**
|
|
* Total spent in this period, in cents. BudgetTransaction amounts are
|
|
* stored positive for expenses, so summing them gives the amount spent.
|
|
*/
|
|
public function spentAmount(): int
|
|
{
|
|
return (int) $this->budgetTransactions()->sum('amount');
|
|
}
|
|
|
|
/** @return HasMany<BudgetTransaction, $this> */
|
|
public function budgetTransactions(): HasMany
|
|
{
|
|
return $this->hasMany(BudgetTransaction::class);
|
|
}
|
|
}
|