145 lines
4.3 KiB
PHP
145 lines
4.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Models\FormBuilder;
|
|
|
|
use App\Enums\FormBuilder\FormFieldDisplayWidth;
|
|
use App\Enums\FormBuilder\FormValueStorageHint;
|
|
use App\Models\Scopes\OrganisationScope;
|
|
use Illuminate\Database\Eloquent\Concerns\HasUlids;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\Relations\MorphMany;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
|
|
/**
|
|
* Activity log strategy: explicit calls via logFieldChange() — no LogsActivity
|
|
* trait. Logged events: create/delete/restore, field_type change, binding
|
|
* change, is_pii/is_filterable toggle, structural options change.
|
|
* See ARCH-FORM-BUILDER.md §17.1 and S1 Phase 4b.
|
|
*
|
|
* field_type is stored as string (not DB enum) so CustomFieldTypeRegistry
|
|
* (ARCH §17.2) can extend it at runtime.
|
|
*/
|
|
final class FormField extends Model
|
|
{
|
|
use HasFactory;
|
|
use HasUlids;
|
|
use SoftDeletes;
|
|
|
|
protected static function booted(): void
|
|
{
|
|
static::addGlobalScope(new OrganisationScope());
|
|
}
|
|
|
|
/** @return array{via: class-string, fk: string} */
|
|
public static function tenantScopeStrategy(): array
|
|
{
|
|
return ['via' => FormSchema::class, 'fk' => 'form_schema_id'];
|
|
}
|
|
|
|
protected $fillable = [
|
|
'form_schema_id',
|
|
'form_schema_section_id',
|
|
'library_field_id',
|
|
'field_type',
|
|
'slug',
|
|
'label',
|
|
'help_text',
|
|
'section',
|
|
'options',
|
|
'is_required',
|
|
'is_filterable',
|
|
'is_portal_visible',
|
|
'is_admin_only',
|
|
'is_unique',
|
|
'is_pii',
|
|
'display_width',
|
|
'conditional_logic',
|
|
'role_restrictions',
|
|
'translations',
|
|
'value_storage_hint',
|
|
'review_required',
|
|
'sort_order',
|
|
];
|
|
|
|
/** @var array<string, string> */
|
|
protected $casts = [
|
|
'options' => 'array',
|
|
'conditional_logic' => 'array',
|
|
'role_restrictions' => 'array',
|
|
'translations' => 'array',
|
|
'is_required' => 'bool',
|
|
'is_filterable' => 'bool',
|
|
'is_portal_visible' => 'bool',
|
|
'is_admin_only' => 'bool',
|
|
'is_unique' => 'bool',
|
|
'is_pii' => 'bool',
|
|
'review_required' => 'bool',
|
|
'display_width' => FormFieldDisplayWidth::class,
|
|
'value_storage_hint' => FormValueStorageHint::class,
|
|
'sort_order' => 'int',
|
|
];
|
|
|
|
public function schema(): BelongsTo
|
|
{
|
|
return $this->belongsTo(FormSchema::class, 'form_schema_id');
|
|
}
|
|
|
|
public function section(): BelongsTo
|
|
{
|
|
return $this->belongsTo(FormSchemaSection::class, 'form_schema_section_id');
|
|
}
|
|
|
|
public function libraryField(): BelongsTo
|
|
{
|
|
return $this->belongsTo(FormFieldLibrary::class, 'library_field_id');
|
|
}
|
|
|
|
public function values(): HasMany
|
|
{
|
|
return $this->hasMany(FormValue::class);
|
|
}
|
|
|
|
public function bindings(): MorphMany
|
|
{
|
|
return $this->morphMany(FormFieldBinding::class, 'owner');
|
|
}
|
|
|
|
public function validationRules(): MorphMany
|
|
{
|
|
return $this->morphMany(FormFieldValidationRule::class, 'owner');
|
|
}
|
|
|
|
public function configs(): MorphMany
|
|
{
|
|
return $this->morphMany(FormFieldConfig::class, 'owner');
|
|
}
|
|
|
|
/**
|
|
* Nuanced activity log (ARCH §17.1; S1 Phase 4b). Callers choose which
|
|
* events are worth logging — e.g. created/deleted/restored, field_type
|
|
* changed (value storage changes), binding changed, is_pii toggled,
|
|
* is_filterable toggled (triggers backfill), structural options changes.
|
|
* NOT logged (noise): label/help_text/sort_order/conditional_logic/
|
|
* translations.
|
|
*
|
|
* Bulk-fixture suppression: the activitylog.enabled config key is the
|
|
* kill-switch. Seeders and one-shot commands wrap themselves in
|
|
* App\Support\ActivityLog::suppressed(...). activity()->log() becomes
|
|
* a silent no-op while disabled, so no guard is needed here.
|
|
*
|
|
* @param array<string, mixed> $properties
|
|
*/
|
|
public function logFieldChange(string $event, array $properties = []): void
|
|
{
|
|
activity()
|
|
->performedOn($this)
|
|
->withProperties($properties)
|
|
->log($event);
|
|
}
|
|
}
|