Add HistorizableInterface::getHistoryDiffFieldsToSkip to manage field…

…s to skip logging on history
smartbooster · Aug 28, 2024 · b2bcc63 · b2bcc63
1 parent cf5f118
commit b2bcc63
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/src/Entity/Log/HistorizableInterface.php b/src/Entity/Log/HistorizableInterface.php
@@ -19,4 +19,13 @@ public function addHistory(array $history): self;
      * Allows you to activate or not the history on prePersist/preUpdate doctrine events for diffs
      */
     public function isDoctrineListenerEnable(): bool;
+
+    /**
+     * @return array Indexed array which contains field to skip storing on the history JSON by the HistoryDoctrineListener when doing update
+     *  Example :
+     *  [
+     *      "progressionData" => true,
+     *  ]
+     */
+    public function getHistoryDiffFieldsToSkip(): array;
 }
diff --git a/src/Entity/Log/HistorizableTrait.php b/src/Entity/Log/HistorizableTrait.php
@@ -42,4 +42,9 @@ public function isDoctrineListenerEnable(): bool
     {
         return true;
     }
+
+    public function getHistoryDiffFieldsToSkip(): array
+    {
+        return [];
+    }
 }
diff --git a/src/EventListener/HistoryDoctrineListener.php b/src/EventListener/HistoryDoctrineListener.php
@@ -53,8 +53,15 @@ private function handleHistory(LifecycleEventArgs $args, string $code): void
 
             $statusDiff = null;
             $isHistorizableStatus = $entity instanceof HistorizableStatusInterface;
+            $diffFieldsToSkip = $entity->getHistoryDiffFieldsToSkip();
             foreach ($entityData as $field => $change) {
-                if ($field === 'history' || $field === 'updatedAt' || $field === 'updatedAtMonth' || $field === 'updatedAtYear') {
+                if (
+                    $field === 'history'
+                    || $field === 'updatedAt'
+                    || $field === 'updatedAtMonth'
+                    || $field === 'updatedAtYear'
+                    || isset($diffFieldsToSkip[$field])
+                ) {
                     unset($entityData[$field]);
                     continue;
                 }