Changeset 7951

Timestamp:

02/21/2014 02:49:28 PM (12 years ago)

Author:

boonebgorges

Message:

Add 'offset' parameter to bp_has_activities() function stack

This param allows plugins and themes to filter results to only those activity
items whose IDs are greater than the 'offset' parameter. See eg the "load
new items" integration with the Heartbeat API.

See #5328

Props imath, boonebgorges

Location:

trunk

Files:

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

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

@@ -1146 +1146 @@
         }
 
+        if ( ! empty( $filter_array['offset'] ) ) {
+            $sid_sql = absint( $filter_array['offset'] );
+            $filter_sql[] = "a.id >= {$sid_sql}";
+        }
+
         if ( empty( $filter_sql ) )
             return false;

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

@@ -455 +455 @@
  *           between components/types. Accepts a single ID, or an array of
  *           multiple IDs. Defaults to false.
+ *     @type int $offset Return only activity items with an ID greater than or
+ *           equal to this one. Note that providing an offset will disable
+ *           pagination. Default: false.
  *     @type string|bool $display_comments How to handle activity comments.
  *           Possible values:
@@ -544 +547 @@
         'primary_id'        => $primary_id,  // object ID to filter on e.g. a group_id or forum_id or blog_id etc.
         'secondary_id'      => false,        // secondary object ID to filter on e.g. a post_id
+        'offset'            => false,        // return only items >= this ID
 
         'meta_query'        => false,        // filter on activity meta. See WP_Meta_Query for format
@@ -560 +564 @@
     if ( in_array( $display_comments, array( 0, '0', 'none', 'false' ), true ) ) {
         $display_comments = false;
+    }
+
+    // Ignore pagination if an offset is passed
+    if ( ! empty( $offset ) ) {
+        $page = 0;
     }
 
@@ -633 +642 @@
     if ( isset( $_GET['afilter'] ) && apply_filters( 'bp_activity_enable_afilter_support', false ) )
         $filter = array( 'object' => $_GET['afilter'] );
-    else if ( !empty( $user_id ) || !empty( $object ) || !empty( $action ) || !empty( $primary_id ) || !empty( $secondary_id ) )
-        $filter = array( 'user_id' => $user_id, 'object' => $object, 'action' => $action, 'primary_id' => $primary_id, 'secondary_id' => $secondary_id );
+    else if ( ! empty( $user_id ) || ! empty( $object ) || ! empty( $action ) || ! empty( $primary_id ) || ! empty( $secondary_id ) || ! empty( $offset ) )
+        $filter = array( 'user_id' => $user_id, 'object' => $object, 'action' => $action, 'primary_id' => $primary_id, 'secondary_id' => $secondary_id, 'offset' => $offset );
     else
         $filter = false;

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

@@ -258 +258 @@
 
     /**
+     * @group get
+     */
+    public function test_get_with_offset() {
+        $now = time();
+        $a1 = $this->factory->activity->create( array(
+            'content' => 'Life Rules',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+        $a2 = $this->factory->activity->create( array(
+            'content' => 'Life Drools',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now - 50 ),
+        ) );
+        $a3 = $this->factory->activity->create( array(
+            'content' => 'Life Drools',
+            'recorded_time' => date( 'Y-m-d H:i:s', $now - 10 ),
+        ) );
+
+        $activity = BP_Activity_Activity::get( array(
+            'filter' => array(
+                'offset' => $a2,
+            ),
+        ) );
+        $ids = wp_list_pluck( $activity['activities'], 'id' );
+        $this->assertEquals( array( $a3, $a2 ), $ids );
+    }
+    /**
      * @group get_id
      */