| @@ -1,19 +1,19 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | namespace IvyForms\Factory\Field; |
| 4 | 4 | |
| 5 | -// phpcs:disable PSR1.Files.SideEffects | |
| 6 | -if (!defined('ABSPATH')) { | |
| 7 | - exit; // Exit if accessed directly | |
| 8 | -} | |
| 9 | - | |
| 10 | 5 | use IvyForms\Common\Exceptions\ValidationException; |
| 6 | +use IvyForms\Common\Helpers\NameFieldKeyHelper; | |
| 11 | 7 | use IvyForms\Entity\Field\Field as FieldEntity; |
| 12 | 8 | use IvyForms\ValueObjects\Field\Field; |
| 13 | 9 | use IvyForms\ValueObjects\Field\FieldGeneralSettings; |
| 14 | 10 | use IvyForms\ValueObjects\Field\FieldOptions; |
| 15 | 11 | use IvyForms\ValueObjects\Field\FieldAdvancedSettings; |
| 12 | +use IvyForms\ValueObjects\Field\FileUploadFieldAdvancedSettings; | |
| 13 | +use IvyForms\ValueObjects\Field\ConfirmationGeneralSettings; | |
| 14 | +use IvyForms\ValueObjects\Field\TimeFieldGeneralSettings; | |
| 15 | +use IvyForms\ValueObjects\Field\DateFieldGeneralSettings; | |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | 18 | * Class FieldFactory |
| 19 | 19 | * |
| @@ -29,9 +29,9 @@ | ||
| 29 | 29 | * @throws ValidationException |
| 30 | 30 | */ |
| 31 | 31 | public static function create(array $data): FieldEntity |
| 32 | 32 | { |
| 33 | - $settings = isset($data['settings']) ? json_decode($data['settings'], true) : []; | |
| 33 | + $settings = self::parseSettings($data['settings'] ?? null); | |
| 34 | 34 | |
| 35 | 35 | if (!empty($settings)) { |
| 36 | 36 | $data['hideLabel'] = $settings['hideLabel'] ?? false; |
| 37 | 37 | $data['readOnly'] = $settings['readOnly'] ?? false; |
| @@ -38,8 +38,9 @@ | ||
| 38 | 38 | $data['description'] = $settings['description'] ?? ''; |
| 39 | 39 | $data['requiredMessage'] = $settings['requiredMessage'] ?? ''; |
| 40 | 40 | $data['cssClasses'] = $settings['cssClasses'] ?? ''; |
| 41 | 41 | $data['limitMaxLength'] = $settings['limitMaxLength'] ?? false; |
| 42 | + $data['limitRange'] = $settings['limitRange'] ?? false; | |
| 42 | 43 | $data['maxLength'] = $settings['maxLength'] ?? 255; |
| 43 | 44 | $data['labelPosition'] = $settings['labelPosition'] ?? 'default'; |
| 44 | 45 | $data['noDuplicates'] = $settings['noDuplicates'] ?? false; |
| 45 | 46 | $data['shuffleOptions'] = $settings['shuffleOptions'] ?? false; |
| @@ -51,13 +52,41 @@ | ||
| 51 | 52 | $data['confirmFieldPlaceholder'] = $settings['confirmFieldPlaceholder'] ?? ''; |
| 52 | 53 | $data['confirmFieldHideLabel'] = $settings['confirmFieldHideLabel'] ?? false; |
| 53 | 54 | $data['phoneFormat'] = $settings['phoneFormat'] ?? ''; |
| 54 | 55 | $data['phoneAutoDetect'] = $settings['phoneAutoDetect'] ?? false; |
| 55 | - $data['minValue'] = $settings['minValue'] ?? 0; | |
| 56 | - $data['maxValue'] = $settings['maxValue'] ?? 0; | |
| 56 | + $data['minValue'] = $settings['minValue'] ?? null; | |
| 57 | + $data['maxValue'] = $settings['maxValue'] ?? null; | |
| 57 | 58 | $data['step'] = $settings['step'] ?? 1; |
| 59 | + $data['showGrid'] = $settings['showGrid'] ?? false; | |
| 58 | 60 | $data['numberFormat'] = $settings['numberFormat'] ?? ''; |
| 59 | - // Robust boolean conversion for visible (matches hideLabel logic) | |
| 61 | + $data['inputPrefix'] = $settings['inputPrefix'] ?? ''; | |
| 62 | + $data['inputSuffix'] = $settings['inputSuffix'] ?? ''; | |
| 63 | + $data['timeFieldType'] = $settings['timeFieldType'] ?? ''; | |
| 64 | + $data['timeFormat'] = $settings['timeFormat'] ?? ''; | |
| 65 | + $data['minTimeValue'] = $settings['minTimeValue'] ?? ''; | |
| 66 | + $data['maxTimeValue'] = $settings['maxTimeValue'] ?? ''; | |
| 67 | + $data['dateFieldType'] = $settings['dateFieldType'] ?? ''; | |
| 68 | + $data['dateFormat'] = $settings['dateFormat'] ?? ''; | |
| 69 | + $data['minDateValue'] = $settings['minDateValue'] ?? ''; | |
| 70 | + $data['maxDateValue'] = $settings['maxDateValue'] ?? ''; | |
| 71 | + $data['showRatingText'] = $settings['showRatingText'] ?? false; | |
| 72 | + $data['ratingIcon'] = $settings['ratingIcon'] ?? 'star'; | |
| 73 | + $data['htmlContent'] = $settings['htmlContent'] ?? ''; | |
| 74 | + $data['agreementText'] = $settings['agreementText'] ?? ''; | |
| 75 | + $data['limitDateRange'] = $settings['limitDateRange'] ?? false; | |
| 76 | + $data['limitTimeRange'] = $settings['limitTimeRange'] ?? false; | |
| 77 | + $data['maxFileSizeMb'] = isset($settings['maxFileSizeMb']) ? (int) $settings['maxFileSizeMb'] : 0; | |
| 78 | + $data['saveUploadsTo'] = isset($settings['saveUploadsTo']) | |
| 79 | + ? (string) $settings['saveUploadsTo'] | |
| 80 | + : 'ivyforms'; | |
| 81 | + if (!array_key_exists('allowedFileExtensions', $data) && isset($settings['allowedFileExtensions'])) { | |
| 82 | + $data['allowedFileExtensions'] = $settings['allowedFileExtensions']; | |
| 83 | + } | |
| 84 | + // Grid layout: prioritize direct database columns over settings JSON | |
| 85 | + // This ensures backward compatibility while preferring the dedicated columns | |
| 86 | + $data['rowIndex'] = $data['rowIndex'] ?? ($settings['rowIndex'] ?? 0); | |
| 87 | + $data['columnIndex'] = $data['columnIndex'] ?? ($settings['columnIndex'] ?? 0); | |
| 88 | + $data['width'] = $data['width'] ?? ($settings['width'] ?? 100); | |
| 60 | 89 | $data['visible'] = array_key_exists('visible', $settings) |
| 61 | 90 | ? filter_var($settings['visible'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) |
| 62 | 91 | : true; |
| 63 | 92 | if ($data['visible'] === null) { |
| @@ -62,9 +91,47 @@ | ||
| 62 | 91 | : true; |
| 63 | 92 | if ($data['visible'] === null) { |
| 64 | 93 | $data['visible'] = true; |
| 65 | 94 | } |
| 95 | + if (isset($settings['nameFieldType'])) { | |
| 96 | + $data['nameFieldType'] = (string)$settings['nameFieldType']; | |
| 97 | + } | |
| 98 | + if (array_key_exists('subFieldIndex', $settings)) { | |
| 99 | + $data['subFieldIndex'] = is_numeric($settings['subFieldIndex']) | |
| 100 | + ? (int)$settings['subFieldIndex'] | |
| 101 | + : null; | |
| 102 | + } | |
| 66 | 103 | } |
| 104 | + | |
| 105 | + if (isset($data['nameFieldType'])) { | |
| 106 | + $data['nameFieldType'] = (string)$data['nameFieldType']; | |
| 107 | + } | |
| 108 | + if (array_key_exists('subFieldIndex', $data)) { | |
| 109 | + $data['subFieldIndex'] = is_numeric($data['subFieldIndex']) | |
| 110 | + ? (int)$data['subFieldIndex'] | |
| 111 | + : null; | |
| 112 | + } | |
| 113 | + | |
| 114 | + if (empty($data['nameFieldType'])) { | |
| 115 | + $inferredNameFieldType = NameFieldKeyHelper::inferNameFieldKeyFromLabel($data['label'] ?? ''); | |
| 116 | + if ($inferredNameFieldType !== null) { | |
| 117 | + $data['nameFieldType'] = $inferredNameFieldType; | |
| 118 | + } | |
| 119 | + } | |
| 120 | + | |
| 121 | + /** | |
| 122 | + * Allows modification of the settings data before creating the Field entity. | |
| 123 | + * This filter runs for both: | |
| 124 | + * - Fields loaded from database (settings from JSON string) | |
| 125 | + * - Fields from API (settings from direct properties) | |
| 126 | + * @since 0.1.0 | |
| 127 | + * | |
| 128 | + * @param mixed[] $data The current field data. | |
| 129 | + * @param mixed[] $settings The settings array (from database or empty for API). | |
| 130 | + * @return mixed[] The modified field data. | |
| 131 | + */ | |
| 132 | + $data = apply_filters('ivyforms/field/factory/extract_settings', $data, $settings); | |
| 133 | + | |
| 67 | 134 | $generalSettings = new FieldGeneralSettings( |
| 68 | 135 | self::validateString($data['label'] ?? '', 255, 'label'), |
| 69 | 136 | self::validateBool($data['required'] ?? false), |
| 70 | 137 | self::validateString($data['placeholder'] ?? '', 255, 'placeholder'), |
| @@ -69,9 +136,9 @@ | ||
| 69 | 136 | self::validateBool($data['required'] ?? false), |
| 70 | 137 | self::validateString($data['placeholder'] ?? '', 255, 'placeholder'), |
| 71 | 138 | self::validateBool($data['hideLabel'] ?? false), |
| 72 | 139 | self::validateBool($data['readOnly'] ?? false), |
| 73 | - self::validateString($data['description'] ?? '', 255, 'description'), | |
| 140 | + self::validateString($data['description'] ?? '', 1000, 'description'), | |
| 74 | 141 | self::validateString($data['requiredMessage'] ?? '', 255, 'requiredMessage'), |
| 75 | 142 | self::validateString($data['cssClasses'] ?? '', 255, 'cssClasses'), |
| 76 | 143 | self::validateBool($data['shuffleOptions'] ?? false), |
| 77 | 144 | self::validateBool($data['showValues'] ?? false), |
| @@ -77,20 +144,67 @@ | ||
| 77 | 144 | self::validateBool($data['showValues'] ?? false), |
| 78 | 145 | self::validateBool($data['enableSearch'] ?? false), |
| 79 | 146 | self::validatePhoneFormat($data['phoneFormat'] ?? ''), |
| 80 | 147 | self::validateBool($data['phoneAutoDetect'] ?? false), |
| 81 | - self::validateNumberValue($data['minValue'] ?? 0.0, 'minValue'), | |
| 82 | - self::validateNumberValue($data['maxValue'] ?? 0.0, 'maxValue'), | |
| 148 | + self::validateNumberValue($data['minValue'] ?? null, 'minValue'), | |
| 149 | + self::validateNumberValue($data['maxValue'] ?? null, 'maxValue'), | |
| 83 | 150 | self::validateStep($data['step'] ?? 1), |
| 151 | + self::validateBool($data['showGrid'] ?? false), | |
| 84 | 152 | self::validateNumberFormat($data['numberFormat'] ?? ''), |
| 85 | - self::validateBool($data['visible'] ?? true) | |
| 153 | + new ConfirmationGeneralSettings( | |
| 154 | + self::validateBool($data['confirmFieldEnabled'] ?? false), | |
| 155 | + self::validateString( | |
| 156 | + $data['confirmFieldLabel'] ?? '', | |
| 157 | + 255, | |
| 158 | + 'confirmFieldLabel' | |
| 159 | + ), | |
| 160 | + self::validateString( | |
| 161 | + $data['confirmFieldPlaceholder'] ?? '', | |
| 162 | + 255, | |
| 163 | + 'confirmFieldPlaceholder' | |
| 164 | + ), | |
| 165 | + self::validateBool($data['confirmFieldHideLabel'] ?? false) | |
| 166 | + ), | |
| 167 | + new TimeFieldGeneralSettings( | |
| 168 | + self::validateBool($data['limitTimeRange'] ?? false), | |
| 169 | + self::validateString($data['timeFieldType'] ?? '', 50, 'timeFieldType'), | |
| 170 | + self::validateString($data['timeFormat'] ?? '', 50, 'timeFormat'), | |
| 171 | + isset($data['minTimeValue']) && $data['minTimeValue'] !== '' ? | |
| 172 | + self::validateString($data['minTimeValue'], 255, 'minTimeValue') : null, | |
| 173 | + isset($data['maxTimeValue']) && $data['maxTimeValue'] !== '' ? | |
| 174 | + self::validateString($data['maxTimeValue'], 255, 'maxTimeValue') : null, | |
| 175 | + ), | |
| 176 | + new DateFieldGeneralSettings( | |
| 177 | + self::validateBool($data['limitDateRange'] ?? false), | |
| 178 | + self::validateString($data['dateFieldType'] ?? '', 50, 'dateFieldType'), | |
| 179 | + self::validateString($data['dateFormat'] ?? '', 50, 'dateFormat'), | |
| 180 | + isset($data['minDateValue']) && $data['minDateValue'] !== '' ? | |
| 181 | + self::validateString($data['minDateValue'], 255, 'minDateValue') : null, | |
| 182 | + isset($data['maxDateValue']) && $data['maxDateValue'] !== '' ? | |
| 183 | + self::validateString($data['maxDateValue'], 255, 'maxDateValue') : null, | |
| 184 | + ), | |
| 185 | + self::validateBool($data['showRatingText'] ?? false), | |
| 186 | + self::validateBool($data['visible'] ?? true), | |
| 187 | + self::validateString($data['htmlContent'] ?? '', 4294967295, 'htmlContent'), | |
| 188 | + self::validateString($data['agreementText'] ?? '', 1000, 'agreementText'), | |
| 189 | + self::validateBool($data['limitRange'] ?? false), | |
| 86 | 190 | ); |
| 87 | 191 | $advancedSettings = new FieldAdvancedSettings( |
| 88 | - self::validateString($data['defaultValue'] ?? '', 255, 'defaultValue'), | |
| 192 | + self::resolveDefaultValue($data), | |
| 89 | 193 | self::validateBool($data['limitMaxLength'] ?? false), |
| 90 | 194 | (int)($data['maxLength'] ?? 255), |
| 91 | 195 | self::validateString($data['labelPosition'] ?? '', 255, 'labelPosition'), |
| 92 | 196 | self::validateBool($data['noDuplicates'] ?? false), |
| 197 | + self::validateString($data['inputPrefix'] ?? '', 255, 'inputPrefix'), | |
| 198 | + self::validateString($data['inputSuffix'] ?? '', 255, 'inputSuffix'), | |
| 199 | + self::validateString($data['ratingIcon'] ?? 'star', 50, 'ratingIcon'), | |
| 200 | + new FileUploadFieldAdvancedSettings( | |
| 201 | + (int) ($data['maxFileSizeMb'] ?? 0), | |
| 202 | + (string) ($data['saveUploadsTo'] ?? 'ivyforms'), | |
| 203 | + is_array($data['allowedFileExtensions'] ?? null) | |
| 204 | + ? $data['allowedFileExtensions'] | |
| 205 | + : [] | |
| 206 | + ) | |
| 93 | 207 | ); |
| 94 | 208 | $fieldOptions = new FieldOptions($data['options'] ?? []); |
| 95 | 209 | |
| 96 | 210 | $fieldObject = new Field( |
| @@ -98,19 +212,29 @@ | ||
| 98 | 212 | $data['formId'] ?? 0, |
| 99 | 213 | $data['fieldIndex'] ?? 0, |
| 100 | 214 | $data['type'] ?? '', |
| 101 | 215 | $data['position'] ?? 0, |
| 102 | - $data['parentId'] ?? null, | |
| 103 | 216 | $generalSettings, |
| 104 | 217 | $fieldOptions, |
| 105 | 218 | $advancedSettings, |
| 219 | + $data['parentId'] ?? null, | |
| 106 | 220 | $data['rows'] ?? 0, |
| 107 | - $data['confirmFieldEnabled'] ?? false, | |
| 108 | - $data['confirmFieldLabel'] ?? '', | |
| 109 | - $data['confirmFieldPlaceholder'] ?? '', | |
| 110 | - $data['confirmFieldHideLabel'] ?? false | |
| 221 | + $data['rowIndex'] ?? 0, | |
| 222 | + $data['columnIndex'] ?? 0, | |
| 223 | + $data['width'] ?? 100, | |
| 224 | + $data['pageId'] ?? null | |
| 111 | 225 | ); |
| 112 | 226 | |
| 227 | + /** | |
| 228 | + * Allows setting of additional properties for the Field value object. | |
| 229 | + * @since 0.1.0 | |
| 230 | + * | |
| 231 | + * @param Field $fieldObject The current field data. | |
| 232 | + * @param mixed[] $data The settings array from the database. | |
| 233 | + * @return mixed[] The modified field data. | |
| 234 | + */ | |
| 235 | + $fieldObject = apply_filters('ivyforms/field/value_object/set_properties', $fieldObject, $data); | |
| 236 | + | |
| 113 | 237 | $field = new FieldEntity($fieldObject); |
| 114 | 238 | |
| 115 | 239 | if (isset($data['id'])) { |
| 116 | 240 | $field->setId($data['id']); |
| @@ -135,25 +259,53 @@ | ||
| 135 | 259 | if (isset($data['parentId'])) { |
| 136 | 260 | $field->setParentId($data['parentId']); |
| 137 | 261 | } |
| 138 | 262 | |
| 263 | + if (isset($data['pageId'])) { | |
| 264 | + $field->setPageId($data['pageId']); | |
| 265 | + } | |
| 266 | + | |
| 139 | 267 | if (isset($data['rows'])) { |
| 140 | 268 | $field->setRows((int)$data['rows']); |
| 141 | 269 | } |
| 142 | - if (isset($data['confirmFieldEnabled'])) { | |
| 143 | - $field->setConfirmFieldEnabled((bool)$data['confirmFieldEnabled']); | |
| 270 | + | |
| 271 | + /** | |
| 272 | + * Allows setting of additional properties for the Field entity. | |
| 273 | + * @since 0.1.0 | |
| 274 | + * | |
| 275 | + * @param FieldEntity $field The current field data. | |
| 276 | + * @param mixed[] $data The settings array from the database. | |
| 277 | + * @return mixed[] The modified field data. | |
| 278 | + */ | |
| 279 | + $field = apply_filters('ivyforms/field/entity/set_properties', $field, $data); | |
| 280 | + | |
| 281 | + if (!empty($data['nameFieldType'])) { | |
| 282 | + $field->setAdditionalProperty('nameFieldType', (string)$data['nameFieldType']); | |
| 144 | 283 | } |
| 145 | - if (isset($data['confirmFieldLabel'])) { | |
| 146 | - $field->setConfirmFieldLabel($data['confirmFieldLabel']); | |
| 284 | + if (array_key_exists('subFieldIndex', $data) && $data['subFieldIndex'] !== null) { | |
| 285 | + $field->setAdditionalProperty('subFieldIndex', (int)$data['subFieldIndex']); | |
| 147 | 286 | } |
| 148 | - if (isset($data['confirmFieldPlaceholder'])) { | |
| 149 | - $field->setConfirmFieldPlaceholder($data['confirmFieldPlaceholder']); | |
| 287 | + | |
| 288 | + return $field; | |
| 289 | + } | |
| 290 | + | |
| 291 | + /** | |
| 292 | + * @param mixed $rawSettings | |
| 293 | + * @return array<string, mixed> | |
| 294 | + */ | |
| 295 | + private static function parseSettings($rawSettings): array | |
| 296 | + { | |
| 297 | + if (is_array($rawSettings)) { | |
| 298 | + return $rawSettings; | |
| 150 | 299 | } |
| 151 | - if (isset($data['confirmFieldHideLabel'])) { | |
| 152 | - $field->setConfirmFieldHideLabel((bool)$data['confirmFieldHideLabel']); | |
| 300 | + | |
| 301 | + if (!is_string($rawSettings) || $rawSettings === '') { | |
| 302 | + return []; | |
| 153 | 303 | } |
| 154 | 304 | |
| 155 | - return $field; | |
| 305 | + $decoded = json_decode($rawSettings, true); | |
| 306 | + | |
| 307 | + return is_array($decoded) ? $decoded : []; | |
| 156 | 308 | } |
| 157 | 309 | |
| 158 | 310 | /** |
| 159 | 311 | * Validate and convert a value to boolean. |
| @@ -167,8 +319,33 @@ | ||
| 167 | 319 | return (bool)$value; |
| 168 | 320 | } |
| 169 | 321 | |
| 170 | 322 | /** |
| 323 | + * Resolve and validate field default value (Pro may override for rich_text, etc.). | |
| 324 | + * | |
| 325 | + * @param array<string, mixed> $data | |
| 326 | + * | |
| 327 | + * @return string | |
| 328 | + * | |
| 329 | + * @throws ValidationException | |
| 330 | + */ | |
| 331 | + private static function resolveDefaultValue(array $data): string | |
| 332 | + { | |
| 333 | + $filtered = apply_filters( | |
| 334 | + 'ivyforms/field/validate_default_value', | |
| 335 | + null, | |
| 336 | + $data['defaultValue'] ?? '', | |
| 337 | + $data | |
| 338 | + ); | |
| 339 | + | |
| 340 | + if (is_string($filtered)) { | |
| 341 | + return $filtered; | |
| 342 | + } | |
| 343 | + | |
| 344 | + return self::validateString($data['defaultValue'] ?? '', 255, 'defaultValue'); | |
| 345 | + } | |
| 346 | + | |
| 347 | + /** | |
| 171 | 348 | * Validate a string's length. |
| 172 | 349 | * |
| 173 | 350 | * @param mixed $value The value to validate. |
| 174 | 351 | * @param int $maxLength The maximum allowed length. |
| @@ -198,15 +375,15 @@ | ||
| 198 | 375 | * Performs cross-check when the counterpart is already set. |
| 199 | 376 | * |
| 200 | 377 | * @param mixed $value |
| 201 | 378 | * @param string $fieldName 'minValue' | 'maxValue' |
| 202 | - * @return float | |
| 379 | + * @return float | null | |
| 203 | 380 | * @throws ValidationException |
| 204 | 381 | */ |
| 205 | - private static function validateNumberValue($value, string $fieldName): float | |
| 382 | + private static function validateNumberValue($value, string $fieldName): ?float | |
| 206 | 383 | { |
| 207 | 384 | if ($value === '' || $value === null) { |
| 208 | - return 0.0; | |
| 385 | + return null; | |
| 209 | 386 | } |
| 210 | 387 | if (!is_numeric($value)) { |
| 211 | 388 | throw new ValidationException( |
| 212 | 389 | sprintf( |
