Refs #12145 refactor form code into methods to remove clutter

extension/Classes/Core/AbstractBuildForm.php

@@ -559,7 +559,7 @@ abstract class AbstractBuildForm {
 
         if ($recordId != 0) {
             $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to load not found. "
-                . (FEATURE_FORM_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
+                . (FEATURE_FORM_FILE_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
         }
 
         if (isset($record[F_FILE_STATS])) {

extension/Classes/Core/Constants.php

@@ -9,7 +9,7 @@
 const EXT_KEY = 'qfq';
 
 // Feature Flags
-const FEATURE_FORM_SYNC = false; // Enable automatic form sync between database and form files.
+const FEATURE_FORM_FILE_SYNC = false; // Enable automatic form sync between database and form files.
 
 const PROJECT_PATH_PHP_FILE = 'qfq.project.path.php';
 

extension/Classes/Core/Database/DatabaseUpdate.php

@@ -158,7 +158,7 @@ class DatabaseUpdate {
 
             $this->dbUpdateStatements($old, $new);
 
-            if (FEATURE_FORM_SYNC) {
+            if (FEATURE_FORM_FILE_SYNC) {
                 if ($this->db->existTable('Form')) {
                     // If Form table exists, import all form files so everything is up to date.
                     FormAsFile::importAllForms($this->db, true); // Note: Creates path and exports all forms first if the form directory does not exist.
@@ -192,7 +192,7 @@ class DatabaseUpdate {
 
         if (version_compare($old, '19.9.0') === -1) {
             $this->updateSpecialColumns();
-            if (FEATURE_FORM_SYNC) {
+            if (FEATURE_FORM_FILE_SYNC) {
                 FormAsFIle::exportAllForms($this->db);
             }
         }

extension/Classes/Core/Form/Dirty.php

@@ -287,7 +287,7 @@ class Dirty {
         $formDirtyMode = $tableVars[F_DIRTY_MODE];
 
         $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to lock not found. "
-            . (FEATURE_FORM_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
+            . (FEATURE_FORM_FILE_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
 
         # Dirty workaround: setting the 'expired timestamp' minus 1 second guarantees that the client ask for relock always if the timeout is expired.
         $expire = date('Y-m-d H:i:s', strtotime("+" . $tableVars[F_RECORD_LOCK_TIMEOUT_SECONDS] - 1 . " seconds"));
@@ -322,7 +322,7 @@ class Dirty {
         }
 
         $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to lock not found. "
-            . (FEATURE_FORM_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
+            . (FEATURE_FORM_FILE_SYNC ? FormAsFile::errorHintFormImport($tableName) : ''));
 
         if (isset($record[F_FILE_STATS])) {
             // why: The column "fileStats" in the Form table is modified when a form is exported to a file but nothing else changes.

extension/Classes/Core/Form/DragAndDrop.php

@@ -125,7 +125,7 @@ class DragAndDrop {
         $nameId = false;
         $nameOrd = false;
 
-        if (FEATURE_FORM_SYNC) {
+        if (FEATURE_FORM_FILE_SYNC) {
             // Import Form from file if loaded record is Form/FormElement (If form file was changed, throw exception)
             // Note: This is here since this code is called outside QuickFormQuery->doForm
             $formFileName = FormAsFile::importFormRecordId($dragId, $tableName, $this->db);
@@ -170,7 +170,7 @@ class DragAndDrop {
             $ord += $orderInterval;
         }
 
-        if (FEATURE_FORM_SYNC) {
+        if (FEATURE_FORM_FILE_SYNC) {
             // Export Form file
             if ($formFileName !== null) {
                 FormAsFile::exportForm($formFileName, $this->db);

extension/Classes/Core/QuickFormQuery.php

@@ -456,29 +456,10 @@ class QuickFormQuery {
             }
         }
 
-        if (FEATURE_FORM_SYNC) {
-            // FormAsFile: Get the new and the old form file name and make sure both files are writable (before DB changes are made)
+        if (FEATURE_FORM_FILE_SYNC) {
+            // FormAsFile: If the record is a Form or FormElement get the new and the old form file name and make sure both files are writable (before DB changes are made).
             // Note: This can't be done earlier because $formModeNew might be changed in the lines above.
-            $formNameDB = FormAsFile::formNameFromFormRelatedRecord($recordId, $this->formSpec[F_TABLE_NAME] ?? '', $this->dbArray[$this->dbIndexQfq]);
-            switch ($this->formSpec[F_TABLE_NAME] ?? '') {
-                case TABLE_NAME_FORM: // cases covered: new form, existing form, existing form but form name changed
-                    $formFileName = $this->store->getVar(F_NAME, STORE_FORM, SANITIZE_ALLOW_ALNUMX);
-                    $formFileName = $formFileName === false ? $formNameDB : $formFileName;
-                    if ($formNameDB !== null && $formFileName !== $formNameDB && $formModeNew === FORM_SAVE) {
-                        $formFileNameDelete = $formNameDB;
-                        FormAsFile::enforceFormFileWritable($formFileNameDelete, $this->dbArray[$this->dbIndexQfq]); // file will be deleted after DB changes
-                    }
-                    break;
-                case TABLE_NAME_FORM_ELEMENT: // cases covered: new formElement, existing formElement
-                    $formId = $this->store->getVar(FE_FORM_ID, STORE_FORM);
-                    $formFileName = $formId !== false ? FormAsFile::formNameFromFormRelatedRecord($formId, TABLE_NAME_FORM, $this->dbArray[$this->dbIndexQfq]) : $formNameDB;
-                    break;
-                default:
-                    $formFileName = $formNameDB;
-            }
-            if ($formFileName !== null && in_array($formModeNew, [FORM_SAVE, FORM_DRAG_AND_DROP, FORM_DELETE])) {
-                FormAsFile::enforceFormFileWritable($formFileName, $this->dbArray[$this->dbIndexQfq]);
-            }
+            list($formFileName, $formFileNameDelete) = $this->formAsFileBeforeSave($recordId, $formModeNew);
         }
 
         // For 'new' record always create a new Browser TAB-uniq (for this current form, nowhere else used) SIP.
@@ -679,27 +660,9 @@ class QuickFormQuery {
             $data = $this->groupElementUpdateEntries($data);
         }
 
-        if (FEATURE_FORM_SYNC) {
+        if (FEATURE_FORM_FILE_SYNC) {
             // export Form to file, if loaded record is a Form/FormElement
-            if ($formFileName !== null) {
-                switch ($formModeNew) {
-                    case FORM_SAVE:
-                    case FORM_DRAG_AND_DROP:
-                        FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
-                        break;
-                    case FORM_DELETE:
-                        if (TABLE_NAME_FORM_ELEMENT === ($this->formSpec[F_TABLE_NAME] ?? '')) {
-                            FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
-                        } else {
-                            FormAsFile::deleteFormFile($formFileName, $this->dbArray[$this->dbIndexQfq], 'Form was deleted using form-editor.');
-                        }
-                        break;
-                }
-            }
-            // delete old form file if form name was changed
-            if (isset($formFileNameDelete)) {
-                FormAsFile::deleteFormFile($formFileNameDelete, $this->dbArray[$this->dbIndexQfq], "Form was renamed to: '$formFileName'.");
-            }
+            $this->formAsFileAfterSave($formFileName, $formModeNew, $formFileNameDelete);
         }
 
         return $data;
@@ -1090,7 +1053,7 @@ class QuickFormQuery {
         // Preparation for Log, Debug
         $this->store->setVar(SYSTEM_FORM, $formName, STORE_SYSTEM);
 
-        if (FEATURE_FORM_SYNC) {
+        if (FEATURE_FORM_FILE_SYNC) {
             // Check for form file changes
             FormAsFile::importForm($formName, $this->dbArray[$this->dbIndexQfq]);
         }
@@ -1100,7 +1063,7 @@ class QuickFormQuery {
         $form = $this->dbArray[$this->dbIndexQfq]->sql("SELECT * FROM `Form` AS f WHERE `f`.`$constant` LIKE ? AND `f`.`deleted`='no'", ROW_EXPECT_1,
             [$formName], 'Form "' . $formName . '" not found or multiple forms with the same name.');
 
-        if (FEATURE_FORM_SYNC) {
+        if (FEATURE_FORM_FILE_SYNC) {
             // Import Form from file if loaded record is Form/FormElement (If form file was changed, throw exception)
             FormAsFile::importFormRecordId($recordId, $form[F_TABLE_NAME], $this->dbArray[$this->dbIndexQfq]);
         }
@@ -2131,6 +2094,43 @@ class QuickFormQuery {
 
     }
 
+    /**
+     * If the record is a Form or FormElement get the new and the old (if name changed) form file name and make sure both files are writable.
+     *
+     * @param $recordId
+     * @param string $formModeNew
+     * @return array
+     * @throws \CodeException
+     * @throws \DbException
+     * @throws \UserFormException
+     * @throws \UserReportException
+     */
+    public function formAsFileBeforeSave($recordId, string $formModeNew): array
+    {
+        $formFileName = null;
+        $formNameDB = FormAsFile::formNameFromFormRelatedRecord($recordId, $this->formSpec[F_TABLE_NAME] ?? '', $this->dbArray[$this->dbIndexQfq]);
+        switch ($this->formSpec[F_TABLE_NAME] ?? '') {
+            case TABLE_NAME_FORM: // cases covered: new form, existing form, existing form but form name changed
+                $formFileName = $this->store->getVar(F_NAME, STORE_FORM, SANITIZE_ALLOW_ALNUMX);
+                $formFileName = $formFileName === false ? $formNameDB : $formFileName;
+                if ($formNameDB !== null && $formFileName !== $formNameDB && $formModeNew === FORM_SAVE) {
+                    $formFileNameDelete = $formNameDB;
+                    FormAsFile::enforceFormFileWritable($formFileNameDelete, $this->dbArray[$this->dbIndexQfq]); // file will be deleted after DB changes
+                }
+                break;
+            case TABLE_NAME_FORM_ELEMENT: // cases covered: new formElement, existing formElement
+                $formId = $this->store->getVar(FE_FORM_ID, STORE_FORM);
+                $formFileName = $formId !== false ? FormAsFile::formNameFromFormRelatedRecord($formId, TABLE_NAME_FORM, $this->dbArray[$this->dbIndexQfq]) : $formNameDB;
+                break;
+            default:
+                $formFileName = $formNameDB;
+        }
+        if ($formFileName !== null && in_array($formModeNew, [FORM_SAVE, FORM_DRAG_AND_DROP, FORM_DELETE])) {
+            FormAsFile::enforceFormFileWritable($formFileName, $this->dbArray[$this->dbIndexQfq]);
+        }
+        return array($formFileName, $formFileNameDelete);
+    }
+
     /**
      * Based on the given SIP, create a new uniqe SIP by copying the relevant old params and taking the new recordId..
      *
@@ -2274,4 +2274,37 @@ EOF;
 
     }
 
+    /**
+     * export Form to file, if loaded record is a Form/FormElement
+     *
+     * @param $formFileName
+     * @param string $formModeNew
+     * @param $formFileNameDelete
+     * @throws \CodeException
+     * @throws \DbException
+     * @throws \UserFormException
+     */
+    private function formAsFileAfterSave($formFileName, string $formModeNew, $formFileNameDelete): void
+    {
+        if ($formFileName !== null) {
+            switch ($formModeNew) {
+                case FORM_SAVE:
+                case FORM_DRAG_AND_DROP:
+                    FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
+                    break;
+                case FORM_DELETE:
+                    if (TABLE_NAME_FORM_ELEMENT === ($this->formSpec[F_TABLE_NAME] ?? '')) {
+                        FormAsFile::exportForm($formFileName, $this->dbArray[$this->dbIndexQfq]);
+                    } else {
+                        FormAsFile::deleteFormFile($formFileName, $this->dbArray[$this->dbIndexQfq], 'Form was deleted using form-editor.');
+                    }
+                    break;
+            }
+        }
+        // delete old form file if form name was changed
+        if (isset($formFileNameDelete)) {
+            FormAsFile::deleteFormFile($formFileNameDelete, $this->dbArray[$this->dbIndexQfq], "Form was renamed to: '$formFileName'.");
+        }
+    }
+
 }
\ No newline at end of file

extension/Classes/Core/Report/Report.php

@@ -588,7 +588,7 @@ class Report {
 
             $this->store->setVar(SYSTEM_SQL_FINAL, $sql, STORE_SYSTEM);
 
-            if (FEATURE_FORM_SYNC) {
+            if (FEATURE_FORM_FILE_SYNC) {
                 // import form files if changed + delete Forms without form file
                 if (FormAsFile::isFormQuery($sql)) {
                     FormAsFile::importAllForms($this->db, false, true);