Files
crewli/api/app/Http/Resources/FormBuilder/PublicFormSubmissionResource.php
bert.hausmans e4294702c5 feat(form-builder): public resources — TAG_PICKER tags, schema version, submission shape
S2c D1, D5, D7.

PublicFormSchemaResource:
- Carries available_tags on every TAG_PICKER field, respecting
  validation_rules.tag_categories when set. Tags prefetched once per
  org to avoid N+1.
- Surfaces the schema version and an opened_at timestamp so the portal
  can detect drift between GET-time and submit-time.

PublicFormSubmissionResource (new): the submission envelope the portal
sees on every lifecycle endpoint. No PII echo — public_submitter_name,
public_submitter_email, public_submitter_ip never appear. Admin
metadata (review_status, reviewed_by, schema_snapshot, submitter user
id) is filtered out. Includes schema_drift computed from
schema.version vs schema_version_at_submit, and identity_match read
from the §31.1 listener's column with a Dutch message per state
(pending|matched|none).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-17 22:55:54 +02:00

116 lines
4.2 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Http\Resources\FormBuilder;
use App\Models\FormBuilder\FormSubmission;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
/**
* Public-facing submission response for /api/v1/public/forms/... endpoints
* (S2c D7). No PII echo — public_submitter_name / email / ip are stored
* server-side but never reflected back. Admin metadata (review_status,
* reviewed_by, schema_snapshot) is never exposed.
*
* Shape guarantees:
* - `identity_match.status` ∈ null | 'pending' | 'matched' | 'none'
* - `schema_drift` is true when the draft's form_schema.version has
* advanced since draft creation (D5 contract)
* - `values` is keyed by field_slug for easy rehydration on the portal
*
* @mixin FormSubmission
*/
final class PublicFormSubmissionResource extends JsonResource
{
/**
* @return array<string, mixed>
*/
public function toArray(Request $request): array
{
$this->resource->loadMissing(['schema', 'values.field']);
$values = [];
foreach ($this->values as $value) {
$slug = $value->field?->slug;
if ($slug === null) {
continue;
}
$values[$slug] = [
'value' => $value->value,
'value_anonymised' => (bool) $value->value_anonymised,
];
}
$status = $this->status instanceof \BackedEnum ? $this->status->value : $this->status;
$schemaDrift = $this->computeSchemaDrift();
$identityMatch = $this->formatIdentityMatch();
return [
'id' => $this->id,
'form_schema_id' => $this->form_schema_id,
'status' => $status,
'auto_save_count' => (int) $this->auto_save_count,
'submitted_in_locale' => $this->submitted_in_locale,
'schema_version_at_submit' => $this->schema_version_at_submit,
'schema_drift' => $schemaDrift,
'values' => $values,
'identity_match' => $identityMatch,
'opened_at' => optional($this->opened_at)->toIso8601String(),
'first_interacted_at' => optional($this->first_interacted_at)->toIso8601String(),
'submitted_at' => optional($this->submitted_at)->toIso8601String(),
'submission_duration_seconds' => $this->submission_duration_seconds,
'created_at' => optional($this->created_at)->toIso8601String(),
'updated_at' => optional($this->updated_at)->toIso8601String(),
];
}
private function computeSchemaDrift(): bool
{
if ($this->schema_version_at_submit === null) {
// Draft phase: drift is "version advanced since the submission
// was opened". We use schema.version vs the version the portal
// saw via PublicFormSchemaResource at open time — which is
// only derivable after submit. For drafts, schema_drift stays
// false; the submit response is the authoritative check.
return false;
}
$schema = $this->schema;
if ($schema === null) {
return false;
}
return (int) $schema->version !== (int) $this->schema_version_at_submit;
}
/**
* Identity-match signal per ARCH §31.1. Populated by the
* TriggerPersonIdentityMatchOnFormSubmit listener on
* FormSubmissionSubmitted. Read from the dedicated
* form_submissions.identity_match_status column.
*
* @return array<string, string>|null
*/
private function formatIdentityMatch(): ?array
{
$raw = $this->identity_match_status;
if ($raw === null || $raw === '') {
return null;
}
$status = $raw instanceof \BackedEnum ? $raw->value : (string) $raw;
return [
'status' => $status,
'message' => match ($status) {
'pending' => 'We controleren of je al bekend bent bij de organisator. Je gegevens worden gekoppeld zodra zij dit bevestigen.',
'matched' => 'Je account is gekoppeld aan een bekende deelnemer.',
'none' => 'Geen bestaand account gevonden — je wordt als nieuwe deelnemer geregistreerd.',
default => '',
},
];
}
}