Merge pull request #19588 from grokability/importer-cleanup-and-add-skip-nulls

🖼️ Importer cleanup and add skip nulls

Author: snipe

app/Http/Requests/ItemImportRequest.php

@@ -66,6 +66,15 @@ public function import(Import $import)
             ->setUsernameFormat('firstname.lastname')
             ->setFieldMappings($fieldMappings);
 
+        // "Skip updating fields with blank cells" opts out of the default
+        // clear-DB-on-blank behavior so an empty cell in the CSV keeps
+        // whatever value is already in the DB column. Only the update path
+        // is affected. New-row inserts ignore the flag entirely. See
+        // ItemImporter::$rejectEmptyOnUpdate.
+        if ($importer instanceof \App\Importer\ItemImporter) {
+            $importer->setRejectEmptyOnUpdate((bool) $this->input('import-preserve-blanks'));
+        }
+
         // Matcher options only apply to the asset history importer, which
         // resolves rows to existing users by name (not by creating new
         // users). Any other importer ignores these switches.

app/Importer/AccessoryImporter.php

@@ -20,7 +20,7 @@ protected function handle($row)
         // columns are left out of $this->item so update mode preserves the
         // DB value, and present-but-empty cells land as null so update mode
         // clears the DB value. The base sanitize's reject-empty pass is
-        // suppressed via the sanitizeItemForStoring override below.
+        // disabled by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         // Shared lookup fields. Present-and-empty clears the FK; absent
@@ -91,17 +91,6 @@ protected function handle($row)
         $this->createAccessoryIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create an accessory if a duplicate does not exist
      *

app/Importer/AssetImporter.php

@@ -45,8 +45,8 @@ protected function handle($row)
         // $this->item exclusively via setItemFromCsvIfPresent so absent
         // columns never enter the update payload (preserving DB values)
         // and present-but-empty columns land as null (clearing DB values).
-        // See sanitizeItemForStoring override below for the matching
-        // pass-through sanitize.
+        // The base sanitize's reject-empty pass is disabled by
+        // $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         // Shared lookup fields. Present-and-empty clears the FK; absent
@@ -181,19 +181,6 @@ protected function handle($row)
         $this->createAssetIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. AssetImporter
-     * populates $this->item exclusively from CSV columns that were present in
-     * the row, so an empty value here is an explicit intent to clear the DB
-     * field on update. See handle() above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create the asset if it does not exist.
      *

app/Importer/AssetModelImporter.php

@@ -29,7 +29,7 @@ protected function handle($row)
         // columns stay out of $this->item so update mode preserves the DB
         // value, and present-but-empty cells land as null so update mode
         // clears the DB value. The base sanitize's reject-empty pass is
-        // suppressed via the sanitizeItemForStoring override below.
+        // disabled by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         $this->setItemFromCsvIfPresent($row, 'name');
@@ -65,17 +65,6 @@ protected function handle($row)
         $this->createAssetModelIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create a model if a duplicate does not exist.
      *

app/Importer/CategoryImporter.php

@@ -27,7 +27,7 @@ protected function handle($row)
         // columns stay out of $this->item so update mode preserves the DB
         // value, and present-but-empty cells land as null so update mode
         // clears the DB value. The base sanitize's reject-empty pass is
-        // suppressed via the sanitizeItemForStoring override below.
+        // disabled by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         $this->setItemFromCsvIfPresent($row, 'name');
@@ -55,17 +55,6 @@ protected function handle($row)
         $this->createCategoryIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create a category if a duplicate does not exist.
      *

app/Importer/ComponentImporter.php

@@ -92,17 +92,6 @@ protected function handle($row)
         $this->createComponentIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create a component if a duplicate does not exist
      *

app/Importer/ConsumableImporter.php

@@ -20,7 +20,7 @@ protected function handle($row)
         // pattern: absent CSV columns stay out of $this->item so update mode
         // preserves the DB value, and present-but-empty cells land as null
         // so update mode clears the DB value. The base sanitize's reject-empty
-        // pass is suppressed via the sanitizeItemForStoring override below.
+        // pass is disabled by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         // Shared lookup fields. Present-and-empty clears the FK; absent
@@ -92,17 +92,6 @@ protected function handle($row)
         $this->createConsumableIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create a consumable if a duplicate does not exist
      *

app/Importer/ItemImporter.php

@@ -20,6 +20,22 @@ class ItemImporter extends Importer
 
     protected Setting $settings;
 
+    // Every concrete subclass currently disables the reject-empty pass on
+    // update so that a present-but-empty CSV cell clears the corresponding
+    // DB column. Absent columns still preserve the DB value because the
+    // subclasses' handle() methods only populate $this->item for cells that
+    // are actually in the row. Flip to true on a subclass, or via
+    // setRejectEmptyOnUpdate() at runtime, to fall back to "keep DB value
+    // on empty CSV cell" behavior.
+    protected bool $rejectEmptyOnUpdate = false;
+
+    public function setRejectEmptyOnUpdate(bool $reject): self
+    {
+        $this->rejectEmptyOnUpdate = $reject;
+
+        return $this;
+    }
+
     public function __construct($filename)
     {
         parent::__construct($filename);
@@ -230,7 +246,7 @@ protected function sanitizeItemForStoring($model, $updating = false)
         $item = $item->only($model->getFillable());
 
         // Then iterate through the item and, if we are updating, remove any blank values.
-        if ($updating) {
+        if ($updating && $this->rejectEmptyOnUpdate) {
             $item = $item->reject(function ($value) {
                 return empty($value);
             });

app/Importer/LicenseImporter.php

@@ -22,8 +22,8 @@ protected function handle($row)
         // $this->item exclusively via setItemFromCsvIfPresent so absent
         // columns never enter the update payload (preserving DB values)
         // and present-but-empty columns land as empty strings (clearing
-        // DB values). See sanitizeItemForStoring override below for the
-        // matching pass-through sanitize.
+        // DB values). The base sanitize's reject-empty pass is disabled
+        // by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         // Shared lookup fields. Present-and-empty clears the FK; absent
@@ -71,19 +71,6 @@ protected function handle($row)
         $this->createLicenseIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. LicenseImporter
-     * populates $this->item exclusively from CSV columns that were present in
-     * the row, so an empty value here is an explicit intent to clear the DB
-     * field on update. See handle() above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create the license if it does not exist.
      *

app/Importer/LocationImporter.php

@@ -27,7 +27,7 @@ protected function handle($row)
         // columns stay out of $this->item so update mode preserves the DB
         // value, and present-but-empty cells land as null so update mode
         // clears the DB value. The base sanitize's reject-empty pass is
-        // suppressed via the sanitizeItemForStoring override below.
+        // disabled by $rejectEmptyOnUpdate on ItemImporter.
         $this->item = [];
 
         // Straight CSV-to-item assignments for Location fillable fields.
@@ -83,17 +83,6 @@ protected function handle($row)
         $this->createLocationIfNotExists($row);
     }
 
-    /**
-     * Override the base sanitize to skip the reject-empty pass. See handle()
-     * above for the matching item-population.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    protected function sanitizeItemForStoring($model, $updating = false)
-    {
-        return collect($this->item)->only($model->getFillable())->toArray();
-    }
-
     /**
      * Create a location if a duplicate does not exist.
      *