whisper-money/app/Models/AutomationRule.php

99 lines
2.9 KiB
PHP

<?php
namespace App\Models;
use App\Enums\RuleOrigin;
use App\Models\Concerns\BelongsToSpace;
use Database\Factories\AutomationRuleFactory;
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;
/**
* Rules written before the store request stopped double-encoding the payload
* came back out of the array cast as the JSON string it wrapped, so readers
* have to cope with both shapes — see AutomationRuleService::normalizeRuleJson.
*
* @property array<string, mixed>|string $rules_json
* @property RuleOrigin $origin
*/
class AutomationRule extends Model
{
/** @use HasFactory<AutomationRuleFactory> */
use BelongsToSpace, HasFactory, HasUuids, SoftDeletes;
public const MAX_TITLE_LENGTH = 255;
protected $fillable = [
'user_id',
'space_id',
'title',
'priority',
'origin',
'rules_json',
'action_category_id',
'action_note',
'action_note_iv',
];
/** @var list<string> */
protected $hidden = [
'space_id',
];
protected function casts(): array
{
return [
'rules_json' => 'array',
'priority' => 'integer',
'origin' => RuleOrigin::class,
];
}
/**
* Generated titles are assembled from bank-supplied merchant names and AI
* tokens, neither of which the column bounds. Truncating here is the one
* place that covers every generator, so an oversized title can never abort
* the action that produced it. User-authored titles never reach this: the
* form request rejects anything over the same limit with a 422.
*/
public function setTitleAttribute(?string $value): void
{
$this->attributes['title'] = $value === null
? null
: mb_substr($value, 0, self::MAX_TITLE_LENGTH);
}
/**
* @param Builder<AutomationRule> $query
* @return Builder<AutomationRule>
*/
public function scopeOrigin(Builder $query, RuleOrigin $origin): Builder
{
return $query->where('origin', $origin);
}
/** @return BelongsTo<User, $this> */
public function user(): BelongsTo
{
return $this->belongsTo(User::class);
}
/** @return BelongsTo<Category, $this> */
public function category(): BelongsTo
{
return $this->belongsTo(Category::class, 'action_category_id');
}
/** @return BelongsToMany<Label, $this, AutomationRuleLabel, 'pivot'> */
public function labels(): BelongsToMany
{
return $this->belongsToMany(Label::class, 'automation_rule_labels')
->using(AutomationRuleLabel::class);
}
}