Add support for specifying deletion data to be inserted when a record is deleted. (#20)

Author: rrigby

src/Definition.php

@@ -39,6 +39,11 @@ class Definition
      */
     private $deletionTimestamp;
 
+    /**
+     * @var array
+     */
+    private $deletionData = [];
+
     /**
      * @var array
      */
@@ -162,6 +167,18 @@ public function withDeletionTimestamp(string $column)
         return $this;
     }
 
+    /**
+     * Sets an array of table data to be included when a record is removed.
+     * 
+     * @param array $data
+     * @return Definition
+     */
+    public function withDeletionData(array $data): self
+    {
+        $this->deletionData = $data;
+        return $this;
+    }
+
     /**
      * Sets an array of table data to be included when a record is inserted.
      *
@@ -257,6 +274,16 @@ public function getDeletionTimestamp()
         return $this->deletionTimestamp;
     }
 
+    /**
+     * Returns an array of table data to be included when a record is removed.
+     *
+     * @return array
+     */
+    public function getDeletionData()
+    {
+        return $this->deletionData;
+    }
+
     /**
      * Returns an array of table data to be included when a record is inserted.
      *

src/Mapping.php

@@ -407,9 +407,9 @@ private function replace(array $data, array $original, array $deleteIds = [])
     private function delete($ids = [])
     {
         foreach ($ids as $table => $deleteColumns) {
-            foreach ($deleteColumns as $deletion => $primaries) {
+            foreach ($deleteColumns as $deletion => $deletionContext) {
                 // Arrange values into groups based on all but the last key
-                $grouped = Collection::group($primaries, function($keys) {
+                $grouped = Collection::group($deletionContext['keys'], function(array $keys) {
                     array_pop($keys);
                     return implode(':', $keys);
                 });
@@ -453,7 +453,17 @@ private function delete($ids = [])
 
                     $query->closeOr();
 
-                    $result = $deletion ? $query->isNull($deletion)->update([$deletion => gmdate('Y-m-d H:i:s')]) : $query->remove();
+                    if ($deletion) {
+                        $result = $query
+                            ->isNull($deletion)
+                            ->update(array_merge(
+                                [$deletion => gmdate('Y-m-d H:i:s')],
+                                $deletionContext['data']
+                            ));
+                    } else {
+                        $result = $query->remove();
+                    }
+
                     if (!$result) {
                         throw new \Exception('Failed to delete records.');
                     }
@@ -468,21 +478,26 @@ private function delete($ids = [])
      *
      * @param array $data
      * @param array $list
-     * @return array
+     * @return array<string, array<string, array{
+     *     keys: list<array<string, mixed>>,
+     *     data: array<string, mixed>
+     * }>>
      */
     private function collectPrimary(array $data = [], $list = [])
     {
         $table = $this->definition->getTable();
         $primaryKey = $this->definition->getPrimaryKey();
         $deletion = $this->definition->getDeletionTimestamp();
+        $deletionData = $this->definition->getDeletionData();
 
         $item = [];
 
         foreach ($primaryKey as $column) {
             $item[$column] = $data[$column];
         }
 
-        $list[$table][$deletion][] = $item;
+        $list[$table][$deletion]['keys'][] = $item;
+        $list[$table][$deletion]['data'] = $deletionData;
 
         foreach ($this->definition->getProperties() as $property) {
             $values = $data[$property->getName()] ?? [];

tests/Fixtures.sql

@@ -1,6 +1,6 @@
 -- Prepare schema
 DROP TABLE IF EXISTS customers;
-CREATE TABLE customers (id INTEGER PRIMARY KEY, name TEXT, date_deleted TEXT);
+CREATE TABLE customers (id INTEGER PRIMARY KEY, name TEXT, date_deleted TEXT, deleted_by TEXT);
 
 DROP TABLE IF EXISTS orders;
 CREATE TABLE orders (id INTEGER PRIMARY KEY, customer_id INTEGER, date_created TEXT, date_deleted TEXT);

tests/MappingTest.php

@@ -185,6 +185,11 @@ public function testRemove()
 
         $removed = $this->getMapping()->eq('id', 1)->findOne();
         $this->assertNull($removed);
+
+        $this->assertSame(
+            'Admin',
+            $this->db->table('customers')->eq('id', 1)->findOneColumn('deleted_by')
+        );
     }
 
     public function  testReadOnlyInsert()
@@ -417,7 +422,10 @@ public function getMapping()
         $customer = (new Definition('customers'))
             ->withColumns('id', 'name')
             ->withMany($order, 'orders', 'customer_id')
-            ->withDeletionTimestamp('date_deleted');
+            ->withDeletionTimestamp('date_deleted')
+            ->withDeletionData([
+                'deleted_by' => 'Admin'
+            ]);
 
         return new Mapping($this->db, $customer, [], [
             'inserted' => [$this->hook],