feat(form-builder): form_field_configs relational table + non-validation key split + drop validation_rules JSON columns
This commit is contained in:
187
api/app/Services/FormBuilder/FormFieldConfigService.php
Normal file
187
api/app/Services/FormBuilder/FormFieldConfigService.php
Normal file
@@ -0,0 +1,187 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Services\FormBuilder;
|
||||
|
||||
use App\Enums\FormBuilder\FormFieldConfigType;
|
||||
use App\Exceptions\FormBuilder\UnknownValidationRuleTypeException;
|
||||
use App\Models\FormBuilder\FormField;
|
||||
use App\Models\FormBuilder\FormFieldConfig;
|
||||
use App\Models\FormBuilder\FormFieldLibrary;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\DB;
|
||||
|
||||
/**
|
||||
* Owns writes to `form_field_configs` — non-validation per-field
|
||||
* configuration (ARCH-FORM-BUILDER §17.5; addendum Q3 WS-5b Uitvoering).
|
||||
*
|
||||
* Mirrors `FormFieldValidationRuleService` exactly: same service-layer
|
||||
* contract (`configsFor`, `replaceConfigs`, `copyConfigs`,
|
||||
* `toJsonShape`, `assertSpecsValid`), same activity-log convention
|
||||
* (emit `field.configs_replaced` on FormField only, silent for library
|
||||
* — matches §6.7 WS-5a pattern).
|
||||
*
|
||||
* Re-uses the `UnknownValidationRuleTypeException` for parameter-shape
|
||||
* violations; the two services share a failure mode (caller supplied a
|
||||
* spec that does not match the registered type's schema) and adding a
|
||||
* second exception class for the same semantic would be noise.
|
||||
*/
|
||||
final class FormFieldConfigService
|
||||
{
|
||||
/**
|
||||
* @return Collection<int, FormFieldConfig>
|
||||
*/
|
||||
public function configsFor(FormField|FormFieldLibrary $owner): Collection
|
||||
{
|
||||
$type = $this->ownerTypeFor($owner);
|
||||
|
||||
return FormFieldConfig::query()
|
||||
->where('owner_type', $type)
|
||||
->where('owner_id', $owner->getKey())
|
||||
->get();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param list<array{config_type:string,parameters?:array<string,mixed>}> $specs
|
||||
*/
|
||||
public function replaceConfigs(FormField|FormFieldLibrary $owner, array $specs): void
|
||||
{
|
||||
$this->assertSpecsValid($specs);
|
||||
|
||||
$ownerType = $this->ownerTypeFor($owner);
|
||||
|
||||
DB::transaction(function () use ($owner, $ownerType, $specs): void {
|
||||
FormFieldConfig::query()
|
||||
->withoutGlobalScopes()
|
||||
->where('owner_type', $ownerType)
|
||||
->where('owner_id', $owner->getKey())
|
||||
->delete();
|
||||
|
||||
foreach ($specs as $spec) {
|
||||
FormFieldConfig::query()->withoutGlobalScopes()->create([
|
||||
'owner_type' => $ownerType,
|
||||
'owner_id' => $owner->getKey(),
|
||||
'config_type' => $spec['config_type'],
|
||||
'parameters' => $spec['parameters'] ?? [],
|
||||
]);
|
||||
}
|
||||
|
||||
if ($owner instanceof FormField) {
|
||||
$owner->logFieldChange('field.configs_replaced', [
|
||||
'count' => count($specs),
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
public function copyConfigs(FormFieldLibrary $from, FormField $to): void
|
||||
{
|
||||
$configs = $this->configsFor($from);
|
||||
|
||||
if ($configs->isEmpty()) {
|
||||
return;
|
||||
}
|
||||
|
||||
DB::transaction(function () use ($configs, $to): void {
|
||||
foreach ($configs as $config) {
|
||||
FormFieldConfig::query()->withoutGlobalScopes()->create([
|
||||
'owner_type' => 'form_field',
|
||||
'owner_id' => $to->id,
|
||||
'config_type' => $config->config_type instanceof FormFieldConfigType
|
||||
? $config->config_type->value
|
||||
: (string) $config->config_type,
|
||||
'parameters' => (array) $config->parameters,
|
||||
]);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Serialise a config collection into the nested-object JSON shape
|
||||
* consumed by snapshot writer and API resources. Returns `null` on
|
||||
* empty (matches the contract pattern WS-5b introduced on the
|
||||
* validation-rules service).
|
||||
*
|
||||
* Shape per config_type:
|
||||
* - tag_categories → `{"categories": [string]}`
|
||||
* - storage_disk → `{"disk": string}`
|
||||
*
|
||||
* The external envelope is `{<config_type>: <parameters>}`:
|
||||
* `{"tag_categories": {"categories": ["Veiligheid"]},
|
||||
* "storage_disk": {"disk": "local"}}`
|
||||
*
|
||||
* @param Collection<int, FormFieldConfig> $configs
|
||||
* @return array<string, array<string, mixed>>|null
|
||||
*/
|
||||
public function toJsonShape(Collection $configs): ?array
|
||||
{
|
||||
if ($configs->isEmpty()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$out = [];
|
||||
foreach ($configs as $config) {
|
||||
$type = $config->config_type instanceof FormFieldConfigType
|
||||
? $config->config_type->value
|
||||
: (string) $config->config_type;
|
||||
$out[$type] = (array) $config->parameters;
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/** @param list<array<string, mixed>> $specs */
|
||||
public function assertSpecsValid(array $specs): void
|
||||
{
|
||||
foreach ($specs as $spec) {
|
||||
$this->assertSpecValid($spec);
|
||||
}
|
||||
}
|
||||
|
||||
private function ownerTypeFor(FormField|FormFieldLibrary $owner): string
|
||||
{
|
||||
return $owner instanceof FormField ? 'form_field' : 'form_field_library';
|
||||
}
|
||||
|
||||
/** @param array<string, mixed> $spec */
|
||||
private function assertSpecValid(array $spec): void
|
||||
{
|
||||
$raw = (string) ($spec['config_type'] ?? '');
|
||||
$enum = FormFieldConfigType::tryFrom($raw);
|
||||
if ($enum === null) {
|
||||
throw new UnknownValidationRuleTypeException(
|
||||
"Config config_type '{$raw}' is not a registered FormFieldConfigType case.",
|
||||
);
|
||||
}
|
||||
|
||||
$params = (array) ($spec['parameters'] ?? []);
|
||||
|
||||
switch ($enum) {
|
||||
case FormFieldConfigType::TagCategories:
|
||||
if (! isset($params['categories']) || ! is_array($params['categories'])) {
|
||||
throw new UnknownValidationRuleTypeException(
|
||||
"Config 'tag_categories' requires parameters.categories (array of strings).",
|
||||
);
|
||||
}
|
||||
foreach ($params['categories'] as $cat) {
|
||||
if (! is_string($cat) || $cat === '') {
|
||||
throw new UnknownValidationRuleTypeException(
|
||||
"Config 'tag_categories' parameters.categories must be non-empty strings.",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return;
|
||||
|
||||
case FormFieldConfigType::StorageDisk:
|
||||
if (! isset($params['disk']) || ! is_string($params['disk']) || $params['disk'] === '') {
|
||||
throw new UnknownValidationRuleTypeException(
|
||||
"Config 'storage_disk' requires non-empty string parameters.disk.",
|
||||
);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -28,6 +28,7 @@ final class FormFieldService
|
||||
private readonly FormSchemaService $schemaService,
|
||||
private readonly FormFieldBindingService $bindingService,
|
||||
private readonly FormFieldValidationRuleService $validationRuleService,
|
||||
private readonly FormFieldConfigService $configService,
|
||||
) {}
|
||||
|
||||
public function create(FormSchema $schema, array $data): FormField
|
||||
@@ -242,7 +243,6 @@ final class FormFieldService
|
||||
'label' => $library->label,
|
||||
'help_text' => $library->help_text,
|
||||
'options' => $library->options,
|
||||
'validation_rules' => $library->validation_rules,
|
||||
'is_required' => (bool) $library->default_is_required,
|
||||
'is_filterable' => (bool) $library->default_is_filterable,
|
||||
'translations' => $library->translations,
|
||||
@@ -260,6 +260,7 @@ final class FormFieldService
|
||||
|
||||
$this->bindingService->copyBindings($library, $field);
|
||||
$this->validationRuleService->copyRules($library, $field);
|
||||
$this->configService->copyConfigs($library, $field);
|
||||
|
||||
FormFieldLibrary::query()->whereKey($library->id)->increment('usage_count');
|
||||
|
||||
|
||||
@@ -35,6 +35,7 @@ final class FormSubmissionService
|
||||
private readonly FormValueService $valueService,
|
||||
private readonly FormFieldBindingService $bindingService,
|
||||
private readonly FormFieldValidationRuleService $validationRuleService,
|
||||
private readonly FormFieldConfigService $configService,
|
||||
) {}
|
||||
|
||||
/**
|
||||
@@ -201,7 +202,7 @@ final class FormSubmissionService
|
||||
*/
|
||||
private function buildSnapshot(FormSchema $schema): array
|
||||
{
|
||||
$schema->loadMissing(['fields.bindings', 'fields.validationRules', 'sections']);
|
||||
$schema->loadMissing(['fields.bindings', 'fields.validationRules', 'fields.configs', 'sections']);
|
||||
|
||||
return [
|
||||
'schema_version' => $schema->version,
|
||||
@@ -234,6 +235,7 @@ final class FormSubmissionService
|
||||
'section_slug' => $this->sectionSlug($schema, $f->form_schema_section_id),
|
||||
'options' => $f->options,
|
||||
'validation_rules' => $this->validationRuleService->toJsonShape($f->validationRules),
|
||||
'configs' => $this->configService->toJsonShape($f->configs),
|
||||
'is_required' => (bool) $f->is_required,
|
||||
'is_filterable' => (bool) $f->is_filterable,
|
||||
'is_pii' => (bool) $f->is_pii,
|
||||
|
||||
Reference in New Issue
Block a user