Changeset 7879

Timestamp:

02/14/2014 01:59:32 PM (11 years ago)

Author:

boonebgorges

Message:

Add support for $single param in _get_meta() functions

Unlike get_metadata(), we are defaulting to $single = true, for backward
compatibility.

See #5400

Location:

trunk

Files:

• bp-activity/bp-activity-functions.php (modified) (1 diff)
• bp-blogs/bp-blogs-functions.php (modified) (2 diffs)
• bp-xprofile/bp-xprofile-functions.php (modified) (2 diffs)
• tests/testcases/activity/functions.php (modified) (1 diff)
• tests/testcases/blogs/functions.php (modified) (1 diff)
• tests/testcases/groups/functions.php (modified) (1 diff)
• tests/testcases/xprofile/functions.php (modified) (1 diff)

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

@@ -592 +592 @@
  * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
  *
- * @param int $activity_id ID of the activity item whose metadata is being requseted.
+ * @param int $activity_id ID of the activity item whose metadata is being requested.
  * @param string $meta_key Optional. If present, only the metadata matching
- *                         that meta key will be returned. Otherwise, all
- *                         metadata for the activity item will be fetched.
+ *        that meta key will be returned. Otherwise, all metadata for the
+ *        activity item will be fetched.
+ * @param bool $single Optional. If true, return only the first value of the
+ *    specified meta_key. This parameter has no effect if meta_key is not
+ *    specified. Default: true.
  * @return mixed The meta value(s) being requested.
  */

trunk/bp-blogs/bp-blogs-functions.php

@@ -881 +881 @@
  *        that meta key will be returned. Otherwise, all metadata for the
  *        blog will be fetched.
+ * @param bool $single Optional. If true, return only the first value of the
+ *    specified meta_key. This parameter has no effect if meta_key is not
+ *    specified. Default: true.
  * @return mixed The meta value(s) being requested.
  */
