whisper-money/app/Models/Label.php

80 lines
2.0 KiB
PHP

<?php
namespace App\Models;
use App\Enums\LabelSource;
use App\Models\Concerns\BelongsToSpace;
use Database\Factories\LabelFactory;
use Illuminate\Database\Eloquent\Builder;
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\BelongsToMany;
use Illuminate\Database\Eloquent\SoftDeletes;
class Label extends Model
{
/** @use HasFactory<LabelFactory> */
use BelongsToSpace, HasFactory, HasUuids, SoftDeletes;
protected $fillable = [
'name',
'color',
'source',
'user_id',
'space_id',
];
protected function casts(): array
{
return [
'source' => LabelSource::class,
];
}
/**
* Only labels the user created and manages directly. Excludes labels that
* back a savings goal — those are managed through the goal, not the label
* settings screen.
*
* @param Builder<Label> $query
* @return Builder<Label>
*/
public function scopeUserManaged(Builder $query): Builder
{
return $query->where('source', LabelSource::User);
}
/**
* Hide the pivot from serialization so a Label looks identical whether it
* is loaded standalone or through a belongsToMany relation.
*
* @var list<string>
*/
protected $hidden = [
'pivot',
'space_id',
'source',
];
/** @return BelongsTo<User, $this> */
public function user(): BelongsTo
{
return $this->belongsTo(User::class);
}
public function transactions(): BelongsToMany
{
return $this->belongsToMany(Transaction::class)
->using(LabelTransaction::class)
->withTimestamps();
}
public function automationRules(): BelongsToMany
{
return $this->belongsToMany(AutomationRule::class, 'automation_rule_labels')
->using(AutomationRuleLabel::class);
}
}