feat: add UserDefinedForm field for integration

fullscreeninteractive · Dec 13, 2021 · 4ffc651 · 4ffc651
1 parent 454f8b1
commit 4ffc651
Show file tree

Hide file tree

Showing 4 changed files with 404 additions and 2 deletions.
diff --git a/src/EditableManyField.php b/src/EditableManyField.php
@@ -0,0 +1,235 @@
+<?php
+
+namespace FullscreenInteractive\ManyField;
+
+use Dotenv\Exception\ValidationException;
+use SilverStripe\Forms\GridField\GridField;
+use FullscreenInteractive\ManyField\ManyField;
+use SilverStripe\Assets\Upload;
+use SilverStripe\Forms\FieldList;
+use SilverStripe\Forms\GridField\GridFieldButtonRow;
+use SilverStripe\Forms\GridField\GridFieldConfig;
+use SilverStripe\Forms\GridField\GridFieldDeleteAction;
+use SilverStripe\Forms\GridField\GridFieldDetailForm;
+use SilverStripe\Forms\GridField\GridFieldEditButton;
+use SilverStripe\Forms\GridField\GridFieldPaginator;
+use SilverStripe\Forms\GridField\GridFieldToolbarHeader;
+use SilverStripe\UserForms\Extension\UserFormFileExtension;
+use SilverStripe\UserForms\Form\GridFieldAddClassesButton;
+use SilverStripe\UserForms\Model\EditableFormField;
+use SilverStripe\UserForms\Model\EditableFormField\EditableFileField;
+use SilverStripe\UserForms\Model\EditableFormField\EditableTextField;
+use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
+
+if (class_exists(EditableFormField::class)) {
+    return;
+}
+
+class EditableManyField extends EditableFormField
+{
+    private static $singular_name = 'Repeater Field';
+
+    private static $plural_name = 'Repeater Fields';
+
+    private static $db = [];
+
+    private static $table_name = 'EditableManyField';
+
+    private static $many_many = [
+        'Children' => EditableFormField::class
+    ];
+
+    private static $owns = [
+        'Children'
+    ];
+
+    private static $cascade_deletes = [
+        'Children'
+    ];
+
+    private static $cascade_duplicates = [
+        'Children'
+    ];
+
+    /**
+     * @return FieldList
+     */
+    public function getCMSFields()
+    {
+        $this->beforeUpdateCMSFields(function (FieldList $fields) {
+            $editableColumns = new GridFieldEditableColumns();
+            $fieldClasses = singleton(EditableFormField::class)->getEditableFieldClasses();
+            $editableColumns->setDisplayFields([
+                'ClassName' => function ($record, $column, $grid) use ($fieldClasses) {
+                    if ($record instanceof EditableFormField) {
+                        $field = $record->getInlineClassnameField($column, $fieldClasses);
+                        if ($record instanceof EditableFileField) {
+                            $field->setAttribute('data-folderconfirmed', $record->FolderConfirmed ? 1 : 0);
+                        }
+                        return $field;
+                    }
+                },
+                'Title' => function ($record, $column, $grid) {
+                    if ($record instanceof EditableFormField) {
+                        return $record->getInlineTitleField($column);
+                    }
+                }
+            ]);
+
+            $config = GridFieldConfig::create()
+                ->addComponents(
+                    $editableColumns,
+                    new GridFieldButtonRow(),
+                    (new GridFieldAddClassesButton(EditableTextField::class))
+                        ->setButtonName(_t(__CLASS__ . '.ADD_FIELD', 'Add Field'))
+                        ->setButtonClass('btn-primary'),
+                    (new GridFieldAddClassesButton(EditableFormStep::class))
+                        ->setButtonName(_t(__CLASS__ . '.ADD_PAGE_BREAK', 'Add Page Break'))
+                        ->setButtonClass('btn-secondary'),
+                    (new GridFieldAddClassesButton([EditableFieldGroup::class, EditableFieldGroupEnd::class]))
+                        ->setButtonName(_t(__CLASS__ . '.ADD_FIELD_GROUP', 'Add Field Group'))
+                        ->setButtonClass('btn-secondary'),
+                    $editButton = new GridFieldEditButton(),
+                    new GridFieldDeleteAction(),
+                    new GridFieldToolbarHeader(),
+                    new GridFieldOrderableRows('Sort'),
+                    new GridFieldDetailForm(),
+                    // Betterbuttons prev and next is enabled by adding a GridFieldPaginator component
+                    new GridFieldPaginator(999)
+                );
+
+            $fields->addFieldsToTab('Root.Main', [
+                GridField::create(
+                    'Children',
+                    'Children',
+                    $this->Children(),
+                    $config
+                )
+            ]);
+        });
+
+        return parent::getCMSFields();
+    }
+
+    /**
+     * Return the form field
+     *
+     */
+    public function getFormField()
+    {
+        $children = [];
+        foreach ($this->Children() as $editableFormField) {
+            $children[] = $editableFormField->getFormField();
+        }
+
+        $field = ManyField::create($this->Name, FieldList::create($children))
+            ->setCanSort(false)
+            ->setMinRecords(1);
+
+        $this->doUpdateFormField($field);
+
+        return $field;
+    }
+
+
+    public function getSubmittedFormField(): SubmittedManyFormField
+    {
+        return SubmittedManyFormField::create();
+    }
+
+
+    /**
+     * When saving this data from the front end, extract the array and
+     * create the children records
+     */
+    public function getValueFromData($data)
+    {
+        $incoming = isset($data[$this->Name]) ? $data[$this->Name] : false;
+
+        if (!$incoming) {
+            return json_encode([]);
+        }
+
+        // unset any rows which don't have any values at all
+        $rowHasValue = [];
+
+        foreach ($this->Children() as $field)
+        {
+            foreach ($incoming[$field->Name] as $i => $value) {
+                if ($value && !empty($value)) {
+                    $rowHasValue[$i] = true;
+                }
+            }
+        }
+
+        $rows = [];
+
+        foreach ($this->Children() as $field)
+        {
+            foreach ($incoming[$field->Name] as $i => $value) {
+                if (!isset($rowHasValue[$i])) {
+                    // empty row;
+                    continue;
+                }
+
+                if (!isset($rows[$i])) {
+                    $rows[$i] = [];
+                }
+
+                $submittedField = $this->createNestedSubmittedFormField($field, [
+                    $field->Name => $value
+                ]);
+
+                $rows[$i][$field->Name] = $submittedField->ID;
+            }
+        }
+
+        return json_encode($rows);
+    }
+
+
+    public function createNestedSubmittedFormField(EditableFormField $field, $data)
+    {
+        $submittedField = $field->getSubmittedFormField();
+        $submittedField->Name = $field->Name;
+        $submittedField->Title = $field->getField('Title');
+
+        // save the value from the data
+        if ($field->hasMethod('getValueFromData')) {
+            $submittedField->Value = $field->getValueFromData($data);
+        } else {
+            if (isset($data[$field->Name])) {
+                $submittedField->Value = $data[$field->Name];
+            }
+        }
+
+        if (!empty($data[$field->Name])) {
+            if (in_array(EditableFileField::class, $field->getClassAncestry())) {
+                if (!empty($_FILES[$field->Name]['name'])) {
+                    $foldername = $field->getFormField()->getFolderName();
+                    $upload = Upload::create();
+
+                    try {
+                        $upload->loadIntoFile($_FILES[$field->Name], null, $foldername);
+
+                        /** @var AssetContainer|File $file */
+                        $file = $upload->getFile();
+                        $file->ShowInSearch = 0;
+                        $file->UserFormUpload = UserFormFileExtension::USER_FORM_UPLOAD_TRUE;
+                        $file->write();
+
+                        $submittedField->UploadedFileID = $file->ID;
+                    } catch (ValidationException $e) {
+
+                    }
+                }
+            }
+        }
+
+        $submittedField->extend('onPopulationFromField', $field);
+        $submittedField->write();
+
+        return $submittedField;
+    }
+}
diff --git a/src/ManyField.php b/src/ManyField.php
@@ -610,7 +610,7 @@ protected function updateManyNestedField($field, $index, $value, $prefixName) {
                 }
             }
         } else {
-            if ($value && $value->hasMethod($name)) {
+            if ($value && is_object($value) && $value->hasMethod($name)) {
                 $field->setValue($value->{$name}(), $value);
             } else if (is_object($value)) {
                 $field->setValue($value->{$name}, $value);
@@ -660,7 +660,7 @@ public function generateRow($index, $value = null, $prefixName = true)
             $field = $field->setReadonly($this->readonly);
             $field = $field->setDisabled($this->readonly);
 
-            if ($value && $value->hasMethod('modifyManyRecordField')) {
+            if ($value && is_object($value) && $value->hasMethod('modifyManyRecordField')) {
                 $field = $value->modifyManyRecordField($field);
             }