Changeset 7905

Timestamp:

02/17/2014 01:02:25 AM (10 years ago)

Author:

boonebgorges

Message:

Introduce 'update_meta_cache' param to bp_has_activities() stack

See #5398

Location:

trunk

Files:

• bp-activity/bp-activity-classes.php (modified) (2 diffs)
• bp-activity/bp-activity-functions.php (modified) (5 diffs)
• bp-activity/bp-activity-template.php (modified) (5 diffs)
• tests/testcases/activity/template.php (modified) (1 diff)

trunk/bp-activity/bp-activity-classes.php

@@ -249 +249 @@
      *                             Default: false.
      *     @type string $spam Spam status. Default: 'ham_only'.
+     *     @type bool $update_meta_cache Whether to pre-fetch metadata for
+     *           queried activity items. Default: true.
      * }
      * @return array The array returned has two keys:
@@ -431 +433 @@
         }
 
-        if ( !empty( $activity_ids ) ) {
+        if ( ! empty( $activity_ids ) && $update_meta_cache ) {
             bp_activity_update_meta_cache( $activity_ids );
         }

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

@@ -911 +911 @@
         'in'               => false,        // Comma-separated list or array of activity IDs to which you want to limit the query
         'spam'             => 'ham_only',   // 'ham_only' (default), 'spam_only' or 'all'.
+        'update_meta_cache' => true,
 
         /**
@@ -940 +941 @@
                 'display_comments' => $display_comments,
                 'show_hidden'      => $show_hidden,
-                'spam'             => $spam
+                'spam'             => $spam,
+                'update_meta_cache' => $update_meta_cache,
             );
             $activity = BP_Activity_Activity::get( $args );
@@ -981 +983 @@
  *     except for the following:
  *     @type string|int|array Single activity ID, comma-separated list of IDs,
- *                            or array of IDs.
+ *           or array of IDs.
  * }
  * @return array $activity See BP_Activity_Activity::get() for description.
@@ -995 +997 @@
         'sort'             => 'DESC',      // sort ASC or DESC
         'spam'             => 'ham_only',  // Retrieve items marked as spam
+        'update_meta_cache' => true,
     );
     $r = wp_parse_args( $args, $defaults );
@@ -1007 +1010 @@
         'show_hidden'      => $show_hidden,
         'in'               => $activity_ids,
-        'spam'             => $spam
+        'spam'             => $spam,
+        'update_meta_cache' => $update_meta_cache,
     );
     return apply_filters( 'bp_activity_get_specific', BP_Activity_Activity::get( $get_args ), $args, $get_args );

trunk/bp-activity/bp-activity-template.php

@@ -174 +174 @@
             'show_hidden'      => false,
             'spam'             => 'ham_only',
+            'update_meta_cache' => true,
         );
         $r = wp_parse_args( $args, $defaults );
@@ -189 +190 @@
         // Fetch specific activity items based on ID's
         if ( !empty( $include ) )
-            $this->activities = bp_activity_get_specific( array( 'activity_ids' => explode( ',', $include ), 'max' => $max, 'page' => $this->pag_page, 'per_page' => $this->pag_num, 'sort' => $sort, 'display_comments' => $display_comments, 'show_hidden' => $show_hidden, 'spam' => $spam ) );
+            $this->activities = bp_activity_get_specific( array( 'activity_ids' => explode( ',', $include ), 'max' => $max, 'page' => $this->pag_page, 'per_page' => $this->pag_num, 'sort' => $sort, 'display_comments' => $display_comments, 'show_hidden' => $show_hidden, 'spam' => $spam, 'update_meta_cache' => $update_meta_cache, ) );
 
         // Fetch all activity items
         else
-            $this->activities = bp_activity_get( array( 'display_comments' => $display_comments, 'max' => $max, 'per_page' => $this->pag_num, 'page' => $this->pag_page, 'sort' => $sort, 'search_terms' => $search_terms, 'meta_query' => $meta_query, 'filter' => $filter, 'show_hidden' => $show_hidden, 'exclude' => $exclude, 'in' => $in, 'spam' => $spam ) );
+            $this->activities = bp_activity_get( array( 'display_comments' => $display_comments, 'max' => $max, 'per_page' => $this->pag_num, 'page' => $this->pag_page, 'sort' => $sort, 'search_terms' => $search_terms, 'meta_query' => $meta_query, 'filter' => $filter, 'show_hidden' => $show_hidden, 'exclude' => $exclude, 'in' => $in, 'spam' => $spam, 'update_meta_cache' => $update_meta_cache, ) );
 
         if ( !$max || $max >= (int) $this->activities['total'] )
@@ -449 +450 @@
  *     @type string|bool $spam Spam status. 'ham_only', 'spam_only', or false
  *           to show all activity regardless of spam status. Default: 'ham_only'.
+ *     @type bool $populate_extras Whether to pre-fetch the activity metadata
+ *           for the queried items. Default: true.
  * }
  * @return bool Returns true when activities are found, otherwise false.
@@ -520 +523 @@
 
         // Searching
-        'search_terms'     => false         // specify terms to search on
+        'search_terms'     => false,        // specify terms to search on
+        'update_meta_cache' => true,
     );
 
@@ -627 +631 @@
         'display_comments' => $display_comments,
         'show_hidden'      => $show_hidden,
-        'spam'             => $spam
+        'spam'             => $spam,
+        'update_meta_cache' => $update_meta_cache,
     );
 

trunk/tests/testcases/activity/template.php

@@ -254 +254 @@
 
     }
+
+    /**
+     * @group bp_has_activities
+     * @group cache
+     */
+    public function test_bp_has_activities_with_update_meta_cache_false() {
+        $now = time();
+        $a1 = $this->factory->activity->create( array(
+            'content' => 'Life Rules',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now ),
+        ) );
+        $a2 = $this->factory->activity->create( array(
+            'content' => 'Life Drools',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+
+        bp_activity_add_meta( $a1, 'foo', 'bar' );
+        bp_activity_add_meta( $a2, 'foo1', 'bar2' );
+
+        // prime
+        bp_has_activities( array(
+            'update_meta_cache' => false,
+        ) );
+
+        $this->assertFalse( wp_cache_get( $a1, 'activity_meta' ) );
+        $this->assertFalse( wp_cache_get( $a2, 'activity_meta' ) );
+    }
+
+    /**
+     * @group bp_has_activities
+     * @group cache
+     */
+    public function test_bp_has_activities_with_update_meta_cache_true() {
+        $now = time();
+        $a1 = $this->factory->activity->create( array(
+            'content' => 'Life Rules',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now ),
+        ) );
+        $a2 = $this->factory->activity->create( array(
+            'content' => 'Life Drools',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+
+        bp_activity_add_meta( $a1, 'foo', 'bar' );
+        bp_activity_add_meta( $a2, 'foo1', 'bar2' );
+
+        // prime
+        bp_has_activities( array(
+            'update_meta_cache' => true,
+        ) );
+
+        $this->assertNotEmpty( wp_cache_get( $a1, 'activity_meta' ) );
+        $this->assertNotEmpty( wp_cache_get( $a2, 'activity_meta' ) );
+    }
 }