Use an embedded Form widget to process FileUpload properties

Fixes #2168, #3097. Related: https://github.com/rainlab/translate-plugin/pull/442

modules/backend/formwidgets/FileUpload.php

@@ -1,9 +1,11 @@
 <?php namespace Backend\FormWidgets;
 
+use Db;
 use Input;
 use Request;
 use Response;
 use Validator;
+use Backend\Widgets\Form;
 use Backend\Classes\FormField;
 use Backend\Classes\FormWidgetBase;
 use Backend\Controllers\Files as FilesController;
@@ -26,6 +28,7 @@ use Exception;
  */
 class FileUpload extends FormWidgetBase
 {
+    use \Backend\Traits\FormModelSaver;
     use \Backend\Traits\FormModelWidget;
 
     //
@@ -84,6 +87,11 @@ class FileUpload extends FormWidgetBase
      */
     protected $defaultAlias = 'fileupload';
 
+    /**
+     * @var Backend\Widgets\Form The embedded form for modifying the properties of the selected file
+     */
+    protected $configFormWidget;
+
     /**
      * @inheritDoc
      */
@@ -104,6 +112,7 @@ class FileUpload extends FormWidgetBase
             $this->previewMode = true;
         }
 
+        $this->getConfigFormWidget();
         $this->checkUploadPostback();
     }
 
@@ -142,6 +151,44 @@ class FileUpload extends FormWidgetBase
         $this->vars['prompt'] = $this->getPromptText();
     }
 
+    /**
+     * Get the file record for this request, returns false if none available
+     *
+     * @return System\Models\File|false
+     */
+    protected function getFileRecord()
+    {
+        $record = false;
+
+        if (!empty(post('file_id'))) {
+            $record = $this->getRelationModel()::find(post('file_id')) ?: false;
+        }
+
+        return $record;
+    }
+
+    /**
+     * Get the instantiated config Form widget
+     *
+     * @return void
+     */
+    public function getConfigFormWidget()
+    {
+        if ($this->configFormWidget) {
+            return $this->configFormWidget;
+        }
+
+        $config = $this->makeConfig('~/modules/system/models/file/fields.yaml');
+        $config->model = $this->getFileRecord() ?: $this->getRelationModel();
+        $config->alias = $this->alias . $this->defaultAlias;
+        $config->arrayName = $this->getFieldName();
+
+        $widget = $this->makeWidget(Form::class, $config);
+        $widget->bindToController();
+
+        return $this->configFormWidget = $widget;
+    }
+
     protected function getFileList()
     {
         $list = $this
@@ -302,7 +349,7 @@ class FileUpload extends FormWidgetBase
     public function onLoadAttachmentConfig()
     {
         $fileModel = $this->getRelationModel();
-        if (($fileId = post('file_id')) && ($file = $fileModel::find($fileId))) {
+        if ($file = $this->getFileRecord()) {
             $file = $this->decorateFileAttributes($file);
 
             $this->vars['file'] = $file;
@@ -324,10 +371,15 @@ class FileUpload extends FormWidgetBase
     {
         try {
             $fileModel = $this->getRelationModel();
-            if (($fileId = post('file_id')) && ($file = $fileModel::find($fileId))) {
-                $file->title = post('title');
-                $file->description = post('description');
-                $file->save();
+            if ($file = $this->getFileRecord()) {
+                $formWidget = $this->getConfigFormWidget();
+
+                $modelsToSave = $this->prepareModelsToSave($file, $formWidget->getSaveData());
+                Db::transaction(function () use ($modelsToSave, $formWidget) {
+                    foreach ($modelsToSave as $modelToSave) {
+                        $modelToSave->save(null, $formWidget->getSessionKey());
+                    }
+                });
 
                 return ['displayName' => $file->title ?: $file->file_name];
             }

modules/backend/formwidgets/fileupload/partials/_config_form.htm

@@ -23,22 +23,7 @@
         <div class="modal-body">
             <p><?= e(trans('backend::lang.fileupload.help')) ?></p>
 
-            <div class="form-group">
-                <input
-                    type="text"
-                    name="title"
-                    class="form-control"
-                    value="<?= e($file->title) ?>"
-                    placeholder="<?= e(trans('backend::lang.fileupload.title_label')) ?>"
-                    />
-            </div>
-            <div class="form-group">
-                <textarea
-                    name="description"
-                    placeholder="<?= e(trans('backend::lang.fileupload.description_label')) ?>"
-                    class="form-control"><?= e($file->description) ?></textarea>
-            </div>
-
+            <?= $this->getConfigFormWidget()->render(); ?>
         </div>
         <div class="modal-footer">
             <a href="<?= $file->pathUrl ?>" class="pull-left btn btn-link fileupload-url-button" target="_blank">

modules/system/models/file/fields.yaml

@@ -0,0 +1,14 @@
+# ===================================
+#  Field Definitions
+# ===================================
+
+fields:
+    title:
+        type: text
+        placeholder: backend::lang.fileupload.title_label
+        span: full
+    description:
+        type: textarea
+        placeholder: backend::lang.fileupload.description_label
+        span: full
+        size: tiny