Refactored HandleRepeaters trait (#537)

area17 · Feb 13, 2020 · 136e712 · 136e712
1 parent 467c28a
commit 136e712
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 28 deletions.
diff --git a/src/Repositories/Behaviors/HandleRepeaters.php b/src/Repositories/Behaviors/HandleRepeaters.php
@@ -9,26 +9,36 @@
 
 trait HandleRepeaters
 {
+    /**
+     * All repeaters used in the model, as an array of repeater names: 
+     * [
+     *  'article_repeater',
+     *  'page_repeater'
+     * ].
+     * 
+     * When only the repeater name is given here, its model and relation will be inferred from the name.
+     * Each repeater's detail can also be override with an array
+     * [
+     *  'article_repeater',
+     *  'page_repeater' => [
+     *      'model' => 'Page',
+     *      'relation' => 'pages'
+     *  ]
+     * ]
+     *
+     * @var string|array(array)|array(mix(string|array))
+     */
+    protected $repeaters = [];
+
     /**
      * @param \A17\Twill\Models\Model $object
      * @param array $fields
      * @return void
      */
     public function afterSaveHandleRepeaters($object, $fields)
     {
-        if (property_exists($this, 'repeaters')) {
-            foreach ($this->repeaters as $moduleKey => $module) {
-                if (is_string($module)) {
-                    $model = Str::studly(Str::singular($module));
-                    $repeaterName = Str::singular($module);
-                    $this->updateRepeater($object, $fields, $module, $model, $repeaterName);
-                } elseif (is_array($module)) {
-                    $relation = !empty($module['relation']) ? $module['relation'] : $moduleKey;
-                    $model = isset($module['model']) ? $module['model'] : Str::studly(Str::singular($moduleKey));
-                    $repeaterName = !empty($module['repeaterName']) ? $module['repeaterName'] : Str::singular($moduleKey);
-                    $this->updateRepeater($object, $fields, $relation, $model, $repeaterName);
-                }
-            }
+        foreach ($this->getRepeaters() as $repeater) {
+            $this->updateRepeater($object, $fields, $repeater['relation'], $repeater['model'], $repeater['repeaterName']);
         }
     }
 
@@ -39,21 +49,10 @@ public function afterSaveHandleRepeaters($object, $fields)
      */
     public function getFormFieldsHandleRepeaters($object, $fields)
     {
-        if (property_exists($this, 'repeaters')) {
-            foreach ($this->repeaters as $moduleKey => $module) {
-                if (is_string($module)) {
-                    $model = Str::studly(Str::singular($module));
-                    $repeaterName = Str::singular($module);
-                    $fields = $this->getFormFieldsForRepeater($object, $fields, $module, $model, $repeaterName);
-                } elseif (is_array($module)) {
-                    $model = isset($module['model']) ? $module['model'] : Str::studly(Str::singular($moduleKey));
-                    $relation = !empty($module['relation']) ? $module['relation'] : $moduleKey;
-                    $repeaterName = !empty($module['repeaterName']) ? $module['repeaterName'] : Str::singular($moduleKey);
-                    $fields = $this->getFormFieldsForRepeater($object, $fields, $relation, $model, $repeaterName);
-                }
-            }
+        foreach ($this->getRepeaters() as $repeater) {
+            $fields = $this->getFormFieldsForRepeater($object, $fields, $repeater['relation'], $repeater['model'], $repeater['repeaterName']);
         }
-
+        
         return $fields;
     }
 
@@ -125,6 +124,17 @@ public function updateRepeaterMorphMany($object, $fields, $relation, $morph = nu
         }
     }
 
+    /**
+     * Given relation, model and repeaterName, retrieve the repeater data from request and update the database record.
+     *
+     * @param  object $object
+     * @param  array $fields
+     * @param  string $relation
+     * @param  string $model
+     * @param  string $repeaterName
+     *
+     * @return void
+     */
     public function updateRepeater($object, $fields, $relation, $model = null, $repeaterName = null)
     {
         if (!$repeaterName) {
@@ -174,6 +184,17 @@ public function updateRepeater($object, $fields, $relation, $model = null, $repe
         }
     }
 
+    /**
+     * Given relation, model and repeaterName, get the necessary fields for rendering a repeater
+     *
+     * @param  object $object
+     * @param  array $fields
+     * @param  string $relation
+     * @param  string $model
+     * @param  string $repeaterName
+     *
+     * @return array
+     */
     public function getFormFieldsForRepeater($object, $fields, $relation, $model = null, $repeaterName = null)
     {
         if (!$repeaterName) {
@@ -268,4 +289,46 @@ public function getFormFieldsForRepeater($object, $fields, $relation, $model = n
 
         return $fields;
     }
+
+    /**
+     * Get all repeaters' model and relation from the $repeaters attribute. 
+     * The missing information will be inferred by convention of Twill.
+     *
+     * @return Illuminate\Support\Collection
+     */
+    protected function getRepeaters()
+    {
+        return collect($this->repeaters)->map(function ($repeater, $key) {
+            $repeaterName = is_string($repeater) ? $repeater : $key;
+            return [
+                'relation' => !empty($repeater['relation']) ? $repeater['relation'] : $this->inferRelationFromRepeaterName($repeaterName),
+                'model' => !empty($repeater['model']) ? $repeater['model'] : $this->inferModelFromRepeaterName($repeaterName),
+                'repeaterName' => $repeaterName
+            ];
+        })->values();
+    }
+
+    /**
+     * The relation name shoud be lower camel case, ex. userGroup, contactOffice
+     *
+     * @param  string $repeaterName
+     *
+     * @return string
+     */
+    protected function inferRelationFromRepeaterName(string $repeaterName): string
+    {
+        return Str::camel($repeaterName);
+    }
+
+    /**
+     * The model name should be singular upper camel case, ex. User, ArticleType
+     *
+     * @param  string $repeaterName
+     *
+     * @return string
+     */
+    protected function inferModelFromRepeaterName(string $repeaterName): string
+    {
+        return Str::studly(Str::singular($repeaterName));
+    }
 }
diff --git a/src/Repositories/ModuleRepository.php b/src/Repositories/ModuleRepository.php
@@ -6,6 +6,7 @@
 use A17\Twill\Models\Behaviors\Sortable;
 use A17\Twill\Repositories\Behaviors\HandleDates;
 use A17\Twill\Repositories\Behaviors\HandleBrowsers;
+use A17\Twill\Repositories\Behaviors\HandleRepeaters;
 use A17\Twill\Repositories\Behaviors\HandleFieldsGroups;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
@@ -18,7 +19,7 @@
 
 abstract class ModuleRepository
 {
-    use HandleDates, HandleBrowsers, HandleFieldsGroups;
+    use HandleDates, HandleBrowsers, HandleRepeaters, HandleFieldsGroups;
 
     /**
      * @var \A17\Twill\Models\Model