-function bp_blogs_get_blogmeta( $blog_id, $meta_key = '') {
+function bp_blogs_get_blogmeta( $blog_id, $meta_key = '', $single = true ) {
 
     // Legacy - Sanitize meta_key
@@ -889 +892 @@
 
     add_filter( 'query', 'bp_filter_metaid_column_name' );
-    $retval = get_metadata( 'blog', $blog_id, $meta_key, true );
+    $retval = get_metadata( 'blog', $blog_id, $meta_key, $single );
     remove_filter( 'query', 'bp_filter_metaid_column_name' );
 

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -582 +582 @@
  * Get a piece of xprofile metadata.
  *
+ * Note that the default value of $single is true, unlike in the case of the
+ * underlying get_metadata() function. This is for backward compatibility.
+ *
  * @param int $object_id ID of the object the metadata belongs to.
  * @param string $object_type Type of object. 'group', 'field', or 'data'.
  * @param string $meta_key Key of the metadata being fetched. If omitted, all
  *        metadata for the object will be retrieved.
+ * @param bool $single Optional. If true, return only the first value of the
+ *    specified meta_key. This parameter has no effect if meta_key is not
+ *    specified. Default: true.
  * @return mixed Meta value if found. False on failure.
  */
-function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '') {
+function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '', $single = true ) {
     // Legacy - sanitize object type
     if ( ! in_array( $object_type, array( 'group', 'field', 'data' ) ) ) {
@@ -596 +602 @@
     add_filter( 'query', 'bp_filter_metaid_column_name' );
     add_filter( 'query', 'bp_xprofile_filter_meta_query' );
-    $retval = get_metadata( 'xprofile_' . $object_type, $object_id, $meta_key, true );
+    $retval = get_metadata( 'xprofile_' . $object_type, $object_id, $meta_key, $single );
     remove_filter( 'query', 'bp_filter_metaid_column_name' );
     remove_filter( 'query', 'bp_xprofile_filter_meta_query' );

trunk/tests/testcases/activity/functions.php

@@ -259 +259 @@
     /**
      * @group activitymeta
+     * @group bp_activity_get_meta
+     */
+    public function test_bp_activity_get_meta_single_true() {
+        $a = $this->factory->activity->create();
+        bp_activity_add_meta( $a, 'foo', 'bar' );
+        bp_activity_add_meta( $a, 'foo', 'baz' );
+        $this->assertSame( 'bar', bp_activity_get_meta( $a, 'foo' ) ); // default is true
+        $this->assertSame( 'bar', bp_activity_get_meta( $a, 'foo', true ) );
+    }
+
+    /**
+     * @group activitymeta
+     * @group bp_activity_get_meta
+     */
+    public function test_bp_activity_get_meta_single_false() {
+        $a = $this->factory->activity->create();
+        bp_activity_add_meta( $a, 'foo', 'bar' );
+        bp_activity_add_meta( $a, 'foo', 'baz' );
+        $this->assertSame( array( 'bar', 'baz' ), bp_activity_get_meta( $a, 'foo', false ) );
+    }
+
+    /**
+     * @group activitymeta
      * @group bp_activity_delete_meta
      */

trunk/tests/testcases/blogs/functions.php

@@ -101 +101 @@
     /**
      * @group blogmeta
+     * @group bp_blogs_get_blogmeta
+     */
+    public function test_bp_blogs_get_blogmeta_single_true() {
+        bp_blogs_add_blogmeta( 1, 'foo', 'bar' );
+        bp_blogs_add_blogmeta( 1, 'foo', 'baz' );
+        $this->assertSame( 'bar', bp_blogs_get_blogmeta( 1, 'foo' ) ); // default is true
+        $this->assertSame( 'bar', bp_blogs_get_blogmeta( 1, 'foo', true ) );
+    }
+
+    /**
+     * @group blogmeta
+     * @group bp_blogs_get_blogmeta
+     */
+    public function test_bp_blogs_get_blogmeta_single_false() {
+        bp_blogs_add_blogmeta( 1, 'foo', 'bar' );
+        bp_blogs_add_blogmeta( 1, 'foo', 'baz' );
+        $this->assertSame( array( 'bar', 'baz' ), bp_blogs_get_blogmeta( 1, 'foo', false ) );
+    }
+    /**
+     * @group blogmeta
      * @group bp_blogs_update_blogmeta
      */

trunk/tests/testcases/groups/functions.php

@@ -395 +395 @@
     /**
      * @group groupmeta
+     * @group groups_get_groupmeta
+     */
+    public function test_bp_activity_get_meta_single_true() {
+        $g = $this->factory->group->create();
+        groups_add_groupmeta( $g, 'foo', 'bar' );
+        groups_add_groupmeta( $g, 'foo', 'baz' );
+        $this->assertSame( 'bar', groups_get_groupmeta( $g, 'foo' ) ); // default is true
+        $this->assertSame( 'bar', groups_get_groupmeta( $g, 'foo', true ) );
+    }
+
+    /**
+     * @group groupmeta
+     * @group groups_get_groupmeta
+     */
+    public function test_bp_activity_get_meta_single_false() {
+        $g = $this->factory->group->create();
+        groups_add_groupmeta( $g, 'foo', 'bar' );
+        groups_add_groupmeta( $g, 'foo', 'baz' );
+        $this->assertSame( array( 'bar', 'baz' ), groups_get_groupmeta( $g, 'foo', false ) );
+    }
+
+    /**
+     * @group groupmeta
      */
     public function test_groups_delete_groupmeta_non_numeric_id() {

trunk/tests/testcases/xprofile/functions.php

@@ -280 +280 @@
      * @group bp_xprofile_get_meta
      */
+    public function test_bp_xprofile_get_meta_single_true() {
+        $g = $this->factory->xprofile_group->create();
+        bp_xprofile_add_meta( $g, 'group', 'foo', 'bar' );
+        bp_xprofile_add_meta( $g, 'group', 'foo', 'baz' );
+        $this->assertSame( 'bar', bp_xprofile_get_meta( $g, 'group', 'foo' ) ); // default is true
+        $this->assertSame( 'bar', bp_xprofile_get_meta( $g, 'group', 'foo', true ) );
+    }
+
+    /**
+     * @group xprofilemeta
+     * @group bp_xprofile_get_meta
+     */
+    public function test_bp_xprofile_get_meta_single_false() {
+        $g = $this->factory->xprofile_group->create();
+        bp_xprofile_add_meta( $g, 'group', 'foo', 'bar' );
+        bp_xprofile_add_meta( $g, 'group', 'foo', 'baz' );
+        $this->assertSame( array( 'bar', 'baz' ), bp_xprofile_get_meta( $g, 'group', 'foo', false ) );
+    }
+
+    /**
+     * @group xprofilemeta
+     * @group bp_xprofile_get_meta
+     */
     public function test_bp_xprofile_get_meta_no_meta_key_no_results() {
         $g = $this->factory->xprofile_group->create();