← All changes | backend/src/Factory/Field/FieldFactory.php +130 -14 0.8.1 → 1.5.1 View file →

		@@ -1,19 +1,16 @@
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;
16	13	use IvyForms\ValueObjects\Field\ConfirmationGeneralSettings;
17	14	use IvyForms\ValueObjects\Field\TimeFieldGeneralSettings;
18	15	use IvyForms\ValueObjects\Field\DateFieldGeneralSettings;
19	16
		@@ -32,9 +29,9 @@
32	29	* @throws ValidationException
33	30	*/
34	31	public static function create(array $data): FieldEntity
35	32	{
36		- $settings = isset($data['settings']) ? json_decode($data['settings'], true) : [];
	33	+ $settings = self::parseSettings($data['settings'] ?? null);
37	34
38	35	if (!empty($settings)) {
39	36	$data['hideLabel'] = $settings['hideLabel'] ?? false;
40	37	$data['readOnly'] = $settings['readOnly'] ?? false;
		@@ -41,8 +38,9 @@
41	38	$data['description'] = $settings['description'] ?? '';
42	39	$data['requiredMessage'] = $settings['requiredMessage'] ?? '';
43	40	$data['cssClasses'] = $settings['cssClasses'] ?? '';
44	41	$data['limitMaxLength'] = $settings['limitMaxLength'] ?? false;
	42	+ $data['limitRange'] = $settings['limitRange'] ?? false;
45	43	$data['maxLength'] = $settings['maxLength'] ?? 255;
46	44	$data['labelPosition'] = $settings['labelPosition'] ?? 'default';
47	45	$data['noDuplicates'] = $settings['noDuplicates'] ?? false;
48	46	$data['shuffleOptions'] = $settings['shuffleOptions'] ?? false;
		@@ -57,17 +55,33 @@
57	55	$data['phoneAutoDetect'] = $settings['phoneAutoDetect'] ?? false;
58	56	$data['minValue'] = $settings['minValue'] ?? null;
59	57	$data['maxValue'] = $settings['maxValue'] ?? null;
60	58	$data['step'] = $settings['step'] ?? 1;
	59	+ $data['showGrid'] = $settings['showGrid'] ?? false;
61	60	$data['numberFormat'] = $settings['numberFormat'] ?? '';
62	61	$data['inputPrefix'] = $settings['inputPrefix'] ?? '';
63	62	$data['inputSuffix'] = $settings['inputSuffix'] ?? '';
64	63	$data['timeFieldType'] = $settings['timeFieldType'] ?? '';
65	64	$data['timeFormat'] = $settings['timeFormat'] ?? '';
	65	+ $data['minTimeValue'] = $settings['minTimeValue'] ?? '';
	66	+ $data['maxTimeValue'] = $settings['maxTimeValue'] ?? '';
66	67	$data['dateFieldType'] = $settings['dateFieldType'] ?? '';
67	68	$data['dateFormat'] = $settings['dateFormat'] ?? '';
68	69	$data['minDateValue'] = $settings['minDateValue'] ?? '';
69	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	+ }
70	84	// Grid layout: prioritize direct database columns over settings JSON
71	85	// This ensures backward compatibility while preferring the dedicated columns
72	86	$data['rowIndex'] = $data['rowIndex'] ?? ($settings['rowIndex'] ?? 0);
73	87	$data['columnIndex'] = $data['columnIndex'] ?? ($settings['columnIndex'] ?? 0);
		@@ -77,10 +91,34 @@
77	91	: true;
78	92	if ($data['visible'] === null) {
79	93	$data['visible'] = true;
80	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	+ }
81	103	}
82	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	+
83	121	/**
84	122	* Allows modification of the settings data before creating the Field entity.
85	123	* This filter runs for both:
86	124	* - Fields loaded from database (settings from JSON string)
		@@ -91,8 +129,9 @@
91	129	* @param mixed[] $settings The settings array (from database or empty for API).
92	130	* @return mixed[] The modified field data.
93	131	*/
94	132	$data = apply_filters('ivyforms/field/factory/extract_settings', $data, $settings);
	133	+
