Adding setUserProperties to event object

zumba · Apr 29, 2016 · 15b4848 · 15b4848
1 parent 6a2f816
commit 15b4848
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/src/Amplitude.php b/src/Amplitude.php
@@ -257,9 +257,7 @@ public function logEvent($eventType = '', array $eventProperties = [])
             $event->deviceId = $this->deviceId;
         }
         if (!empty($this->userProperties)) {
-            $props = !empty($event->userProperties) ? $event->userProperties : [];
-            $props = array_merge($props, $this->userProperties);
-            $event->userProperties = $props;
+            $event->setUserProperties($this->userProperties);
             $this->resetUserProperties();
         }
 
@@ -355,6 +353,8 @@ public function setDeviceId($deviceId)
     /**
      * Set the user properties, will be sent with the next event sent to Amplitude
      *
+     * Any set with this will take precedence over any set on the Event object
+     *
      * If no events are logged, it will not get sent to Amplitude
      *
      * @param array $userProperties

diff --git a/src/Event.php b/src/Event.php
@@ -100,6 +100,17 @@ public function __construct(array $data = [])
         }
     }
 
+    /**
+     * Set the user properties on the event
+     *
+     * @param array $userProperties
+     */
+    public function setUserProperties(array $userProperties)
+    {
+        $props = $this->userProperties ?: [];
+        $this->userProperties = array_merge($props, $userProperties);
+        return $this;
+    }
 
     /**
      * Set a value in the event.

diff --git a/test/AmplitudeTest.php b/test/AmplitudeTest.php
@@ -322,4 +322,24 @@ public function testOptOut()
             ->queueEvent('Another Queued Event');
         $this->assertTrue($amplitude->getOptOut());
     }
+
+    public function testSetUserProperties()
+    {
+        $userProps = ['dob' => 'tomorrow', 'gender' => 'f'];
+        $amplitude = new Amplitude();
+        $amplitude->setUserProperties($userProps);
+        $this->assertSame($userProps, $amplitude->getUserProperties());
+        $userProps2 = ['dob' => 'yesterday', 'name' => 'Baby'];
+        $expected = [
+            'dob' => 'yesterday',
+            'gender' => 'f',
+            'name' => 'Baby',
+        ];
+        $amplitude->setUserProperties($userProps2);
+        $this->assertSame(
+            $expected,
+            $amplitude->getUserProperties(),
+            'Second call to setUserProperties should set properties, without removing existing'
+        );
+    }
 }
diff --git a/test/EventTest.php b/test/EventTest.php
@@ -201,4 +201,28 @@ public function testUnsetProperty()
         unset($event->userId);
         $this->assertEmpty($event->userId, 'Should unset built-in properties with magic unset');
     }
+
+    public function testSetUserProperties()
+    {
+        $userProps = ['dob' => 'tomorrow', 'gender' => 'f'];
+        $event = new Event();
+        $event->setUserProperties($userProps);
+        $this->assertSame(
+            ['user_properties' => $userProps],
+            $event->toArray(),
+            'Should set user properties in user_properties'
+        );
+        $userProps2 = ['dob' => 'yesterday', 'name' => 'Baby'];
+        $expected = [
+            'dob' => 'yesterday',
+            'gender' => 'f',
+            'name' => 'Baby',
+        ];
+        $event->setUserProperties($userProps2);
+        $this->assertSame(
+            ['user_properties' => $expected],
+            $event->toArray(),
+            'Second call to setUserProperties should update properties, not remove existing'
+        );
+    }
 }