Refactor code

Author: Marvin Durot

modules/backend/behaviors/ListController.php

@@ -366,17 +366,16 @@ public function index_onDelete()
 
     /**
      * Bulk replicate records.
-     * @return void
-     * @throws \Winter\Storm\Exception\ApplicationException when the parent definition is missing.
+     * @throws \Winter\Storm\Exception\ApplicationException when the parent definition is missing or when replication fails due to validation errors.
      */
-    public function index_onReplicate()
+    public function index_onReplicate(): array
     {
-        if (method_exists($this->controller, 'onCopy')) {
-            return call_user_func_array([$this->controller, 'onCopy'], func_get_args());
+        if (method_exists($this->controller, 'onReplicate')) {
+            return call_user_func_array([$this->controller, 'onReplicate'], func_get_args());
         }
 
         /*
-         * Establish the list definition
+         * Establish the list replication definition
          */
         $definition = post('definition', $this->primaryDefinition);
 
@@ -386,6 +385,12 @@ public function index_onReplicate()
 
         $listConfig = $this->controller->listGetConfig($definition);
 
+        if (!isset($listConfig->replication)) {
+            throw new ApplicationException(Lang::get('backend::lang.list.missing_replication_definition', compact('definition')));
+        }
+
+        $replicationConfig = $this->makeConfig($listConfig->replication, ['enabled']);
+
         /*
          * Validate checked identifiers
          */
@@ -417,30 +422,44 @@ public function index_onReplicate()
         $this->controller->listExtendQuery($query, $definition);
 
         /*
-         * Retrieve protected columns from list column configuration
+         * If replication is enabled and neither is provided then
+         * we should default to looking at the model's fillable / guarded definitions
+         * (allowing explicit configuration in the config_list.yaml to overrule those values if desired).
          */
-        $columnConfig = $this->makeConfig($listConfig->list);
+        if (!$replicationConfig->enabled) {
+            throw new ApplicationException(Lang::get('backend::lang.list.replication_disabled'));
+        }
 
-        $protectedColumns = [];
+        if ($model->totallyGuarded()) {
+            $allowed = [];
+        } else {
+            $allowed = array_diff($model->getFillable(), $model->getGuarded());
+            }
 
-        foreach ($columnConfig as $column => $config) {
-            if (array_key_exists('protected', $config) && $config['protected'] === true) {
-                $protectedColumns[] = $column;
+        if (isset($replicationConfig->allowed)) {
+            $allowed = $replicationConfig->allowed;
             }
+        if (isset($replicationConfig->ignored)) {
+            $allowed = array_diff($allowed, $replicationConfig->ignored);
         }
 
         /*
-         * Copy records
+         * Replicate records
          */
         $records = $query->get();
 
         if ($records->count()) {
             try {
                 foreach ($records as $record) {
-                    $copy = $record->replicate($protectedColumns);
-                    $this->controller->listBeforeCopy($record);
-                    $copy->save();
-                    $this->controller->listAfterCopy($record);
+                    // Replicate the model without protected attributes
+                    $replicated = $record->replicate(
+                        array_diff($allowed, array_keys($record->getAttributes()))
+                    );
+                    $this->controller->listBeforeReplicate($replicated, $record);
+
+                    $replicated->save();
+
+                    $this->controller->listAfterReplicate($replicated, $record);
                 }
                 Flash::success(Lang::get(
                     (!empty($listConfig->replicateMessage))
@@ -568,18 +587,18 @@ public function listGetConfig(string $definition = null)
     //
 
     /**
-     * Called before a list record is copied.
+     * Called before a list record is replicated.
      * @param \Winter\Storm\Database\Model|\Winter\Storm\Halcyon\Model
      */
-    public function listBeforeCopy($model)
+    public function listBeforeReplicate($model, $original)
     {
     }
 
     /**
-     * Called after a list record is copied.
+     * Called after a list record is replicated.
      * @param \Winter\Storm\Database\Model|\Winter\Storm\Halcyon\Model
      */
-    public function listAfterCopy($model)
+    public function listAfterReplicate($model, $original)
     {
     }
 

modules/backend/lang/en/lang.php

@@ -209,6 +209,7 @@
         'missing_columns' => 'List used in :class has no list columns defined.',
         'missing_definition' => "List behavior does not contain a column for ':field'.",
         'missing_parent_definition' => "List behavior does not contain a definition for ':definition'.",
+        'missing_replication_definition' => "List behavior does not contain a definition for replication of ':definition'.",
         'behavior_not_ready' => 'List behavior has not been initialized, check that you have called makeLists() in your controller.',
         'invalid_column_datetime' => "Column value ':column' is not a DateTime object, are you missing a \$dates reference in the Model?",
         'pagination' => 'Displayed records: :from-:to of :total',
@@ -233,6 +234,7 @@
         'replicate_selected_confirm' => 'Duplicate the selected records?',
         'replicate_selected_failed' => 'An error has occured when duplicating records.',
         'replicate_selected_success' => 'Selected records has been duplicated.',
+        'replication_disabled' => 'Replication is disabled.',
         'column_switch_true' => 'Yes',
         'column_switch_false' => 'No',
     ],

modules/backend/lang/fr/lang.php

@@ -209,6 +209,7 @@
         'missing_columns' => 'La liste utilisée dans la classe :class n\'a pas de colonne de liste définie.',
         'missing_definition' => 'La liste utilisée ne contient de pas de colonne pour le champ ":field".',
         'missing_parent_definition' => "Le behavior List ne contient pas de définition pour ':definition'.",
+        'missing_replication_definition' => "Le behavior List ne contient pas de définition pour la replication de ':definition'.",
         'behavior_not_ready' => 'La liste utilisée n\'a pas été initialisée, vérifier que la méthode d\'appel de makeLists() a été soumise au contrôleur.',
         'invalid_column_datetime' => 'La valeur de la colonne ":column" n\'est pas un objet DateTime, manque-t-il une référence dans la propriété \$dates du modèle ?',
         'pagination' => 'Enregistrements affichés : :from-:to sur :total',
@@ -226,13 +227,14 @@
         'check' => 'Sélectionner',
         'delete_selected' => 'Supprimer la sélection',
         'delete_selected_empty' => 'Il n\'y a aucun enregistrement à supprimer',
-        'delete_selected_confirm' => 'Confirmer la suppression des enregistrements sélectionnés ?',
+        'delete_selected_confirm' => 'Confirmer la suppression des eanregistrements sélectionnés ?',
         'delete_selected_success' => 'Les enregistrements ont été supprimés.',
         'replicate_selected' => 'Dupliquer la sélection',
         'replicate_selected_empty' => 'Il n\'y a aucun enregistrement à dupliquer',
         'replicate_selected_confirm' => 'Confirmer la duplication des enregistrements sélectionnés ?',
         'replicate_selected_success' => 'Les enregistrements ont été dupliqués.',
         'replicate_selected_failed' => 'Une erreur s\'est produite pendant la duplication des enregistrements.',
+        'replication_disabled' => 'La réplication est désactivée.',
         'column_switch_true' => 'Oui',
         'column_switch_false' => 'Non'
     ],