Changeset 10217 for trunk/src/bp-activity/classes/class-bp-activity-activity.php

Timestamp:

10/08/2015 04:59:40 PM (11 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.

File:

• trunk/src/bp-activity/classes/class-bp-activity-activity.php (modified) (4 diffs)

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;