Changeset 10217

Timestamp:

10/08/2015 04:59:40 PM (9 years ago)

Author:

boonebgorges

Message:

Introduce fields parameter to bp_has_activities() stack.

fields=ids will fetch only the IDs of matched activities. fields=all
(or any other value of fields, for the moment) will return full activity
objects.

The structure of the array returned from BP_Activity_Activity::get() is the
same regardless of the value of fields: matched items are stored in the
'activities' member of the returned array.

Props r-a-y.
Fixes #6426.

Location:

trunk

Files:

• src/bp-activity/bp-activity-functions.php (modified) (4 diffs)
• src/bp-activity/bp-activity-template.php (modified) (4 diffs)
• src/bp-activity/classes/class-bp-activity-activity.php (modified) (4 diffs)
• tests/phpunit/testcases/activity/class.BP_Activity_Activity.php (modified) (1 diff)

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

@@ -1435 +1435 @@
  *
  * @since 1.2.0
+ * @since 2.4.0 Introduced the `$fields` parameter.
  *
  * @see BP_Activity_Activity::get() For more information on accepted arguments
@@ -1452 +1453 @@
     $r = bp_parse_args( $args, array(
         'max'               => false,        // Maximum number of results to return
+        'fields'            => 'all',
         'page'              => 1,            // page 1 without a per_page will result in no pagination.
         'per_page'          => false,        // results per page
@@ -1483 +1485 @@
 
     // Attempt to return a cached copy of the first page of sitewide activity.
-    if ( ( 1 === (int) $r['page'] ) && empty( $r['max'] ) && empty( $r['search_terms'] ) && empty( $r['meta_query'] ) && empty( $r['date_query'] ) && empty( $r['filter_query'] ) && empty( $r['filter'] ) && empty( $r['scope'] )&& empty( $r['exclude'] ) && empty( $r['in'] ) && ( 'DESC' === $r['sort'] ) && empty( $r['exclude'] ) && ( 'ham_only' === $r['spam'] ) ) {
+    if ( ( 1 === (int) $r['page'] ) && empty( $r['max'] ) && ( 'all' === $r['fields'] ) && empty( $r['search_terms'] ) && empty( $r['meta_query'] ) && empty( $r['date_query'] ) && empty( $r['filter_query'] ) && empty( $r['filter'] ) && empty( $r['scope'] )&& empty( $r['exclude'] ) && empty( $r['in'] ) && ( 'DESC' === $r['sort'] ) && empty( $r['exclude'] ) && ( 'ham_only' === $r['spam'] ) ) {
 
         $activity = wp_cache_get( 'bp_activity_sitewide_front', 'bp' );
@@ -1492 +1494 @@
                 'per_page'          => $r['per_page'],
                 'max'               => $r['max'],
+                'fields'            => $r['fields'],
                 'sort'              => $r['sort'],
                 'search_terms'      => $r['search_terms'],

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

@@ -271 +271 @@
             'page_arg'          => 'acpage',
             'max'               => false,
+            'fields'            => 'all',
             'count_total'       => false,
             'sort'              => false,
@@ -508 +509 @@
  *
  * @since 1.0.0
+ * @since 2.4.0 Introduced the `$fields` parameter.
  *
  * @global object $activities_template {@link BP_Activity_Template}
@@ -537 +539 @@
  *     @type string            $page_arg         String used as a query parameter in pagination links. Default: 'acpage'.
  *     @type int|bool          $max              Maximum number of results to return. Default: false (unlimited).
+ *     @type string            $fields           Activity fields to retrieve. 'all' to fetch entire activity objects,
+ *                                               'ids' to get only the activity IDs. Default 'all'.
  *     @type string|bool       $count_total      If true, an additional DB query is run to count the total activity items
  *                                               for the query. Default: false.
@@ -662 +666 @@
         'page_arg'          => 'acpage',     // See https://buddypress.trac.wordpress.org/ticket/3679
         'max'               => false,        // max number to return
+        'fields'            => 'all',
         'count_total'       => false,
         'show_hidden'       => $show_hidden, // Show activity items that are hidden site-wide?

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

@@ -261 +261 @@
      * Get activity items, as specified by parameters.
      *
+     * @since 1.0.0
+     * @since 2.4.0 Introduced the `$fields` parameter.
+     *
      * @see BP_Activity_Activity::get_filter_sql() for a description of the
      *      'filter' parameter.
@@ -273 +276 @@
      *     @type int|bool     $per_page          Number of results per page. Default: 25.
      *     @type int|bool     $max               Maximum number of results to return. Default: false (unlimited).
+     *     @type string       $fields            Activity fields to return. Pass 'ids' to get only the activity IDs.
+     *                                           'all' returns full activity objects.
      *     @type string       $sort              ASC or DESC. Default: 'DESC'.
      *     @type array        $exclude           Array of activity IDs to exclude. Default: false.
@@ -324 +329 @@
             'per_page'          => 25,         // Activity items per page
             'max'               => false,      // Max number of items to return
+            'fields'            => 'all',
             'sort'              => 'DESC',     // ASC or DESC
             'exclude'           => false,      // Array of ids to exclude
@@ -571 +577 @@
             }
 
-            $activities = self::get_activity_data( $activity_ids );
-        }
-
-        // Get the fullnames of users so we don't have to query in the loop
-        $activities = self::append_user_fullnames( $activities );
-
-        // Get activity meta
-        $activity_ids = array();
-        foreach ( (array) $activities as $activity ) {
-            $activity_ids[] = $activity->id;
-        }
-
-        if ( ! empty( $activity_ids ) && $r['update_meta_cache'] ) {
-            bp_activity_update_meta_cache( $activity_ids );
-        }
-
-        if ( $activities && $r['display_comments'] ) {
-            $activities = BP_Activity_Activity::append_comments( $activities, $r['spam'] );
-        }
-
-        // Pre-fetch data associated with activity users and other objects
-        BP_Activity_Activity::prefetch_object_data( $activities );
-
-        // Generate action strings
-        $activities = BP_Activity_Activity::generate_action_strings( $activities );
+            if ( 'ids' === $r['fields'] ) {
+                $activities = array_map( 'intval', $activity_ids );
+            } else {
+                $activities = self::get_activity_data( $activity_ids );
+            }
+        }
+
+        if ( 'ids' !== $r['fields'] ) {
+            // Get the fullnames of users so we don't have to query in the loop
+            $activities = self::append_user_fullnames( $activities );
+
+            // Get activity meta
+            $activity_ids = array();
+            foreach ( (array) $activities as $activity ) {
+                $activity_ids[] = $activity->id;
+            }
+
+            if ( ! empty( $activity_ids ) && $r['update_meta_cache'] ) {
+                bp_activity_update_meta_cache( $activity_ids );
+            }
+
+            if ( $activities && $r['display_comments'] ) {
+                $activities = BP_Activity_Activity::append_comments( $activities, $r['spam'] );
+            }
+
+            // Pre-fetch data associated with activity users and other objects
+            BP_Activity_Activity::prefetch_object_data( $activities );
+
+            // Generate action strings
+            $activities = BP_Activity_Activity::generate_action_strings( $activities );
+        }
 
         $retval['activities'] = $activities;

trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php

@@ -53 +53 @@
         $meta = bp_activity_get_meta( $activity, 'Paul' );
         $this->assertSame( '', $meta );
+    }
+
+    /**
+     * @group get
+     * @group fields
+     * @ticket BP6426
+     */
+    public function test_get_with_fields_parameter_by_id() {
+        $a = $this->factory->activity->create_many( 3, array(
+            'type' => 'activity_update',
+        ) );
+
+        $result = BP_Activity_Activity::get( array(
+            'fields' => 'ids',
+        ) );
+        $this->assertEqualSets( $a, $result['activities'] );
     }