Changeset 7872

Timestamp:

02/14/2014 12:08:21 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce bp_activity_add_meta()

See #5400

Location:

trunk

Files:

• bp-activity/bp-activity-functions.php (modified) (1 diff)
• tests/testcases/activity/functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-functions.php

@@ -668 +668 @@
         $retval = true;
     }
+
+    return $retval;
+}
+
+/**
+ * Add a piece of activity metadata.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $activity_id ID of the activity item.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value.
+ * @param bool $unique. Optional. Whether to enforce a single metadata value
+ *        for the given key. If true, and the object already has a value for
+ *        the key, no change will be made. Default: false.
+ * @return int|bool The meta ID on successful update, false on failure.
+ */
+function bp_activity_add_meta( $activity_id, $meta_key, $meta_value, $unique = false ) {
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = add_metadata( 'activity', $activity_id, $meta_key, $meta_value, $unique );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
 
     return $retval;

trunk/tests/testcases/activity/functions.php

@@ -313 +313 @@
 
     /**
+     * @group activitymeta
+     * @group bp_activity_add_meta
+     */
+    public function test_bp_activity_add_meta_no_meta_key() {
+        $this->assertFalse( bp_activity_add_meta( 1, '', 'bar' ) );
+    }
+
+    /**
+     * @group activitymeta
+     * @group bp_activity_add_meta
+     */
+    public function test_bp_activity_add_meta_empty_object_id() {
+        $this->assertFalse( bp_activity_add_meta( 0, 'foo', 'bar' ) );
+    }
+
+    /**
+     * @group activitymeta
+     * @group bp_activity_add_meta
+     */
+    public function test_bp_activity_add_meta_existing_unique() {
+        $a = $this->factory->activity->create();
+        bp_activity_add_meta( $a, 'foo', 'bar' );
+        $this->assertFalse( bp_activity_add_meta( 0, 'foo', 'baz', true ) );
+    }
+
+    /**
+     * @group activitymeta
+     * @group bp_activity_add_meta
+     */
+    public function test_bp_activity_add_meta_existing_not_unique() {
+        $a = $this->factory->activity->create();
+        bp_activity_add_meta( $a, 'foo', 'bar' );
+        $this->assertNotEmpty( bp_activity_add_meta( $a, 'foo', 'baz' ) );
+    }
+
+    /**
      * @group bp_activity_get_user_mentionname
      */