Added basic entity listener to track changes to payment order fields

Author: jbtronics

src/Entity/FieldChanges.php

@@ -30,7 +30,7 @@ private function __construct(private array $changedFields, private string|null $
      * @param  \DateTimeImmutable|null  $dateTime
      * @return void
      */
-    public function changeField(string $fieldName, string $user, ?\DateTimeImmutable $dateTime): void
+    public function changeField(string $fieldName, string $user, ?\DateTimeImmutable $dateTime = null): void
     {
         $this->changedFields[$fieldName] = [
             'date' => $dateTime ?? new \DateTimeImmutable(),

src/Entity/PaymentOrder.php

@@ -22,6 +22,7 @@
 use App\Entity\Contracts\TimestampedElementInterface;
 use App\Entity\Embeddable\Confirmation;
 use App\Entity\Embeddable\PayeeInfo;
+use App\EntityListener\PaymentOrderChangedFieldsListener;
 use App\Repository\PaymentOrderRepository;
 use App\Validator\FSRNotBlocked;
 use DateTime;
@@ -47,6 +48,7 @@
 #[ORM\HasLifecycleCallbacks]
 #[ORM\Table('payment_orders')]
 #[Vich\Uploadable]
+#[ORM\EntityListeners([PaymentOrderChangedFieldsListener::class])]
 class PaymentOrder implements DBElementInterface, TimestampedElementInterface, \Serializable
 {
     use TimestampTrait;
@@ -275,8 +277,8 @@ class PaymentOrder implements DBElementInterface, TimestampedElementInterface, \
     /**
      * @var FieldChanges|null The changes that were made to this payment order (or null if old case, where no changes were tracked)
      */
-    #[ORM\Column(type: 'field_changes', nullable: true)]
-    private ?FieldChanges $fieldChanges = null;
+    #[ORM\Column(type: 'field_changes', nullable: true, name: 'field_changes')]
+    private ?FieldChanges $field_changes = null;
 
     /**
      * @var Collection The confirmation tokens that can be used to confirm this payment order
@@ -847,11 +849,11 @@ public function removeConfirmationToken(ConfirmationToken $confirmationToken): s
     public function getFieldChanges(): FieldChanges
     {
         //If no field changes are set, create a new one
-        if ($this->fieldChanges === null) {
-            $this->fieldChanges = FieldChanges::new();
+        if ($this->field_changes === null) {
+            $this->field_changes = FieldChanges::new();
         }
 
-        return $this->fieldChanges;
+        return $this->field_changes;
     }
 
     public function serialize(): ?string

src/EntityListener/PaymentOrderChangedFieldsListener.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace App\EntityListener;
+
+use App\Entity\PaymentOrder;
+use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+
+#[AsEntityListener]
+class PaymentOrderChangedFieldsListener
+{
+    /**
+     * The fields whose changes we want to track
+     */
+    private const FIELDS_WHITELIST = [
+        'submitter_name',
+        'submitter_email',
+        'amount',
+        'project_name',
+        //TODO
+    ];
+
+    public function preUpdate(PreUpdateEventArgs $eventArgs): void
+    {
+        $entity = $eventArgs->getObject();
+
+        // only act on PaymentOrder entities
+        if (!$entity instanceof PaymentOrder) {
+            return;
+        }
+
+        // get the changed fields
+        $changedFields = array_keys($eventArgs->getEntityChangeSet());
+
+        // filter out the fields we are interested in
+        $fieldsToBeSaved = array_intersect($changedFields, self::FIELDS_WHITELIST);
+
+        // if no fields are to be saved, we can return early
+        if (empty($fieldsToBeSaved)) {
+            return;
+        }
+
+        //TODO: Determine Username
+        $user = 'StuRa Finanzen';
+
+        //Otherwise add the change to the field_changes property for each changed field
+        $fieldChanges = $entity->getFieldChanges();
+        foreach ($fieldsToBeSaved as $field) {
+            $fieldChanges->changeField($field, $user);
+        }
+
+        //As changes are not tracked anymore, we write out the changes to the database changeset ourselves
+        $eventArgs->setNewValue('field_changes', $fieldChanges);
+    }
+}