store/app/Models/PayrollPeriod.php

65 lines
1.6 KiB
PHP

<?php
namespace App\Models;
use App\Enums\PayrollPeriodStatus;
use App\Models\Concerns\InteractsWithActivityLog;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Attributes\Appends;
use Illuminate\Database\Eloquent\Attributes\Guarded;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
#[Guarded(['id'])]
#[Appends(['period_label', 'status_label', 'closed_at_formatted'])]
class PayrollPeriod extends Model
{
use InteractsWithActivityLog;
protected function casts(): array
{
return [
'status' => PayrollPeriodStatus::class,
'closed_at' => 'datetime',
];
}
public function periodLabel(): Attribute
{
return Attribute::make(
get: fn () => Carbon::create($this->year, $this->month, 1)->translatedFormat('F Y'),
);
}
public function statusLabel(): Attribute
{
return Attribute::make(
get: fn () => $this->status?->label(),
);
}
public function closedAtFormatted(): Attribute
{
return Attribute::make(
get: fn () => $this->closed_at?->translatedFormat('l, d F Y H:i'),
);
}
public function payrolls(): HasMany
{
return $this->hasMany(Payroll::class);
}
public function closedBy(): BelongsTo
{
return $this->belongsTo(User::class, 'closed_by_id');
}
public function isOpen(): bool
{
return $this->status === PayrollPeriodStatus::OPEN;
}
}