Changeset 7875

Timestamp:

02/14/2014 12:23:35 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce groups_add_groupmeta(). See #5400

Location:

trunk

Files:

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

trunk/bp-groups/bp-groups-functions.php

@@ -1038 +1038 @@
 }
 
+/**
+ * Add a piece of group metadata.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $group_id ID of the group.
+ * @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 groups_add_groupmeta( $group_id, $meta_key, $meta_value, $unique = false ) {
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = add_metadata( 'group', $group_id, $meta_key, $meta_value, $unique );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
 /*** Group Cleanup Functions ****************************************************/
 

trunk/tests/testcases/groups/functions.php

@@ -411 +411 @@
         $this->assertSame( '', groups_get_groupmeta( $g, 'foo' ) );
     }
+
+    /**
+     * @group groupmeta
+     * @group groups_add_groupmeta
+     */
+    public function test_groups_add_groupmeta_no_meta_key() {
+        $this->assertFalse( groups_add_groupmeta( 1, '', 'bar' ) );
+    }
+
+    /**
+     * @group groupmeta
+     * @group groups_add_groupmeta
+     */
+    public function test_groups_add_groupmeta_empty_object_id() {
+        $this->assertFalse( groups_add_groupmeta( 0, 'foo', 'bar' ) );
+    }
+
+    /**
+     * @group groupmeta
+     * @group groups_add_groupmeta
+     */
+    public function test_groups_add_groupmeta_existing_unique() {
+        $g = $this->factory->group->create();
+        groups_add_groupmeta( $g, 'foo', 'bar' );
+        $this->assertFalse( groups_add_groupmeta( $g, 'foo', 'baz', true ) );
+    }
+
+    /**
+     * @group groupmeta
+     * @group groups_add_groupmeta
+     */
+    public function test_groups_add_groupmeta_existing_not_unique() {
+        $g = $this->factory->group->create();
+        groups_add_groupmeta( $g, 'foo', 'bar' );
+        $this->assertNotEmpty( groups_add_groupmeta( $g, 'foo', 'baz' ) );
+    }
 }