Documentation, send js events for UI to pick up

wilr · wilr · commit 372dec66169f · 2019-05-14T14:23:02.000+12:00
diff --git a/README.md b/README.md
@@ -3,10 +3,14 @@
 [![Version](http://img.shields.io/packagist/v/fullscreeninteractive/silverstripe-manyfield.svg)](https://packagist.org/packages/fullscreeninteractive/silverstripe-manyfield)
 [![License](http://img.shields.io/packagist/l/fullscreeninteractive/silverstripe-manyfield.svg)](license.md)
 
-A reusable approach to a form field which allows you to create and delete rows.
+A reusable approach to a form field which allows you to create and delete rows 
+in Forms.
+
+This is designed to work on the front-end with limited javascript (i.e it does 
+not require `GridField` or entwine).
 
 Each row can relate to a DataObject subclass or simply to be used to capture the
-data
+data as an array.
 
 ## Installation
 
@@ -31,4 +35,47 @@ $fields = new FieldList(
 );
 ```
 
-Data will either be saved as `setSwabList($data)`, `SwabList` database field or in the `SwabList` relation.
+Data will either be saved as `setSwabList($data)`, `SwabList` database field or 
+in the `SwabList` relation. If you are saving into a relation such as `HasMany`
+or `ManyMany` list then make sure you include a hidden field in your field list.
+
+```
+    $many = ManyField::create('SwabList', [
+        HiddenField::create('ID', ''),
+        TextField::create('Swab'),
+        TextField::create('TestSite'),
+        TextField::create('Description'),
+        TextField::create('Material')
+    ]);
+```
+
+## Sorting
+
+Include a Hidden field `Sort` and make sure sorting is enabled.
+
+```
+    $many = ManyField::create('SwabList', [
+        HiddenField::create('ID', ''),
+        HiddenField::create('Sort', ''),
+        TextField::create('TestSite')
+    ])->setCanSort(true);
+```
+
+## Required Fields
+
+    $many = ManyField::create('SwabList', [
+        TextField::create('TestSite')->setRequired(true)
+    ])->setCanSort(true);
+
+## Javascript Events
+
+If you have UI handlers that need to run when fields are added or removed 
+(such as Date Pickers) create a handler on your `<body>` element and listen for
+either:
+
+* `manyFieldAdded`
+* `manyFieldRemoved`
+
+## Licence
+
+BSD 3-Clause License
diff --git a/client/js/ManyField.src.js b/client/js/ManyField.src.js
@@ -42,13 +42,21 @@
         parents.find('.manyfield__row').last().after(data)
 
         wrapManyFields()
+
+        $('body').trigger('manyFieldAdded', {
+          parents
+        })
       })
     })
 
     $('body').on('click', '.manyfield__remove', function() {
       var parent = $(this).parents('.manyfield__row')
 
       parent.remove()
+
+      $('body').trigger('manyFieldRemoved', {
+        parent
+      })
     })
   })
 })(jQuery)
diff --git a/src/ManyField.php b/src/ManyField.php
@@ -268,6 +268,17 @@ public function AddLink()
         );
     }
 
+    public function setValue($value, $data = null)
+    {
+        if (!$value && $data) {
+            if ($data->hasMethod($this->name)) {
+                $value = $data->{$this->name}();
+            }
+        }
+
+        parent::setValue($value, $data);
+    }
+
     /**
      * Return the list of fields. We'll create a row for each of the values if
      * they exist otherwise we'll only return
@@ -277,8 +288,9 @@ public function AddLink()
     public function FieldList() {
         $output = FieldList::create();
         $index = 0;
-
+        
         if ($this->value) {
+
             foreach ($this->value as $record) {
                 $output->push($this->generateRow($index++, $record));
             }
@@ -305,6 +317,7 @@ public function generateRow($index, $value = null)
         foreach ($this->manyChildren as $child) {
             $field = clone $child;
             $field->name = $this->name . '['.$child->name . ']['. $index . ']';
+            $field->setValue(($value) ? $value->{$child->name} : null);
 
             if (isset($this->fieldCallbacks[$child->name])) {
                 call_user_func($this->fieldCallbacks[$name], $field, $index, $this);
@@ -385,16 +398,28 @@ public function updateRelation(DataObjectInterface $record, $delete = true)
         }
 
         foreach ($updatedData as $key => $data) {
+            // if all data is empty then skip adding this record.
+            $empty = array_filter($data);
+
+            if (empty($empty)) {
+                continue;
+            }
+
+            // if mapped to an existing record then find and update.
+            $record = null;
+
             if (isset($idKeyMap[$key])) {
                 $record = $existing->find('ID', $idKeyMap[$key]);
-                
+            }
+            
+            if ($record) {
                 $record->update($data);
                 $record->write();
             } else {
                 $create = Injector::inst()->create($existing->dataClass());
                 $create->update($data);
-
                 $create->write();
+
                 $existing->add($create);
             }
         }