95	134	$generalSettings = new FieldGeneralSettings(
96	135	self::validateString($data['label'] ?? '', 255, 'label'),
97	136	self::validateBool($data['required'] ?? false),
98	137	self::validateString($data['placeholder'] ?? '', 255, 'placeholder'),
		@@ -97,9 +136,9 @@
97	136	self::validateBool($data['required'] ?? false),
98	137	self::validateString($data['placeholder'] ?? '', 255, 'placeholder'),
99	138	self::validateBool($data['hideLabel'] ?? false),
100	139	self::validateBool($data['readOnly'] ?? false),
101		- self::validateString($data['description'] ?? '', 255, 'description'),
	140	+ self::validateString($data['description'] ?? '', 1000, 'description'),
102	141	self::validateString($data['requiredMessage'] ?? '', 255, 'requiredMessage'),
103	142	self::validateString($data['cssClasses'] ?? '', 255, 'cssClasses'),
104	143	self::validateBool($data['shuffleOptions'] ?? false),
105	144	self::validateBool($data['showValues'] ?? false),
		@@ -108,8 +147,9 @@
108	147	self::validateBool($data['phoneAutoDetect'] ?? false),
109	148	self::validateNumberValue($data['minValue'] ?? null, 'minValue'),
110	149	self::validateNumberValue($data['maxValue'] ?? null, 'maxValue'),
111	150	self::validateStep($data['step'] ?? 1),
	151	+ self::validateBool($data['showGrid'] ?? false),
112	152	self::validateNumberFormat($data['numberFormat'] ?? ''),
113	153	new ConfirmationGeneralSettings(
114	154	self::validateBool($data['confirmFieldEnabled'] ?? false),
115	155	self::validateString(
		@@ -124,29 +164,47 @@
124	164	),
125	165	self::validateBool($data['confirmFieldHideLabel'] ?? false)
126	166	),
127	167	new TimeFieldGeneralSettings(
	168	+ self::validateBool($data['limitTimeRange'] ?? false),
128	169	self::validateString($data['timeFieldType'] ?? '', 50, 'timeFieldType'),
129		- self::validateString($data['timeFormat'] ?? '', 50, 'timeFormat')
	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,
130	175	),
131	176	new DateFieldGeneralSettings(
	177	+ self::validateBool($data['limitDateRange'] ?? false),
132	178	self::validateString($data['dateFieldType'] ?? '', 50, 'dateFieldType'),
133	179	self::validateString($data['dateFormat'] ?? '', 50, 'dateFormat'),
134	180	isset($data['minDateValue']) && $data['minDateValue'] !== '' ?
135	181	self::validateString($data['minDateValue'], 255, 'minDateValue') : null,
136	182	isset($data['maxDateValue']) && $data['maxDateValue'] !== '' ?
137		- self::validateString($data['maxDateValue'], 255, 'maxDateValue') : null
	183	+ self::validateString($data['maxDateValue'], 255, 'maxDateValue') : null,
138	184	),
139		- self::validateBool($data['visible'] ?? true)
	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),
140	190	);
141	191	$advancedSettings = new FieldAdvancedSettings(
142		- self::validateString($data['defaultValue'] ?? '', 255, 'defaultValue'),
	192	+ self::resolveDefaultValue($data),
143	193	self::validateBool($data['limitMaxLength'] ?? false),
144	194	(int)($data['maxLength'] ?? 255),
145	195	self::validateString($data['labelPosition'] ?? '', 255, 'labelPosition'),
146	196	self::validateBool($data['noDuplicates'] ?? false),
147	197	self::validateString($data['inputPrefix'] ?? '', 255, 'inputPrefix'),
148		- self::validateString($data['inputSuffix'] ?? '', 255, 'inputSuffix')
	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	+ )
149	207	);
150	208	$fieldOptions = new FieldOptions($data['options'] ?? []);
151	209
152	210	$fieldObject = new Field(
		@@ -161,9 +219,10 @@
161	219	$data['parentId'] ?? null,
162	220	$data['rows'] ?? 0,
163	221	$data['rowIndex'] ?? 0,
164	222	$data['columnIndex'] ?? 0,
165		- $data['width'] ?? 100
	223	+ $data['width'] ?? 100,
	224	+ $data['pageId'] ?? null
166	225	);
167	226
168	227	/**
169	228	* Allows setting of additional properties for the Field value object.
		@@ -200,8 +259,12 @@
200	259	if (isset($data['parentId'])) {
201	260	$field->setParentId($data['parentId']);
202	261	}
203	262
	263	+ if (isset($data['pageId'])) {
	264	+ $field->setPageId($data['pageId']);
	265	+ }
	266	+
204	267	if (isset($data['rows'])) {
205	268	$field->setRows((int)$data['rows']);
206	269	}
207	270
		@@ -212,12 +275,40 @@
212	275	* @param FieldEntity $field The current field data.
213	276	* @param mixed[] $data The settings array from the database.
214	277	* @return mixed[] The modified field data.
215	278	*/
216		- return apply_filters('ivyforms/field/entity/set_properties', $field, $data);
	279	+ $field = apply_filters('ivyforms/field/entity/set_properties', $field, $data);
	280	+
	281	+ if (!empty($data['nameFieldType'])) {
	282	+ $field->setAdditionalProperty('nameFieldType', (string)$data['nameFieldType']);
	283	+ }
	284	+ if (array_key_exists('subFieldIndex', $data) && $data['subFieldIndex'] !== null) {
	285	+ $field->setAdditionalProperty('subFieldIndex', (int)$data['subFieldIndex']);
	286	+ }
	287	+
	288	+ return $field;
217	289	}
218	290
219	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;
	299	+ }
	300	+
	301	+ if (!is_string($rawSettings) || $rawSettings === '') {
	302	+ return [];
	303	+ }
	304	+
	305	+ $decoded = json_decode($rawSettings, true);
	306	+
	307	+ return is_array($decoded) ? $decoded : [];
	308	+ }
	309	+
	310	+ /**
220	311	* Validate and convert a value to boolean.
221	312	*
222	313	* @param mixed $value The value to validate.
223	314	*
		@@ -225,8 +316,33 @@
225	316	*/
226	317	private static function validateBool($value): bool
227	318	{
228	319	return (bool)$value;
	320	+ }
	321	+
	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');
229	345	}
230	346
231	347	/**
232	348	* Validate a string's length.