[4.0] Migrate data for repeatable fields (#32611)

Author: joomdonation

administrator/components/com_admin/script.php

@@ -236,7 +236,7 @@ protected function updateDatabaseMysql()
 	protected function uninstallRepeatableFieldsPlugin()
 	{
 		$app = Factory::getApplication();
-		$db = Factory::getDbo();
+		$db  = Factory::getDbo();
 
 		// Check if the plg_fields_repeatable plugin is present
 		$extensionId = $db->setQuery(
@@ -285,10 +285,16 @@ protected function uninstallRepeatableFieldsPlugin()
 				 * holds the `fieldparams` of the `repeatable` type, $newFieldparams shall hold the `fieldparams`
 				 * of the `subfields` type.
 				 */
-				$newFieldparams = array(
+				$newFieldparams = [
 					'repeat'  => '1',
-					'options' => array(),
-				);
+					'options' => [],
+				];
+
+				/**
+				 * This array is used to store the mapping between the name of form fields from Repeatable field
+				 * with ID of the child-fields. It will then be used to migrate data later
+				 */
+				$mapping = [];
 
 				// If this repeatable fields actually had child-fields (normally this is always the case)
 				if (isset($oldFieldparams->fields) && is_object($oldFieldparams->fields))
@@ -311,24 +317,24 @@ protected function uninstallRepeatableFieldsPlugin()
 							 * of the `repeatable` instance. This is what we use $data for, we create a new custom field
 							 * for each of the sub fields of the `repeatable` instance.
 							 */
-							$data = array(
-								'context'       => $row->context,
-								'group_id'      => $row->group_id,
-								'title'         => $oldField->fieldname,
-								'name'          => (
+							$data = [
+								'context'          => $row->context,
+								'group_id'         => $row->group_id,
+								'title'            => $oldField->fieldname,
+								'name'             => (
 									$fieldname_prefix
 									. $oldField->fieldname
 									. ($fieldname_suffix > 0 ? ('_' . $fieldname_suffix) : '')
 								),
-								'label'         => $oldField->fieldname,
-								'default_value' => $row->default_value,
-								'type'          => $oldField->fieldtype,
-								'description'   => $row->description,
-								'state'         => '1',
-								'params'        => $row->params,
-								'language'      => '*',
+								'label'            => $oldField->fieldname,
+								'default_value'    => $row->default_value,
+								'type'             => $oldField->fieldtype,
+								'description'      => $row->description,
+								'state'            => '1',
+								'params'           => $row->params,
+								'language'         => '*',
 								'assigned_cat_ids' => [-1],
-							);
+							];
 
 							// `number` is not a valid custom field type, so use `text` instead.
 							if ($data['type'] == 'number')
@@ -381,12 +387,14 @@ protected function uninstallRepeatableFieldsPlugin()
 						}
 
 						// And tell our new `subfields` field about his child
-						$newFieldparams['options'][('option' . $newFieldCount)] = array(
+						$newFieldparams['options'][('option' . $newFieldCount)] = [
 							'customfield'   => $subfield_id,
 							'render_values' => '1',
-						);
+						];
 
 						$newFieldCount++;
+
+						$mapping[$oldField->fieldname] = 'field' . $subfield_id;
 					}
 				}
 
@@ -398,6 +406,67 @@ protected function uninstallRepeatableFieldsPlugin()
 						->set($db->quoteName('fieldparams') . ' = ' . $db->quote(json_encode($newFieldparams)))
 						->where($db->quoteName('id') . ' = ' . $db->quote($row->id))
 				)->execute();
+
+				// Migrate data for this field
+				$query = $db->getQuery(true)
+					->select('*')
+					->from($db->quoteName('#__fields_values'))
+					->where($db->quoteName('field_id') . ' = ' . $row->id);
+				$db->setQuery($query);
+
+				foreach ($db->loadObjectList() as $rowFieldValue)
+				{
+					// Do not do the version if no data is entered for the custom field this item
+					if (!$rowFieldValue->value)
+					{
+						continue;
+					}
+
+					/**
+					 * Here we will have to update the stored value of the field to new format
+					 * The key for each row changes from repeatable to row, for example repeatable0 to row0, and so on
+					 * The key for each sub-field change from name of field to field + ID of the new sub-field
+					 * Example data format stored in J3: {"repeatable0":{"id":"1","username":"admin"}}
+					 * Example data format stored in J4: {"row0":{"field1":"1","field2":"admin"}}
+					 */
+					$newFieldValue = [];
+
+					// Convert to array to change key
+					$fieldValue = json_decode($rowFieldValue->value, true);
+
+					// If data could not be decoded for some reason, ignore
+					if (!$fieldValue)
+					{
+						continue;
+					}
+
+					foreach ($fieldValue as $rowKey => $rowValue)
+					{
+						$rowKey                 = str_replace('repeatable', 'row', $rowKey);
+						$newFieldValue[$rowKey] = [];
+
+						foreach ($rowValue as $subFieldName => $subFieldValue)
+						{
+							if (isset($mapping[$subFieldName]))
+							{
+								$newFieldValue[$rowKey][$mapping[$subFieldName]] = $subFieldValue;
+							}
+							else
+							{
+								// Not found, use the old key to avoid data lost
+								$newFieldValue[$subFieldName] = $subFieldValue;
+							}
+						}
+					}
+
+					$query->clear()
+						->update($db->quoteName('#__fields_values'))
+						->set($db->quoteName('value') . ' = ' . $db->quote(json_encode($newFieldValue)))
+						->where($db->quoteName('field_id') . ' = ' . $rowFieldValue->field_id)
+						->where($db->quoteName('item_id') . ' =' . $rowFieldValue->item_id);
+					$db->setQuery($query)
+						->execute();
+				}
 			}
 
 			// Now, unprotect the plugin so we can uninstall it