Atomic reader switch. All call paths that previously read
form_fields.options / form_field_library.options from the JSON column
now read through FormFieldOptionService::toJsonShape() via the
morphMany relation:
- FormFieldResource + FormFieldLibraryResource +
PublicFormSchemaResource emit the rich-shape array
- FilterRegistryController emits rich shape uniformly (no flat-array
carve-out for filter-UI compatibility — preflight scan confirmed
zero portal/app consumers, S5 territory)
- FormFieldRuleBuilder plucks values from the relation for in:options
rule construction
- FormSubmissionService::buildSnapshot writes rich-shape options into
snapshots and strips translations.{locale}.options from each field's
translations bag (defensive — commit 2 backfill already did the
bulk strip)
- Four FormFieldRequest variants accept array-of-spec-objects,
validate shape in after() via FormFieldOptionService::assertSpecsValid,
and hand off to FormFieldOptionService::replaceOptions for writes
- FormFieldService::create + update extract option specs from the
request data and route through the service after the FormField row
is persisted
FormField and FormFieldLibrary $casts no longer include 'options'; the
JSON column is no longer cast. Options removed from $fillable on both
models so ::create() / ::fill() / mass assignment can no longer touch
the legacy column. Both models gain a getOptionsAttribute() accessor
that resolves $model->options to the eager-loaded morphMany collection
— required because Eloquent's getAttribute() prefers a real DB column
over a relation method, and the JSON column lives on the table until
WS-5d commit 5 drops it.
Activity log — dual emit per §6.7 / §17.4.2 / §17.6.3:
- field.updated carries old.options / new.options diff via
toJsonShape() reconstruction, byte-equal JSON compare to avoid
cosmetic false positives. Field updates that don't touch options
omit the key entirely
- field.options_replaced emits inside replaceOptions() on FormField
subject only; library subject writes silent (mirrors the WS-5b /
WS-5c convention)
JSON columns (form_fields.options, form_field_library.options) remain
present but unread — column drops land atomically in commit 5.
Two pre-existing test fixtures that seeded options via the JSON column
(FormFieldApiTest + PublicFormValidationTest) migrated to the
spec-array path: FormField::factory()->withOptions([...]) where the
options live on the field, or explicit spec-array request bodies for
HTTP tests.
Tests: 1193 → 1206 green (+13 tests / +28 assertions).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
178 lines
6.9 KiB
PHP
178 lines
6.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Http\Resources\FormBuilder;
|
|
|
|
use App\Enums\FormBuilder\FormFieldType;
|
|
use App\Models\FormBuilder\FormField;
|
|
use App\Models\FormBuilder\FormSchema;
|
|
use App\Models\PersonTag;
|
|
use App\Models\Scopes\OrganisationScope;
|
|
use App\Services\FormBuilder\FormFieldConditionalLogicService;
|
|
use App\Services\FormBuilder\FormFieldConfigService;
|
|
use App\Services\FormBuilder\FormFieldOptionService;
|
|
use App\Services\FormBuilder\FormFieldValidationRuleService;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Http\Resources\Json\JsonResource;
|
|
|
|
/**
|
|
* Public-facing schema response for /public/forms/{public_token}. Strictly
|
|
* limited per ARCH §10: only fields with is_portal_visible=true AND
|
|
* is_admin_only=false; no PII hints, no role_restrictions bleed, no
|
|
* submissions_count.
|
|
*
|
|
* Carries TAG_PICKER `available_tags` so the portal can render the picker
|
|
* without a second request (S2c D1). Also surfaces `version` + `opened_at`
|
|
* so the portal can later detect schema drift at submit time (D5).
|
|
*
|
|
* @mixin FormSchema
|
|
*/
|
|
final class PublicFormSchemaResource extends JsonResource
|
|
{
|
|
/**
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function toArray(Request $request): array
|
|
{
|
|
// Public endpoints must resolve cross-org — skip OrganisationScope
|
|
// on the FormField / FormSchemaSection relations (both registered
|
|
// via addendum Q2 / WS-4 Commit 3). The schema-level tenant check
|
|
// already happens at PublicFormTokenResolver::resolve().
|
|
$this->resource->loadMissing([
|
|
'fields' => fn ($q) => $q->withoutGlobalScope(OrganisationScope::class),
|
|
'fields.validationRules',
|
|
'fields.configs',
|
|
'fields.options',
|
|
'sections' => fn ($q) => $q->withoutGlobalScope(OrganisationScope::class),
|
|
]);
|
|
|
|
$visibleFields = $this->fields
|
|
->filter(fn ($f) => (bool) $f->is_portal_visible && ! (bool) $f->is_admin_only)
|
|
->values();
|
|
|
|
$organisationId = $this->organisation_id;
|
|
$availableTagsByCategory = $this->availableTagsByCategory($organisationId, $visibleFields);
|
|
|
|
return [
|
|
'id' => $this->id,
|
|
'name' => $this->name,
|
|
'slug' => $this->slug,
|
|
'purpose' => $this->purpose instanceof \BackedEnum ? $this->purpose->value : $this->purpose,
|
|
'description' => $this->description,
|
|
'locale' => $this->locale,
|
|
'version' => (int) $this->version,
|
|
'opened_at' => now()->toIso8601String(),
|
|
'consent_version' => $this->consent_version,
|
|
'submission_deadline' => optional($this->submission_deadline)->toIso8601String(),
|
|
'section_level_submit' => (bool) $this->section_level_submit,
|
|
'sections' => $this->sections->map(fn ($s) => [
|
|
'id' => $s->id,
|
|
'slug' => $s->slug,
|
|
'name' => $s->name,
|
|
'description' => $s->description,
|
|
'sort_order' => (int) $s->sort_order,
|
|
])->values()->all(),
|
|
'fields' => $visibleFields->map(function (FormField $f) use ($availableTagsByCategory): array {
|
|
$isTagPicker = $f->field_type === FormFieldType::TAG_PICKER->value;
|
|
|
|
return [
|
|
'id' => $f->id,
|
|
'slug' => $f->slug,
|
|
'field_type' => $f->field_type,
|
|
'label' => $f->label,
|
|
'help_text' => $f->help_text,
|
|
'options' => $f->options->isNotEmpty()
|
|
? app(FormFieldOptionService::class)->toJsonShape($f->options)
|
|
: null,
|
|
'available_tags' => $isTagPicker
|
|
? $this->tagsForField($f, $availableTagsByCategory)
|
|
: null,
|
|
'validation_rules' => app(FormFieldValidationRuleService::class)->toJsonShape(
|
|
$f->validationRules,
|
|
),
|
|
'configs' => app(FormFieldConfigService::class)->toJsonShape($f->configs),
|
|
'is_required' => (bool) $f->is_required,
|
|
'display_width' => $f->display_width instanceof \BackedEnum ? $f->display_width->value : $f->display_width,
|
|
'conditional_logic' => app(FormFieldConditionalLogicService::class)->toJsonShape(
|
|
$f->rootConditionalLogicGroup(),
|
|
),
|
|
'sort_order' => (int) $f->sort_order,
|
|
'form_schema_section_id' => $f->form_schema_section_id,
|
|
];
|
|
})->values()->all(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Prefetch every active person_tag for the org once and bucket by
|
|
* category so TAG_PICKER fields can apply their own category filter
|
|
* without N+1 queries.
|
|
*
|
|
* @param \Illuminate\Support\Collection<int, FormField> $visibleFields
|
|
* @return array<string, array<int, array<string, string>>> categoryKey → rows
|
|
*/
|
|
private function availableTagsByCategory(?string $organisationId, $visibleFields): array
|
|
{
|
|
if ($organisationId === null) {
|
|
return [];
|
|
}
|
|
$hasTagPicker = $visibleFields->contains(fn ($f) => $f->field_type === FormFieldType::TAG_PICKER->value);
|
|
if (! $hasTagPicker) {
|
|
return [];
|
|
}
|
|
|
|
// Named-scope bypass only — don't unintentionally strip future
|
|
// soft-delete or is_active scopes if any land later.
|
|
$rows = PersonTag::query()
|
|
->withoutGlobalScope(OrganisationScope::class)
|
|
->where('organisation_id', $organisationId)
|
|
->where('is_active', true)
|
|
->orderBy('sort_order')
|
|
->orderBy('name')
|
|
->get(['id', 'name', 'category']);
|
|
|
|
$grouped = [];
|
|
foreach ($rows as $tag) {
|
|
$category = (string) ($tag->category ?? '');
|
|
$grouped[$category][] = [
|
|
'id' => (string) $tag->id,
|
|
'name' => (string) $tag->name,
|
|
'category' => $category,
|
|
];
|
|
}
|
|
|
|
return $grouped;
|
|
}
|
|
|
|
/**
|
|
* @param array<string, array<int, array<string, string>>> $byCategory
|
|
* @return array<int, array<string, string>>
|
|
*/
|
|
private function tagsForField(FormField $field, array $byCategory): array
|
|
{
|
|
$configs = app(FormFieldConfigService::class)->toJsonShape($field->configs);
|
|
$filter = (array) ($configs['tag_categories']['categories'] ?? []);
|
|
|
|
if ($filter === []) {
|
|
$out = [];
|
|
foreach ($byCategory as $rows) {
|
|
foreach ($rows as $row) {
|
|
$out[] = $row;
|
|
}
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
|
|
$out = [];
|
|
foreach ($filter as $category) {
|
|
foreach ($byCategory[(string) $category] ?? [] as $row) {
|
|
$out[] = $row;
|
|
}
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
}
|