Add custom properties

Author: loevgaard

src/Event/Custom.php

@@ -34,9 +34,19 @@ final class Custom extends Parameters
 
     public ?float $value = null;
 
+    /**
+     * This holds an array of custom properties. See https://developers.facebook.com/docs/meta-pixel/implementation/conversion-tracking#custom-properties
+     *
+     * NOTICE that if you define a custom property with the same name as any of the standard properties, your
+     * custom property will be overridden by the value of the standard property
+     *
+     * @var array<string, mixed>
+     */
+    public array $customProperties = [];
+
     protected function getMapping(): array
     {
-        return [
+        return array_merge($this->customProperties, [
             'content_category' => $this->contentCategory,
             'content_ids' => $this->contentIds,
             'content_name' => $this->contentName,
@@ -50,7 +60,7 @@ protected function getMapping(): array
             'search_string' => $this->searchString,
             'status' => $this->status,
             'value' => $this->value,
-        ];
+        ]);
     }
 
     /**

tests/Event/CustomTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\MetaConversionsApi\Event;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Setono\MetaConversionsApi\Event\Custom
+ */
+final class CustomTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_generates_payload(): void
+    {
+        $user = new Custom();
+        $user->currency = 'DKK';
+        $user->customProperties['my_custom_property'] = 'test';
+
+        self::assertEquals([
+            'currency' => 'dkk',
+            'my_custom_property' => 'test',
+        ], $user->getPayload());
+    }
+}